@firebase/messaging/sw

関数

関数	説明
function(app, ...)
getMessaging(app)	Firebase Cloud Messaging インスタンスを取得します。
function(messaging, ...)
experimentalSetDeliveryMetricsExportedToBigQueryEnabled(messaging, enable)	BigQuery への Firebase Cloud Messaging のメッセージ配信の指標のエクスポートを有効または無効にします。デフォルトでは、メッセージ配信の指標は BigQuery にエクスポートされません。このメソッドを使用して、実行時にエクスポートを有効または無効にします。
onBackgroundMessage(Messaging, nextOrObserver)	アプリがバックグラウンドで動作中にメッセージを受信すると呼び出されます。アクティブなウィンドウが表示されていない場合、アプリはバックグラウンドにあるとみなされます。
function（）
isSupported()	必要なすべての API がソフトウェア コンテキスト内に存在することを確認してください

インターフェース

インターフェース	説明
FcmOptions	ウェブ用 FCM SDK によって提供される機能のオプション。WebpushFcmOptions をご覧ください。
GetTokenOptions	getToken() のオプション。
MessagePayload	NotificationPayload で表される通知ペイロードと、デベロッパーが Send API を介して送信した任意の数の Key-Value ペアを含むデータ ペイロードを含むメッセージ ペイロード。
メッセージ	Firebase Cloud Messaging SDK の公開インターフェース。
NotificationPayload	通知の詳細を表示します。詳細は Send API によって送信されます。

関数（アプリ、...）

getMessaging（アプリ）

Firebase Cloud Messaging インスタンスを取得します。

署名:

export declare function getMessagingInSw(app?: FirebaseApp): Messaging;

パラメータ

パラメータ	型	説明
アプリ	FirebaseApp

戻り値:

メッセージ

指定された Firebase アプリに関連付けられている Firebase Cloud Messaging インスタンス。

関数（メッセージング, ...）

experimentSetDeliveryMetricsExportedToBigQueryEnabled(messaging, enable)

BigQuery への Firebase Cloud Messaging のメッセージ配信の指標のエクスポートを有効または無効にします。デフォルトでは、メッセージ配信の指標は BigQuery にエクスポートされません。このメソッドを使用して、実行時にエクスポートを有効または無効にします。

署名:

export declare function experimentalSetDeliveryMetricsExportedToBigQueryEnabled(messaging: Messaging, enable: boolean): void;

パラメータ

パラメータ	型	説明
メッセージング	メッセージ	FirebaseMessaging インスタンス。
有効にする	ブール値	Firebase Cloud Messaging でメッセージ配信の指標を BigQuery にエクスポートするかどうか。

戻り値:

void

onBackgroundMessage(Messaging, nextOrObserver)

アプリがバックグラウンドで動作中にメッセージを受信すると呼び出されます。アクティブなウィンドウが表示されていない場合、アプリはバックグラウンドにあるとみなされます。

署名:

export declare function onBackgroundMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;

パラメータ

パラメータ	型	説明
メッセージング	メッセージ	Messaging インスタンス。
nextOrObserver	NextFn<MessagePayload>|オブザーバー<MessagePayload>	この関数または next が定義されたオブザーバー オブジェクトは、メッセージを受信してアプリが現在バックグラウンドで実行されているときに呼び出されます。

戻り値:

配信停止

メッセージのリッスンを停止するには、この返された関数を実行します。

関数

isSupported()

必要なすべての API がソフトウェア コンテキスト内に存在することを確認してください

署名:

export declare function isSwSupported(): Promise<boolean>;

戻り値:

Promise<boolean>

ブール値に解決される Promise。