Messaging class

指定されたアプリにバインドされているメッセージ サービス。

署名:

export declare class Messaging 

プロパティ

プロパティ 修飾キー タイプ 説明
アプリ アプリ 現在の Messaging サービス インスタンスに関連付けられているアプリ

メソッド

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

Messaging.app

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

署名:

get app(): App;

var app = messaging.app;

Messaging.enableLegacyHttpTransport()

<ph type="x-smartling-placeholder">
</ph>

これは、HTTP/2 トランスポートの実装が以前の HTTP/1.1 実装と同じ安定性に達すると削除される予定です。

sendEach()sendEachForMulticast() でレガシー HTTP/1.1 トランスポートの使用を有効にします。

署名:

enableLegacyHttpTransport(): void;

戻り値:

void

const messaging = getMessaging(app);
messaging.enableLegacyTransport();
messaging.sendEach(messages);

Messaging.send()

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

署名:

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

パラメータ

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

戻り値:

Promise<文字列>

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

Messaging.sendAll()

<ph type="x-smartling-placeholder">
</ph>

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

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

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

署名:

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

パラメータ

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

戻り値:

Promise<BatchResponse>

送信オペレーションの結果を表すオブジェクトで解決される Promise。

Messaging.sendEach()

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

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

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

署名:

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

パラメータ

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

戻り値:

Promise<BatchResponse>

送信オペレーションの結果を表すオブジェクトで解決される Promise。

Messaging.sendEachForMulticast()

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

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

署名:

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

パラメータ

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

戻り値:

Promise<BatchResponse>

送信オペレーションの結果を表すオブジェクトで解決される Promise。

Messaging.sendMulticast()

<ph type="x-smartling-placeholder">
</ph>

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

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

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

署名:

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

パラメータ

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

戻り値:

Promise<BatchResponse>

送信オペレーションの結果を表すオブジェクトで解決される Promise。

Messaging.sendToCondition()

<ph type="x-smartling-placeholder">
</ph>

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

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

コードサンプルと詳細なドキュメントについては、条件に送信するをご覧ください。

署名:

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

パラメータ

パラメータ 説明
条件 文字列 メッセージの送信先のトピックを決定する条件。
payload MessagingPayload メッセージ ペイロード。
オプション MessagingOptions メッセージを変更するオプション。

戻り値:

Promise <MessagingConditionResponse>

メッセージ送信後にサーバーのレスポンスによって履行される Promise。

Messaging.sendToDevice()

<ph type="x-smartling-placeholder">
</ph>

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

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

コードサンプルと詳細なドキュメントについては、個々のデバイスに送信するをご覧ください。1 つのデバイスに送信する registrationToken か、複数のデバイスに送信するトークンの配列を含む registrationTokens パラメータを取得します。

署名:

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

パラメータ

パラメータ 説明
subscriptionTokenOrTokens。 文字列 |文字列 []
payload MessagingPayload メッセージ ペイロード。
オプション MessagingOptions メッセージを変更するオプション。

戻り値:

Promise <MessagingDevicesResponse>

メッセージ送信後にサーバーのレスポンスによって履行される Promise。

Messaging.sendToDeviceGroup()

<ph type="x-smartling-placeholder">
</ph>

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

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

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

署名:

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

パラメータ

パラメータ 説明
notificationKey 文字列 メッセージの送信先のデバイス グループの通知キー。
payload MessagingPayload メッセージ ペイロード。
オプション MessagingOptions メッセージを変更するオプション。

戻り値:

Promise<MessagingDeviceGroupResponse>

メッセージ送信後にサーバーのレスポンスによって履行される Promise。

Messaging.sendToTopic()

<ph type="x-smartling-placeholder">
</ph>

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

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

コードのサンプルと詳細なドキュメントについては、トピックに送信するをご覧ください。

署名:

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

パラメータ

パラメータ 説明
topic 文字列 メッセージの送信先のトピック。
payload MessagingPayload メッセージ ペイロード。
オプション MessagingOptions メッセージを変更するオプション。

戻り値:

Promise <MessagingTopicResponse>

メッセージ送信後にサーバーのレスポンスによって履行される Promise。

Messaging.subscribeToTopic()

デバイスを FCM トピックに登録する。

コードサンプルと詳細なドキュメントについては、トピックにサブスクライブするをご覧ください。必要に応じて、トークンの配列を指定して、複数のデバイスを登録できます。

署名:

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

パラメータ

パラメータ 説明
subscriptionTokenOrTokens。 文字列 |文字列 []
topic 文字列 サブスクライブ先のトピック。

戻り値:

Promise<MessagingTopicManagementResponse>

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

Messaging.unsubscribeFromTopic()

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

コードサンプルと詳細なドキュメントについては、トピックからサブスクライブ解除するをご覧ください。必要に応じて、トークンの配列を指定して、複数のデバイスの登録を解除できます。

署名:

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

パラメータ

パラメータ 説明
subscriptionTokenOrTokens。 文字列 |文字列 []
topic 文字列 登録解除するトピック。

戻り値:

Promise<MessagingTopicManagementResponse>

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