函式
| 函式 | 說明 |
|---|---|
| 功能(應用程式, ...) | |
| getMessaging(應用程式) | 擷取 Firebase 雲端通訊執行個體。 |
| 功能(訊息, ...) | |
| experimentalSetDeliveryMetricsExportedToBigQueryEnabled(訊息, 啟用) | 啟用或停用 Firebase 雲端通訊訊息傳送指標匯出至 BigQuery 的功能。根據預設，訊息傳送指標不會匯出至 BigQuery。請使用這個方法在執行階段啟用或停用匯出功能。 |
| onBackgroundMessage(訊息、NextOrObserver) | 當應用程式在背景執行時收到訊息時呼叫。如果應用程式未顯示使用中的視窗，即視為在背景執行。 |
| function() | |
| isSupported() | 檢查 SW 情境中是否包含所有必要的 API |
介面
| 介面 | 說明 |
|---|---|
| Fcm 選項 | FCM SDK for Web 的功能選項。請參閱 WebpushFcmOptions。 |
| GetTokenOptions | getToken() 的選項。 |
| MessagePayload | 包含以 NotificationPayload 表示的通知酬載的訊息酬載，以及包含開發人員透過 Send API 傳送的任意數量鍵/值組合的資料酬載。 |
| 訊息 | Firebase 雲端通訊 SDK 的公開介面。 |
| 通知 Payload | 顯示通知詳細資料。詳細資料會透過 Send API 傳送。 |
function(應用程式, ...)
getMessaging(應用程式)
擷取 Firebase 雲端通訊執行個體。
簽名：
export declare function getMessagingInSw(app?: FirebaseApp): Messaging;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 應用程式 | Firebase 應用程式 |
傳回：
與提供的 Firebase 應用程式相關聯的 Firebase 雲端通訊執行個體。
函式(訊息, ...)
experimentSetDeliveryMetricsExportedToBigQueryEnabled(訊息, 啟用)
啟用或停用 Firebase 雲端通訊訊息傳送指標匯出至 BigQuery 的功能。根據預設，訊息傳送指標不會匯出至 BigQuery。請使用這個方法在執行階段啟用或停用匯出功能。
簽名：
export declare function experimentalSetDeliveryMetricsExportedToBigQueryEnabled(messaging: Messaging, enable: boolean): void;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 訊息傳遞 | 訊息 | FirebaseMessaging 例項。 |
| 啟用 | 布林值 | Firebase 雲端通訊是否應將訊息傳送指標匯出至 BigQuery。 |
傳回：
void
onBackgroundMessage(訊息, NextOrObserver)
當應用程式在背景執行時收到訊息時呼叫。如果應用程式未顯示使用中的視窗，即視為在背景執行。
簽名：
export declare function onBackgroundMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 訊息傳遞 | 訊息 | Messaging 執行個體。 |
| NextOrObserver | NextFn<MessagePayload>|觀察者<MessagePayload> | 收到訊息且應用程式目前處於背景執行狀態時，系統會呼叫此函式或已定義 next 的觀察器物件。 |
傳回：
如要停止監聽訊息，請執行這個傳回的函式
function()
is supported()
檢查 SW 情境中是否包含所有必要的 API
簽名：
export declare function isSwSupported(): Promise<boolean>;
傳回：
Promise<boolean>
解析為布林值的 Promise。