@firebase/messaging/sw

機能

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

インターフェース

インターフェース説明
FcmオプションFCM SDK for Web によって提供される機能のオプション。 「WebpushFcmOptions」を参照してください。
GetTokenOptions getToken()のオプション
メッセージペイロードNoticePayloadで表される通知ペイロードと、 Send APIを通じて開発者によって送信される任意の数のキーと値のペアを含むデータ ペイロードを含むメッセージ ペイロード
メッセージングFirebase Cloud Messaging SDK のパブリック インターフェース。
通知ペイロード通知の詳細を表示します。詳細は送信 APIを通じて送信されます

関数(アプリ、...)

getMessaging(アプリ)

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

サイン:

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

パラメーター

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

戻り値:

メッセージング

提供された Firebase アプリに関連付けられた Firebase Cloud Messaging インスタンス。

機能(メッセージングなど)

実験的SetdeliveryMetricsExportedToBigQueryEnabled(メッセージング、有効化)

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

サイン:

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

パラメーター

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

戻り値:

空所

onBackgroundMessage(メッセージング、nextOrObserver)

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

サイン:

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

パラメーター

パラメータタイプ説明
メッセージングメッセージングメッセージングインスタンス。
次またはオブザーバーNextFn <メッセージペイロード> |観察者<メッセージペイロード>この関数、またはnext定義されているオブザーバー オブジェクトは、メッセージが受信され、アプリが現在バックグラウンドにあるときに呼び出されます。

戻り値:

購読を解除する

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

関数()

isSupported()

必要なすべての API が SW コンテキスト内に存在するかどうかを確認します

サイン:

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

戻り値:

Promise<ブール値>

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