功能
功能 | 描述 |
---|---|
函數(應用程序,...) | |
獲取訊息(應用程式) | 檢索 Firebase Cloud Messaging 實例。 |
功能(訊息傳遞,...) | |
刪除令牌(訊息) | 刪除與此Messaging實例關聯的註冊令牌,並從推送訂閱取消訂閱Messaging實例。 |
getToken(訊息,選項) | 訂閱Messaging實例以推播通知。傳回一個 Firebase Cloud Messaging 註冊令牌,可用來將推播訊息傳送到該Messaging實例。如果尚未授予通知權限,此方法會要求使用者授予權限。如果使用者不允許應用程式顯示通知,則傳回的承諾將被拒絕。 |
onMessage(訊息傳遞,nextOrObserver) | 當收到推播訊息並且使用者目前位於來源頁面上時,該訊息將傳遞到該頁面,並使用推播訊息的有效負載調度onMessage() 事件。 |
功能() | |
isSupported() | 檢查瀏覽器中是否存在所有必要的 API。 |
介面
介面 | 描述 |
---|---|
Fcm選項 | FCM SDK for Web 提供的功能選項。請參閱WebpushFcmOptions 。 |
取得令牌選項 | getToken()的選項。 |
訊息負載 | 訊息負載包含用NotificationPayload表示的通知負載和包含開發人員透過Send API發送的任意數量的鍵值對的資料負載。 |
訊息傳遞 | Firebase 雲端訊息傳遞 SDK 的公用介面。 |
通知負載 | 顯示通知詳細資訊。詳細資訊透過發送 API 發送。 |
函數(應用程序,...)
獲取訊息(應用程式)
檢索 Firebase Cloud Messaging 實例。
簽名:
export declare function getMessagingInWindow(app?: FirebaseApp): Messaging;
參數
範圍 | 類型 | 描述 |
---|---|---|
應用程式 | Firebase應用程式 |
返回:
與提供的 Firebase 應用程式關聯的 Firebase Cloud Messaging 實例。
功能(訊息傳遞,...)
刪除令牌(訊息)
刪除與此Messaging實例關聯的註冊令牌,並從推送訂閱取消訂閱Messaging實例。
簽名:
export declare function deleteToken(messaging: Messaging): Promise<boolean>;
參數
範圍 | 類型 | 描述 |
---|---|---|
訊息傳遞 | 訊息傳遞 | 訊息傳遞實例。 |
返回:
承諾<布林值>
當令牌被成功刪除時,承諾就會解決。
getToken(訊息,選項)
訂閱Messaging實例以推播通知。傳回一個 Firebase Cloud Messaging 註冊令牌,可用來將推播訊息傳送到該Messaging實例。
如果尚未授予通知權限,此方法會要求使用者授予權限。如果使用者不允許應用程式顯示通知,則傳回的承諾將被拒絕。
簽名:
export declare function getToken(messaging: Messaging, options?: GetTokenOptions): Promise<string>;
參數
範圍 | 類型 | 描述 |
---|---|---|
訊息傳遞 | 訊息傳遞 | 訊息傳遞實例。 |
選項 | 取得令牌選項 | 提供可選的 vapid 金鑰和可選的 Service Worker 註冊。 |
返回:
承諾<字串>
該承諾透過 FCM 註冊令牌來解決。
onMessage(訊息傳遞,nextOrObserver)
當收到推播訊息並且使用者目前位於來源頁面上時,該訊息將傳遞到該頁面,並使用推播訊息的有效負載調度onMessage()
事件。
簽名:
export declare function onMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
參數
範圍 | 類型 | 描述 |
---|---|---|
訊息傳遞 | 訊息傳遞 | 訊息傳遞實例。 |
下一個或觀察者 | 下一個Fn <訊息有效負載> |觀察者<訊息有效負載> | 當收到訊息並且使用者目前正在查看您的頁面時,將呼叫此函數或定義了next 觀察者物件。 |
返回:
若要停止偵聽訊息,請執行此傳回的函數。
功能()
isSupported()
檢查瀏覽器中是否存在所有必要的 API。
簽名:
export declare function isWindowSupported(): Promise<boolean>;
返回:
承諾<布林值>
解析為布林值的 Promise。