FCM レガシー API 経由でメッセージを送信するときに提供できるオプションを表すインターフェイス。
コードサンプルと詳細なドキュメントについては、「送信リクエストの構築」を参照してください。
サイン:
export interface MessagingOptions
プロパティ
財産 | タイプ | 説明 |
---|---|---|
崩壊キー | 弦 | 配信を再開できるときに最後のメッセージのみが送信されるように、折りたたむことができるメッセージのグループ (「利用可能な更新」など) を識別する文字列。これは、デバイスがオンラインに戻ったとき、またはアクティブになったときに、同じメッセージが大量に送信されることを避けるために使用されます。メッセージが送信される順序は保証されません。いつでも、最大 4 つの異なる折りたたみキーを使用できます。これは、FCM サーバーがクライアント アプリごとに 4 つの異なる同期送信メッセージを同時に保存できることを意味します。この数を超えると、FCM サーバーがどの 4 つの折りたたみキーを保持するかという保証はありません。 **デフォルト値:** なし |
コンテンツ利用可能 | ブール値 | iOS では、このフィールドを使用して、APN ペイロードでcontent-available を表します。通知またはデータ メッセージが送信され、これがtrue に設定されている場合、非アクティブなクライアント アプリが起動されます。 Android では、デフォルトでデータ メッセージによってアプリが起動されます。 Chrome では、このフラグは現在サポートされていません。 **デフォルト値:** false |
ドライラン | ブール値 | メッセージを実際に送信する必要があるかどうか。 true に設定すると、開発者は実際にメッセージを送信せずにリクエストをテストできます。 false に設定すると、メッセージが送信されます。 **デフォルト値:** false |
可変コンテンツ | ブール値 | iOS では、このフィールドを使用して、APN ペイロード内のmutable-content を表します。通知が送信され、これがtrue に設定されている場合、 Notification Service アプリ拡張機能を使用して、通知の内容を表示前に変更できます。 。 Android および Web では、このパラメータは無視されます。 **デフォルト値:** false |
優先度 | 弦 | メッセージの優先度。有効な値は"normal" と"high". iOS では、これらは APN の優先順位5 および10 に対応します。デフォルトでは、通知メッセージは高い優先度で送信され、データ メッセージは通常の優先度で送信されます。通常の優先度はクライアント アプリのバッテリー消費を最適化するため、即時配信が必要でない場合は使用する必要があります。通常の優先度を持つメッセージの場合、アプリは不特定の遅延でメッセージを受信する場合があります。メッセージが高い優先度で送信されると、メッセージはすぐに送信され、アプリはスリープ状態のデバイスを起動して、サーバーへのネットワーク接続を開くことができます。詳細については、 「メッセージの優先度の設定」を参照してください。 。 **デフォルト値:** 通知メッセージの場合は"high" 、データ メッセージの場合は"normal" |
制限付きパッケージ名 | 弦 | メッセージを受信するために登録トークンが一致する必要があるアプリケーションのパッケージ名。 **デフォルト値:** なし |
有効期間 | 番号 | デバイスがオフラインの場合にメッセージを FCM ストレージに保持する期間 (秒単位)。サポートされている最大生存期間は 4 週間で、デフォルト値も 4 週間です。詳細については、 「メッセージの有効期間の設定」を参照してください。 。 **デフォルト値:** 2419200 (4 週間を秒単位で表す) |
MessagingOptions.collapseKey
配信を再開できるときに最後のメッセージのみが送信されるように、折りたたむことができるメッセージのグループ (「利用可能な更新」など) を識別する文字列。これは、デバイスがオンラインに戻ったとき、またはアクティブになったときに、同じメッセージが大量に送信されることを避けるために使用されます。
メッセージが送信される順序は保証されません。
いつでも、最大 4 つの異なる折りたたみキーを使用できます。これは、FCM サーバーがクライアント アプリごとに 4 つの異なる同期送信メッセージを同時に保存できることを意味します。この数を超えると、FCM サーバーがどの 4 つの折りたたみキーを保持するかという保証はありません。
**デフォルト値:** なし
サイン:
collapseKey?: string;
MessagingOptions.contentAvailable
iOS では、このフィールドを使用して、APN ペイロードでcontent-available
を表します。通知またはデータ メッセージが送信され、これがtrue
に設定されている場合、非アクティブなクライアント アプリが起動されます。 Android では、デフォルトでデータ メッセージによってアプリが起動されます。 Chrome では、このフラグは現在サポートされていません。
**デフォルト値:** false
サイン:
contentAvailable?: boolean;
MessagingOptions.dryRun
メッセージを実際に送信する必要があるかどうか。 true
に設定した場合を使用すると、開発者は実際にメッセージを送信せずにリクエストをテストできます。 false
に設定した場合、メッセージが送信されます。
**デフォルト値:** false
サイン:
dryRun?: boolean;
MessagingOptions.mutableContent
iOS では、このフィールドを使用して、APN ペイロード内のmutable-content
を表します。通知が送信され、これがtrue
に設定されている場合、通知サービスのアプリ拡張機能を使用して、通知の内容を表示前に変更できます。 。
Android および Web では、このパラメータは無視されます。
**デフォルト値:** false
サイン:
mutableContent?: boolean;
MessagingOptions.priority
メッセージの優先度。有効な値は"normal"
と"high".
iOS では、これらは APN 優先度5
および10
に対応します。 。
デフォルトでは、通知メッセージは高い優先度で送信され、データ メッセージは通常の優先度で送信されます。通常の優先度はクライアント アプリのバッテリー消費を最適化するため、即時配信が必要でない場合は使用する必要があります。通常の優先度を持つメッセージの場合、アプリは不特定の遅延でメッセージを受信する場合があります。
メッセージが高い優先度で送信されると、メッセージはすぐに送信され、アプリはスリープ状態のデバイスを起動して、サーバーへのネットワーク接続を開くことができます。
詳細については、 「メッセージの優先度の設定」を参照してください。 。
**デフォルト値:** 通知メッセージの場合は"high"
、データ メッセージの場合は"normal"
サイン:
priority?: string;
MessagingOptions.restrictedPackageName
メッセージを受信するために登録トークンが一致する必要があるアプリケーションのパッケージ名。
**デフォルト値:** なし
サイン:
restrictedPackageName?: string;
MessagingOptions.timeToLive
デバイスがオフラインの場合にメッセージを FCM ストレージに保持する期間 (秒単位)。サポートされている最大生存期間は 4 週間で、デフォルト値も 4 週間です。詳細については、 「メッセージの有効期間の設定」を参照してください。 。
**デフォルト値:** 2419200
(4 週間を秒単位で表します)
サイン:
timeToLive?: number;