ドキュメントを開く +

更新と取り消し

状況の通知は、10 件積み重なるより 1 件が書き換わるほうが読みやすくなります。関連する通知に id を付けると、置き換え、取り消し、期限切れにできます。

group は通知センターと履歴で通知を 1 つの見出しにまとめます。ジョブやトピックごとに 1 つの値を使ってください。例:backups、deploy-api。iPhone では、通知のアクションからうるさいグループを 10 分または 1 時間ミュートできます。

通知を置き換える#

同じ id で新しい通知を送ります。前の通知は通知センターから消え、履歴には最新の内容だけが残ります。

cURL / Bash
curl https://push.breezelabs.dev/v1/send \
  -H 'Authorization: Bearer YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"id":"deploy-42","title":"Deploy","body":"Step 3 of 5: running migrations"}'

id は最大 128 文字です。ジョブ番号など、変わらない値を使ってください。

通知を取り消す#

同じ id で delete=1 を送ります。Breeze はその通知を通知センターと履歴から削除します。

cURL / Bash
curl https://push.breezelabs.dev/v1/send \
  -H 'Authorization: Bearer YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"id":"deploy-42","delete":1}'

取り消しはバックグラウンド更新として届きます。低電力モードのときやアプリを強制終了したときは、システムが処理を遅らせることがあるため、機密性の高い用途には頼らないでください。

期限切れにする#

ttl は通知を履歴に残す秒数です。時間が過ぎると自動で消えます。ttl=0 は通知を表示するだけで保存しません。

text
https://push.breezelabs.dev/YOUR_KEY/One-time%20code%20482193?ttl=300

Android では、ttl は Google が配信を試みる期間も制限します。最長 4 週間で、既定も 4 週間です。

履歴に残さない#

iOS では isArchive=0 を送ると、その通知は履歴に保存されません。すべての通知の既定を変えるには、アプリの設定で履歴の保存期間を選ぶか、保存をオフにします。

未配信の更新をまとめる#

端末がオフラインの間、同じ collapse_id の未配信の通知は最新の 1 件だけが残ります。オンラインに戻ったときに古い更新がまとめて届くのを防げます。配信が 1 回だけであることは保証しません。