以前の FCM API を介してメッセージを送信する際に提供できるオプションを表すインターフェース。
コードサンプルと詳細なドキュメントについては、送信リクエストを作成するをご覧ください。
署名:
export interface MessagingOptions
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| 折りたたみキー | 文字列 | 配信を再開できるときに最後のメッセージのみが送信されるように、折りたたみ可能なメッセージのグループを識別する文字列（「アップデート利用可能」など）。これは、デバイスがオンラインに戻ったときやアクティブになったときに、同じメッセージが何度も送信されないようにするためです。メッセージの送信順序は保証されません。折りたたみキーは一度に 4 つまで使用できます。つまり、FCM サーバーはクライアント アプリごとに 4 つの異なる送信後同期メッセージを同時に保存できます。この数を超えた場合、FCM サーバーがどの 4 つの折りたたみキーを保持するかは保証されません。**デフォルト値:** なし |
| contentAvailable | ブール値 | iOS では、このフィールドを使用して APNs ペイロードで content-available を表します。通知またはデータ メッセージが送信され、これが true に設定されている場合、非アクティブなクライアント アプリがスリープ状態から復帰します。Android では、デフォルトでデータ メッセージによってアプリが復帰します。Chrome では、このフラグは現在サポートされていません。**デフォルト値:** false |
| dryRun | ブール値 | メッセージを実際に送信するかどうか。true に設定すると、デベロッパーは実際にメッセージを送信せずにリクエストをテストできます。false に設定した場合、メッセージが送信されます。**デフォルト値:** false |
| mutableContent | ブール値 | iOS では、このフィールドを使用して APNs ペイロードで mutable-content を表します。通知が送信され、これが true に設定されている場合は、通知サービスのアプリ拡張機能を使用して、通知の内容を表示前に変更できます。Android とウェブでは、このパラメータは無視されます。**デフォルト値:** false |
| 優先度 | 文字列 | メッセージの優先度。有効な値は "normal" と "high". です。iOS では、これらは APNs の優先度 5 と 10 に対応します。デフォルトでは、通知メッセージは高い優先度で送信され、データ メッセージは通常の優先度で送信されます。「normal」の優先度は、クライアント アプリのバッテリー消費を最適化するため、すぐに配信する必要がある場合を除き、この値を使用してください。優先度が標準のメッセージの場合、アプリは未指定の遅延を伴ってメッセージを受信することがあります。優先度の高いメッセージはすぐに送信されます。アプリはスリープ状態のデバイスを起動し、サーバーへのネットワーク接続を開くことができます。詳しくは、メッセージの優先値の設定をご覧ください。**デフォルト値:** 通知メッセージの場合は "high"、データ メッセージの場合は "normal" |
| restrictedPackageName | 文字列 | メッセージを受信するために登録トークンが一致する必要があるアプリケーションのパッケージ名。**デフォルト値:** なし |
| TimeToLive | 数値 | デバイスがオフラインの場合に、メッセージを FCM ストレージに保持する期間（秒単位）。サポートされる最大有効期間は 4 週間で、デフォルト値は 4 週間です。詳細については、メッセージの有効期間の設定をご覧ください。**デフォルト値:** 2419200（4 週間を秒単位で表します） |
MessagingOptions.foldKey。
配信を再開できるときに最後のメッセージのみが送信されるように、折りたたみ可能なメッセージのグループを識別する文字列（「アップデート利用可能」など）。これは、デバイスがオンラインに戻ったとき、またはデバイスがアクティブになったときに、同じメッセージが何度も送信されないようにするためです。
メッセージが送信される順序は保証されません。
任意の時点で最大 4 つの異なる折りたたみキーを使用できます。つまり、FCM サーバーはクライアント アプリごとに 4 つの異なる送信後同期メッセージを同時に保存できます。この数を超えた場合、FCM サーバーがどの 4 つの折りたたみキーを保持するかは保証されません。
**デフォルト値:** なし
署名:
collapseKey?: string;
MessagingOptions.contentAvailable
iOS では、このフィールドを使用して APNs ペイロードで content-available を表します。通知またはデータ メッセージが送信され、これが true に設定されている場合、非アクティブなクライアント アプリがスリープ状態から復帰します。Android では、デフォルトでデータ メッセージによってアプリが復帰します。Chrome では、このフラグは現在サポートされていません。
**デフォルト値:** false
署名:
contentAvailable?: boolean;
MessagingOptions.dryRun
メッセージを実際に送信するかどうか。true に設定すると、デベロッパーは実際にメッセージを送信せずにリクエストをテストできます。false に設定すると、メッセージが送信されます。
**デフォルト値:** false
署名:
dryRun?: boolean;
MessagingOptions.mutableContent
iOS では、このフィールドを使用して APNs ペイロードで mutable-content を表します。送信された通知が true に設定されている場合、通知サービスのアプリ拡張機能を使用して、通知の内容を表示前に変更できます。
Android とウェブでは、このパラメータは無視されます。
**デフォルト値:** false
署名:
mutableContent?: boolean;
MessagingOptions.Priority（メッセージ オプションの優先度）
メッセージの優先度。有効な値は "normal" と "high". です。iOS では、これらは APNs 優先度 5 と 10 に対応します。
デフォルトでは、通知メッセージは高い優先度で送信され、データ メッセージは通常の優先度で送信されます。「normal」の優先度では、クライアント アプリのバッテリー消費量が最適化されます。すぐに配信する必要がない限り、この値を使用してください。優先度が標準のメッセージの場合、アプリは未指定の遅延を伴ってメッセージを受信することがあります。
高い優先度で送信されたメッセージはすぐに送信されます。これにより、アプリがスリープ状態から復帰してサーバーへのネットワーク接続を開くことができます。
詳細については、メッセージの優先度の設定をご覧ください。
**デフォルト値:** 通知メッセージの場合は "high"、データ メッセージの場合は "normal"
署名:
priority?: string;
MessagingOptions.restrictedPackageName
メッセージを受信するために登録トークンが一致する必要があるアプリケーションのパッケージ名。
**デフォルト値:** なし
署名:
restrictedPackageName?: string;
MessagingOptions.timeToLive
デバイスがオフラインの場合に、メッセージを FCM ストレージに保持する期間（秒単位）。サポートされる最大有効期間は 4 週間で、デフォルト値は 4 週間です。詳細については、メッセージの有効期間の設定をご覧ください。
**デフォルト値:** 2419200（4 週間を表す秒単位）
署名:
timeToLive?: number;