Firebase Cloud Messaging（FCM）。
関数
| 関数 | 説明 |
|---|---|
| getMessaging(app) | デフォルト アプリまたは特定のアプリの Messaging サービスを取得します。引数なしで admin.messaging() を呼び出してデフォルト アプリの Messaging サービスにアクセスするか、admin.messaging(app) として呼び出し、特定のアプリに関連付けられた Messaging サービスにアクセスできます。 |
クラス
| クラス | 説明 |
|---|---|
| メッセージ | 提供されたアプリにバインドされているメッセージ サービス。 |
インターフェース
| インターフェース | 説明 |
|---|---|
| AndroidConfig | メッセージ に含めることができる Android 固有のオプションを表します。 |
| AndroidFcmOptions | Android 用 FCM SDK に用意されている機能のオプションを表します。 |
| Android の通知 | AndroidConfig に含めることができる Android 固有の通知オプションを表します。 |
| ApnsConfig | メッセージ に含めることができる APNs 固有のオプションを表します。APNs でサポートされているさまざまなヘッダーとペイロード フィールドについては、Apple のドキュメントをご覧ください。 |
| ApnsFcmOptions | iOS 用 FCM SDK に用意されている機能のオプションを表します。 |
| ApnsPayload | APNs メッセージのペイロードを表します。主に aps 辞書で構成されます。その他の任意のカスタムキーを含めることもできます。 |
| AP | APNs メッセージの一部である aps 辞書を表します。 |
| APSAlert | |
| BaseMessage | |
| BatchResponse | Messaging.sendAll() メソッドと Messaging.sendMulticast() メソッドからのサーバー レスポンスを表すインターフェース。 |
| ConditionMessage | |
| CriticalSound | APNs ペイロードの aps ディクショナリに含めることができる重要なサウンド設定を表します。 |
| DataMessagePayload | FCM レガシー API データ メッセージ ペイロードを表すインターフェース。データ メッセージを使用すると、デベロッパーは最大 4 KB のカスタム Key-Value ペアを送信できます。キーと値はどちらも文字列にする必要があります。キーには、任意のカスタム文字列を指定できます。ただし、次の予約済み文字列は使用できません。
|
| FcmOptions | FCM SDK が提供する機能のプラットフォームに依存しないオプションを表します。 |
| ライトの設定 | AndroidNotification に含めることができる通知 LED を制御するための設定を表します。 |
| MessagingConditionResponse | 以前の Messaging.sendToCondition() メソッドからのサーバー レスポンスを表すインターフェース。コードサンプルと詳細なドキュメントについては、条件に送信するをご覧ください。 |
| MessagingDeviceGroupResponse | Messaging.sendToDeviceGroup() メソッドからのサーバー レスポンスを表すインターフェース。コードサンプルと詳細なドキュメントについては、デバイス グループにメッセージを送信するをご覧ください。 |
| MessagingDeviceResult | 単一デバイスからの個別のステータス レスポンスのペイロード |
| MessagingDevicesResponse | 以前の FCM API を介して個々のデバイスに送信されたメッセージのステータスを表すインターフェースです。コードサンプルと詳細なドキュメントについては、個々のデバイスに送信するをご覧ください。 |
| MessagingOptions | 以前の FCM API を介してメッセージを送信するときに提供できるオプションを表すインターフェースです。コードサンプルと詳細なドキュメントについては、送信リクエストを作成するをご覧ください。 |
| MessagingPayload | Firebase Cloud Messaging のメッセージ ペイロードを表すインターフェース。data キーと notification キーのいずれかまたは両方が必要です。コードサンプルと詳細なドキュメントについては、送信リクエストを作成するをご覧ください。 |
| MessagingTopicManagementResponse | Messaging.subscribeToTopic() メソッドと Messaging.unsubscribeFromTopic() メソッドからのサーバー レスポンスを表すインターフェースです。コードサンプルと詳細なドキュメントについては、サーバーからトピックを管理するをご覧ください。 |
| MessagingTopicResponse | 以前の Messaging.sendToTopic() メソッドからのサーバー レスポンスを表すインターフェースです。コードサンプルと詳細なドキュメントについては、トピックに送信するをご覧ください。 |
| マルチキャスト メッセージ | Messaging.sendMulticast() メソッドのペイロード。ペイロードには、BaseMessage 型のすべてのフィールドとトークンのリストが含まれます。 |
| 通知 | [メッセージ] に含めることができる通知。 |
| NotificationMessagePayload | FCM レガシー API 通知メッセージ ペイロードを表すインターフェース。通知メッセージを使用すると、最大 4 KB の事前定義された Key-Value ペアを送信できます。使用できるキーは次のとおりです。コードサンプルと詳細なドキュメントについては、送信リクエストを構築するをご覧ください。 |
| SendResponse | バッチ リクエストの一部として送信された個々のメッセージのステータスを表すインターフェース。 |
| TokenMessage | |
| TopicMessage | |
| WebpushConfig | Message に含めることができる WebPush プロトコル オプションを表します。 |
| WebpushFcmOptions | ウェブ用 FCM SDK に用意されている機能（Webpush 標準の一部ではない）のオプションを表します。 |
| WebpushNotification | WebpushConfig に含めることができる WebPush 固有の通知オプションを表します。ウェブ通知の仕様で定義されている標準オプションのほとんどをサポートしています。 |
型エイリアス
| タイプ エイリアス | 説明 |
|---|---|
| メッセージ | Messaging.send() オペレーションのペイロード。ペイロードには、BaseMessage 型のすべてのフィールドと、トークン、トピック、条件のいずれか 1 つのみが含まれます。 |
getMessaging(アプリ)
デフォルト アプリまたは指定されたアプリの Messaging サービスを取得します。
admin.messaging() を引数なしで呼び出してデフォルト アプリの Messaging サービスにアクセスするか、admin.messaging(app) として呼び出して特定のアプリに関連付けられている Messaging サービスにアクセスします。
署名:
export declare function getMessaging(app?: App): Messaging;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| app | アプリ | 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;