機能
関数 | 説明 |
---|---|
関数(アプリ、...) | |
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。