@firebase/messaging

函式

函式 說明
功能(應用程式, ...)
getMessaging(應用程式) 擷取 Firebase 雲端通訊執行個體。
功能(訊息, ...)
deleteToken(訊息) 刪除與這個 Messaging 執行個體相關聯的註冊權杖，並從推送訂閱項目取消訂閱 Messaging 執行個體。
getToken(訊息、選項) 訂閱 Messaging 執行個體來推送通知。傳回 Firebase 雲端通訊註冊權杖，可用於將推送訊息傳送至該 Messaging 執行個體。如果尚未授予通知權限，這個方法會要求使用者授予權限。如果使用者不允許應用程式顯示通知，傳回的承諾會遭到拒絕。
onMessage(訊息、NextOrObserver) 當系統收到推送訊息，且使用者目前位在來源網頁上時，該訊息就會傳遞至頁面，並隨推送訊息的酬載傳送 onMessage() 事件。
function()
isSupported() 檢查瀏覽器中是否具備所有必要的 API。

介面

介面 說明
Fcm 選項 FCM SDK for Web 的功能選項。請參閱 WebpushFcmOptions。
GetTokenOptions getToken() 的選項。
MessagePayload 包含以 NotificationPayload 表示的通知酬載的訊息酬載，以及包含開發人員透過 Send API 傳送的任意數量鍵/值組合的資料酬載。
訊息 Firebase 雲端通訊 SDK 的公開介面。
通知 Payload 顯示通知詳細資料。詳細資料會透過 Send API 傳送。

function(應用程式, ...)

getMessaging(應用程式)

擷取 Firebase 雲端通訊執行個體。

簽名：

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

參數

參數 類型 說明
應用程式 Firebase 應用程式

傳回：

訊息

與提供的 Firebase 應用程式相關聯的 Firebase 雲端通訊執行個體。

函式(訊息, ...)

deleteToken(訊息)

刪除與這個 Messaging 執行個體相關聯的註冊權杖，並從推送訂閱項目取消訂閱 Messaging 執行個體。

簽名：

export declare function deleteToken(messaging: Messaging): Promise<boolean>;

參數

參數 類型 說明
訊息傳遞 訊息 Messaging 執行個體。

傳回：

Promise&lt;boolean&gt;

成功刪除權杖後，承諾就會解決。

getToken(訊息、選項)

訂閱 Messaging 執行個體來推送通知。傳回可用於傳送推送訊息至該 Messaging 執行個體的 Firebase 雲端通訊註冊權杖。

如果尚未授予通知權限，這個方法會要求使用者授予權限。如果使用者不允許應用程式顯示通知，傳回的承諾會遭到拒絕。

簽名：

export declare function getToken(messaging: Messaging, options?: GetTokenOptions): Promise<string>;

參數

參數 類型 說明
訊息傳遞 訊息 Messaging 執行個體。
選項 GetTokenOptions 提供選用的 vapid 金鑰和選用的 Service Worker 註冊。

傳回：

承諾<字串>

承諾使用 FCM 註冊權杖解析。

onMessage(訊息、NextOrObserver)

當系統收到推送訊息，且使用者目前位在來源網頁上時，該訊息就會傳遞至頁面，並隨推送訊息的酬載傳送 onMessage() 事件。

簽名：

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

參數

參數 類型 說明
訊息傳遞 訊息 Messaging 執行個體。
NextOrObserver NextFn<MessagePayload>|觀察者<MessagePayload> 收到訊息且使用者正在瀏覽您的網頁時，系統會呼叫此函式或已定義 next 的觀察器物件。

傳回：

取消訂閱

如要停止監聽訊息，請執行這個傳回的函式。

function()

is supported()

檢查瀏覽器中是否具備所有必要的 API。

簽名：

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

傳回：

Promise&lt;boolean&gt;

解析為布林值的 Promise。