@firebase/messaging/sw

功能

功能描述
函數(應用程序,...)
獲取訊息(應用程式)檢索 Firebase Cloud Messaging 實例。
功能(訊息傳遞,...)
ExperimentalSetDeliveryMetricsExportedToBigQueryEnabled(訊息傳遞,啟用)啟用或停用 Firebase Cloud Messaging 訊息傳遞指標匯出到 BigQuery。預設情況下,訊息傳送指標不會匯出到 BigQuery。使用此方法可以在運行時啟用或停用匯出。
onBackgroundMessage(訊息傳遞,nextOrObserver)當應用程式在背景收到訊息時調用。如果沒有顯示活動窗口,則應用程式被視為處於背景。
功能()
isSupported()檢查所有必需的 API 是否存在於 SW 上下文中

介面

介面描述
Fcm選項FCM SDK for Web 提供的功能選項。請參閱WebpushFcmOptions
取得令牌選項getToken()的選項
訊息負載訊息負載包含用NotificationPayload表示的通知負載和包含開發人員透過Send API發送的任意數量的鍵值對的資料負載
訊息傳遞Firebase 雲端訊息傳遞 SDK 的公用介面。
通知負載顯示通知詳細資訊。詳細資訊透過發送 API 發送

函數(應用程序,...)

獲取訊息(應用程式)

檢索 Firebase Cloud Messaging 實例。

簽名:

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

參數

範圍類型描述
應用程式Firebase應用程式

返回:

訊息傳遞

與提供的 Firebase 應用程式關聯的 Firebase Cloud Messaging 實例。

功能(訊息傳遞,...)

ExperimentalSetDeliveryMetricsExportedToBigQueryEnabled(訊息傳遞,啟用)

啟用或停用 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;

參數

範圍類型描述
訊息傳遞訊息傳遞訊息傳遞實例。
下一個或觀察者下一個Fn <訊息有效負載> |觀察者<訊息有效負載>當收到訊息並且應用程式目前位於背景時,將呼叫此函數或定義了next觀察者物件。

返回:

退訂

若要停止監聽訊息,請執行此傳回的函數

功能()

isSupported()

檢查 SW 上下文中是否存在所有必要的 API

簽名:

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

返回:

承諾<布林值>

解析為布林值的 Promise。