Firebase クラウド メッセージング (FCM)。
機能
関数 | 説明 |
---|---|
getMessaging(アプリ) | デフォルトのアプリまたは指定されたアプリのメッセージングサービスを取得します。 admin.messaging() 引数なしで呼び出してデフォルトのアプリのMessaging サービスにアクセスすることも、 admin.messaging(app) として呼び出して特定のアプリに関連付けられたMessaging サービスにアクセスすることもできます。 |
クラス
クラス | 説明 |
---|---|
メッセージング | 提供されたアプリにバインドされたメッセージング サービス。 |
インターフェース
インターフェース | 説明 |
---|---|
AndroidConfig | メッセージに含めることができる Android 固有のオプションを表します。 |
AndroidFcmオプション | FCM SDK for Android によって提供される機能のオプションを表します。 |
Android通知 | AndroidConfigに含めることができる Android 固有の通知オプションを表します。 。 |
ApnsConfig | メッセージに含めることができる APN 固有のオプションを表します。 APN でサポートされるさまざまなヘッダーおよびペイロード フィールドについては、Apple のドキュメントを参照してください。 |
ApnsFcmオプション | iOS 用 FCM SDK によって提供される機能のオプションを表します。 |
Apnsペイロード | APNs メッセージのペイロードを表します。主にaps 辞書で構成されています。ただし、他の任意のカスタム キーが含まれる場合もあります。 |
アプリ | APN メッセージの一部であるaps ディクショナリを表します。 |
アプスアラート | |
ベースメッセージ | |
バッチレスポンス | Messaging.sendAll()メソッドおよびMessaging.sendMulticast()メソッドからのサーバー応答を表すインターフェイス。 |
条件メッセージ | |
クリティカルサウンド | APNs ペイロードのaps ディクショナリに含めることができる重要なサウンド設定を表します。 |
データメッセージペイロード | FCM レガシー API データ メッセージ ペイロードを表すインターフェイス。データ メッセージを使用すると、開発者は最大 4KB のカスタム キーと値のペアを送信できます。キーと値は両方とも文字列である必要があります。キーには、次の予約文字列を除く任意のカスタム文字列を使用できます。
|
Fcmオプション | FCM SDK によって提供される機能のプラットフォームに依存しないオプションを表します。 |
ライト設定 | AndroidNotificationに含めることができる通知 LED を制御する設定を表します。 。 |
メッセージング条件応答 | 従来のMessaging.sendToCondition()メソッドからのサーバー応答を表すインターフェイス。コードサンプルと詳細なドキュメントについては、「条件に送信」を参照してください。 |
メッセージングデバイスグループ応答 | Messaging.sendToDeviceGroup()メソッドからのサーバー応答を表すインターフェイス。コード サンプルと詳細なドキュメントについては、「デバイス グループにメッセージを送信する」を参照してください。 |
メッセージングデバイス結果 | 単一デバイスからの個別のステータス応答ペイロード |
メッセージングデバイス応答 | FCM レガシー API を介して個々のデバイスに送信されるメッセージのステータスを表すインターフェイス。コードサンプルと詳細なドキュメントについては、 「個別のデバイスに送信」を参照してください。 |
メッセージングオプション | FCM レガシー API 経由でメッセージを送信するときに提供できるオプションを表すインターフェイス。コードサンプルと詳細なドキュメントについては、「送信リクエストの構築」を参照してください。 |
メッセージングペイロード | Firebase Cloud Messaging メッセージ ペイロードを表すインターフェイス。 data キーとnotification キーの一方または両方が必要です。コードサンプルと詳細なドキュメントについては、「送信リクエストの構築」を参照してください。 |
メッセージングトピック管理応答 | Messaging.subscribeToTopic()メソッドとMessaging.unsubscribeFromTopic()メソッドからのサーバー応答を表すインターフェイス。コードサンプルと詳細なドキュメントについては、「サーバーからのトピックの管理」を参照してください。 |
メッセージングトピック応答 | 従来のMessaging.sendToTopic()メソッドからのサーバー応答を表すインターフェイス。コードサンプルと詳細なドキュメントについては、「トピックに送信」を参照してください。 |
マルチキャストメッセージ | Messaging.sendMulticast()メソッドのペイロード。ペイロードには、BaseMessage タイプのすべてのフィールドとトークンのリストが含まれています。 |
通知 | メッセージに含めることができる通知。 |
通知メッセージペイロード | FCM レガシー API 通知メッセージ ペイロードを表すインターフェイス。開発者は通知メッセージを使用して、最大 4KB の事前定義されたキーと値のペアを送信できます。受け入れられるキーの概要を以下に示します。コードサンプルと詳細なドキュメントについては、「送信リクエストの構築」を参照してください。 |
SendResponse | バッチリクエストの一部として送信された個々のメッセージのステータスを表すインターフェイス。 |
トークンメッセージ | |
トピックメッセージ | |
WebpushConfig | メッセージに含めることができる WebPush プロトコル オプションを表します。 。 |
WebpushFcmオプション | FCM SDK for Web (Webpush 標準の一部ではありません) によって提供される機能のオプションを表します。 |
ウェブプッシュ通知 | WebpushConfigに含めることができる WebPush 固有の通知オプションを表します。 。これは、Web 通知仕様で定義されている標準オプションのほとんどをサポートします。 。 |
タイプエイリアス
タイプエイリアス | 説明 |
---|---|
メッセージ | Messaging.send()オペレーションのペイロード。ペイロードには、BaseMessage タイプのすべてのフィールドと、トークン、トピック、条件のいずれか 1 つだけが含まれます。 |
getMessaging()
デフォルトのアプリまたは指定されたアプリのメッセージングサービスを取得します。
admin.messaging()
引数なしで呼び出してデフォルトのアプリのMessaging
サービスにアクセスすることも、 admin.messaging(app)
として呼び出して特定のアプリに関連付けられたMessaging
サービスにアクセスすることもできます。
サイン:
export declare function getMessaging(app?: App): Messaging;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
アプリ | アプリ | Messaging サービスを返すオプションのアプリ。指定しない場合は、デフォルトのMessaging サービスが返されます。 |
戻り値:
アプリが提供されていない場合のデフォルトのMessaging
サービス、または提供されたアプリに関連付けられたMessaging
サービス。
例1
// Get the Messaging service for the default app
const defaultMessaging = getMessaging();
例 2
// Get the Messaging service for a given app
const otherMessaging = getMessaging(otherApp);
メッセージ
Messaging.send()オペレーションのペイロード。ペイロードには、BaseMessage タイプのすべてのフィールドと、トークン、トピック、条件のいずれか 1 つだけが含まれます。
サイン:
export type Message = TokenMessage | TopicMessage | ConditionMessage;