Messaging class

提供されたアプリにバインドされたメッセージング サービス。

サイン:

export declare class Messaging 

プロパティ

財産修飾子タイプ説明
アプリアプリ現在のMessagingサービス インスタンスに関連付けられているアプリ

メソッド

方法修飾子説明
send(メッセージ、ドライラン)指定されたメッセージを FCM 経由で送信します。
sendAll(メッセージ、dryRun)指定された配列内のすべてのメッセージを Firebase Cloud Messaging 経由で送信します。バッチ処理を使用して、リスト全体を 1 回の RPC 呼び出しとして送信します。 send()メソッドと比較して、このメソッドは複数のメッセージを送信するための非常に効率的な方法です。戻り値から取得される応答リストは、 MulticastMessage内のトークンの順序に対応します。このメソッドのエラーは完全な失敗を示し、リスト内のどのメッセージも送信できなかったことを意味します。部分的な失敗は、 BatchResponse戻り値によって示されます。
sendEach(メッセージ、dryRun)指定された配列内の各メッセージを Firebase Cloud Messaging 経由で送信します。 Messaging.sendAll()とは異なります。 、このメソッドは、指定された配列内のメッセージごとに 1 つの RPC 呼び出しを行います。戻り値から得られる応答リストは、 messagesの順序に対応しています。このメソッドからのエラー、またはすべての失敗を含むBatchResponse完全な失敗を示し、リスト内のどのメッセージも送信できなかったことを意味します。部分的な失敗または失敗がないことは、 BatchResponse戻り値によってのみ示されます。
sendEachForMulticast(メッセージ、dryRun)指定されたマルチキャスト メッセージを、その中で指定されたすべての FCM 登録トークンに送信します。このメソッドは、内部でMessaging.sendEach() API を使用して、指定されたメッセージを対象のすべての受信者に送信します。戻り値から取得される応答リストは、 MulticastMessage内のトークンの順序に対応します。このメソッドからのエラー、またはすべての失敗を含むBatchResponse完全な失敗を示し、リスト内のメッセージが送信された可能性があることを意味します。部分的な失敗または失敗は、 BatchResponse戻り値によってのみ示されます。
sendMulticast(メッセージ、dryRun)指定されたマルチキャスト メッセージを、その中で指定されたすべての FCM 登録トークンに送信します。このメソッドは、内部でsendAll() API を使用して、指定されたメッセージを対象のすべての受信者に送信します。戻り値から取得される応答リストは、 MulticastMessage内のトークンの順序に対応します。このメソッドからのエラーは完全な失敗を示し、メッセージがリスト内のどのトークンにも送信されなかったことを意味します。部分的な失敗は、 BatchResponse戻り値によって示されます。
sendToCondition(条件、ペイロード、オプション) FCM メッセージを条件に送信します。コードサンプルと詳細なドキュメントについては、「条件に送信」を参照してください。
sendToDevice(登録トークンまたはトークン、ペイロード、オプション)提供された登録トークンに対応する単一のデバイスに FCM メッセージを送信します。コードサンプルと詳細なドキュメントについては、 「個別のデバイスに送信」を参照してください。単一のデバイスに送信するためのregistrationToken 、または複数のデバイスに送信するためのトークンの配列を含むregistrationTokensパラメータのいずれかを受け取ります。
sendToDeviceGroup(notificationKey、ペイロード、オプション)提供された通知キーに対応するデバイス グループに FCM メッセージを送信します。コード サンプルと詳細なドキュメントについては、「デバイス グループに送信する」を参照してください。
sendToTopic(トピック、ペイロード、オプション) FCM メッセージをトピックに送信します。コードサンプルと詳細なドキュメントについては、「トピックに送信」を参照してください。
subscribeToTopic(registrationTokenOrTokens, topic)デバイスを FCM トピックにサブスクライブします。コード サンプルと詳細なドキュメントについては、「トピックの購読」を参照してください。オプションで、複数のデバイスをサブスクライブするためのトークンの配列を提供できます。
unsubscribeFromTopic(registrationTokenOrTokens, topic) FCM トピックからデバイスのサブスクライブを解除します。コードサンプルと詳細なドキュメントについては、「トピックの購読を解除する」を参照してください。必要に応じて、複数のデバイスのサブスクライブを解除するためのトークンの配列を提供できます。

メッセージングアプリ

現在のMessagingサービス インスタンスに関連付けられているアプリ

サイン:

get app(): App;

var app = messaging.app;

Messaging.send()

指定されたメッセージを FCM 経由で送信します。

サイン:

send(message: Message, dryRun?: boolean): Promise<string>;

パラメーター

パラメータタイプ説明
メッセージメッセージメッセージのペイロード。
ドライランブール値メッセージをドライラン (検証のみ) モードで送信するかどうか。

戻り値:

約束<文字列>

メッセージが配信のために FCM サービスに正常に渡された後、一意のメッセージ ID 文字列で履行される Promise です。

Messaging.sendAll()

代わりにMessaging.sendEach()を使用してください。

指定された配列内のすべてのメッセージを Firebase Cloud Messaging 経由で送信します。バッチ処理を使用して、リスト全体を 1 回の RPC 呼び出しとして送信します。 send()メソッドと比較して、このメソッドは複数のメッセージを送信するための非常に効率的な方法です。

戻り値から取得される応答リストは、 MulticastMessage内のトークンの順序に対応します。 。このメソッドのエラーは完全な失敗を示し、リスト内のどのメッセージも送信できなかったことを意味します。部分的な失敗は、 BatchResponse戻り値によって示されます。

サイン:

sendAll(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;

パラメーター

パラメータタイプ説明
メッセージメッセージ[]最大 500 個のメッセージを含む空ではない配列。
ドライランブール値メッセージをドライラン (検証のみ) モードで送信するかどうか。

戻り値:

Promise < BatchResponse >

送信操作の結果を表すオブジェクトで満たされる Promise。

Messaging.sendEach()

指定された配列内の各メッセージを Firebase Cloud Messaging 経由で送信します。

Messaging.sendAll()とは異なります。 、このメソッドは、指定された配列内のメッセージごとに 1 つの RPC 呼び出しを行います。

戻り値から得られる応答リストはmessagesの順序に対応します。このメソッドからのエラー、またはすべての失敗を含むBatchResponse完全な失敗を示し、リスト内のどのメッセージも送信できなかったことを意味します。部分的な失敗または失敗がないことは、 BatchResponse戻り値によってのみ示されます。

サイン:

sendEach(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;

パラメーター

パラメータタイプ説明
メッセージメッセージ[]最大 500 個のメッセージを含む空ではない配列。
ドライランブール値メッセージをドライラン (検証のみ) モードで送信するかどうか。

戻り値:

Promise < BatchResponse >

送信操作の結果を表すオブジェクトで満たされる Promise。

Messaging.sendEachForMulticast()

指定されたマルチキャスト メッセージを、その中で指定されたすべての FCM 登録トークンに送信します。

このメソッドは、内部でMessaging.sendEach() API を使用して、指定されたメッセージを対象のすべての受信者に送信します。戻り値から取得される応答リストは、 MulticastMessage内のトークンの順序に対応します。 。このメソッドからのエラー、またはすべての失敗を含むBatchResponse完全な失敗を示し、リスト内のメッセージが送信された可能性があることを意味します。部分的な失敗または失敗は、 BatchResponse戻り値によってのみ示されます。

サイン:

sendEachForMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;

パラメーター

パラメータタイプ説明
メッセージマルチキャストメッセージ最大 500 個のトークンを含むマルチキャスト メッセージ。
ドライランブール値メッセージをドライラン (検証のみ) モードで送信するかどうか。

戻り値:

Promise < BatchResponse >

送信操作の結果を表すオブジェクトで満たされる Promise。

Messaging.sendMulticast()

代わりにMessaging.sendEachForMulticast()を使用してください。

指定されたマルチキャスト メッセージを、その中で指定されたすべての FCM 登録トークンに送信します。

このメソッドは、内部でsendAll() API を使用して、指定されたメッセージを対象のすべての受信者に送信します。戻り値から取得される応答リストは、 MulticastMessage内のトークンの順序に対応します。 。このメソッドからのエラーは完全な失敗を示し、メッセージがリスト内のどのトークンにも送信されなかったことを意味します。部分的な失敗は、 BatchResponse戻り値によって示されます。

サイン:

sendMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;

パラメーター

パラメータタイプ説明
メッセージマルチキャストメッセージ最大 500 個のトークンを含むマルチキャスト メッセージ。
ドライランブール値メッセージをドライラン (検証のみ) モードで送信するかどうか。

戻り値:

Promise < BatchResponse >

送信操作の結果を表すオブジェクトで満たされる Promise。

Messaging.sendToCondition()

FCM メッセージを条件に送信します。

コードサンプルと詳細なドキュメントについては、「条件に送信」を参照してください。

サイン:

sendToCondition(condition: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingConditionResponse>;

パラメーター

パラメータタイプ説明
状態どのトピックにメッセージを送信するかを決定する条件。
ペイロードメッセージングペイロードメッセージのペイロード。
オプションメッセージングオプションメッセージを変更するためのオプション。

戻り値:

Promise< MessagingConditionResponse >

メッセージが送信された後、サーバーの応答によって履行される約束。

Messaging.sendToDevice()

代わりにMessaging.send()を使用してください。

提供された登録トークンに対応する単一のデバイスに FCM メッセージを送信します。

コードサンプルと詳細なドキュメントについては、 「個別のデバイスに送信」を参照してください。単一のデバイスに送信するためのregistrationToken 、または複数のデバイスに送信するためのトークンの配列を含むregistrationTokensパラメータのいずれかを受け取ります。

サイン:

sendToDevice(registrationTokenOrTokens: string | string[], payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDevicesResponse>;

パラメーター

パラメータタイプ説明
登録トークンまたはトークン文字列 |弦[]
ペイロードメッセージングペイロードメッセージのペイロード。
オプションメッセージングオプションメッセージを変更するためのオプション。

戻り値:

Promise< MessagingDevicesResponse >

メッセージが送信された後、サーバーの応答によって履行される約束。

Messaging.sendToDeviceGroup()

代わりにMessaging.send()を使用してください。

提供された通知キーに対応するデバイス グループに FCM メッセージを送信します。

コード サンプルと詳細なドキュメントについては、「デバイス グループに送信する」を参照してください。

サイン:

sendToDeviceGroup(notificationKey: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDeviceGroupResponse>;

パラメーター

パラメータタイプ説明
通知キーメッセージの送信先となるデバイス グループの通知キー。
ペイロードメッセージングペイロードメッセージのペイロード。
オプションメッセージングオプションメッセージを変更するためのオプション。

戻り値:

Promise< MessagingDeviceGroupResponse >

メッセージが送信された後、サーバーの応答によって履行される約束。

Messaging.sendToTopic()

FCM メッセージをトピックに送信します。

コードサンプルと詳細なドキュメントについては、「トピックに送信」を参照してください。

サイン:

sendToTopic(topic: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingTopicResponse>;

パラメーター

パラメータタイプ説明
トピックメッセージの送信先のトピック。
ペイロードメッセージングペイロードメッセージのペイロード。
オプションメッセージングオプションメッセージを変更するためのオプション。

戻り値:

Promise< MessagingTopicResponse >

メッセージが送信された後、サーバーの応答によって履行される約束。

Messaging.subscribeToTopic()

デバイスを FCM トピックにサブスクライブします。

コード サンプルと詳細なドキュメントについては、「トピックの購読」を参照してください。オプションで、複数のデバイスをサブスクライブするためのトークンの配列を提供できます。

サイン:

subscribeToTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;

パラメーター

パラメータタイプ説明
登録トークンまたはトークン文字列 |弦[]
トピック購読するトピック。

戻り値:

Promise< MessagingTopicManagementResponse >

デバイスがトピックにサブスクライブされた後、サーバーの応答によって履行される Promise。

Messaging.unsubscribeFromTopic()

FCM トピックからデバイスのサブスクライブを解除します。

コードサンプルと詳細なドキュメントについては、「トピックの購読を解除する」を参照してください。必要に応じて、複数のデバイスのサブスクライブを解除するためのトークンの配列を提供できます。

サイン:

unsubscribeFromTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;

パラメーター

パラメータタイプ説明
登録トークンまたはトークン文字列 |弦[]
トピック購読を解除するトピック。

戻り値:

Promise< MessagingTopicManagementResponse >

デバイスがトピックからサブスクライブ解除された後、サーバーの応答によって履行された Promise。