Firebase 雲端訊息傳遞 (FCM)。
功能
功能 | 描述 |
---|---|
獲取訊息(應用程式) | 取得預設應用程式或給定應用程式的訊息傳遞服務。可以不帶任何參數呼叫admin.messaging() 來存取預設應用程式的Messaging 服務,或作為admin.messaging(app) 來存取與特定應用程式關聯的Messaging 服務。 |
課程
班級 | 描述 |
---|---|
訊息傳遞 | 訊息服務綁定到所提供的應用程式。 |
介面
介面 | 描述 |
---|---|
Android配置 | 表示可以包含在訊息中的 Android 特定選項。 |
AndroidFcm選項 | 表示適用於 Android 的 FCM SDK 提供的功能選項。 |
Android通知 | 表示可以包含在AndroidConfig中的 Android 特定通知選項。 |
Apns配置 | 表示可以包含在訊息中的 APN 特定選項。有關 APN 支援的各種標頭和有效負載字段,請參閱Apple 文件。 |
ApnsFcm選項 | 表示適用於 iOS 的 FCM SDK 提供的功能選項。 |
Apns有效負載 | 表示 APNs 訊息的負載。主要由aps 字典組成。但也可能包含其他任意自訂鍵。 |
阿普斯 | 表示屬於 APNs 訊息一部分的aps 字典。 |
Aps警報 | |
基本訊息 | |
大量響應 | 表示來自Messaging.sendAll()和Messaging.sendMulticast()方法的伺服器回應的介面。 |
條件訊息 | |
批判聲音 | 表示可包含在 APNs 有效負載的aps 字典中的關鍵聲音配置。 |
數據訊息有效負載 | 表示 FCM 舊版 API 資料訊息有效負載的介面。資料訊息允許開發人員發送最多 4KB 的自訂鍵值對。鍵和值必須都是字串。鍵可以是任何自訂字串,但以下保留字串除外:
|
Fcm選項 | 表示 FCM SDK 提供的功能的獨立於平台的選項。 |
燈光設定 | 表示控制可包含在AndroidNotification中的通知 LED 的設置。 |
訊息條件回應 | 表示來自舊版Messaging.sendToCondition()方法的伺服器回應的介面。請參閱傳送至條件以取得程式碼範例和詳細文件。 |
訊息設備群組回應 | 表示來自Messaging.sendToDeviceGroup()方法的伺服器回應的介面。請參閱向設備群組傳送訊息以取得程式碼範例和詳細文件。 |
訊息設備結果 | 來自單一裝置的單獨狀態回應負載 |
訊息傳遞設備回應 | 表示透過 FCM 舊版 API 傳送到單一裝置的訊息狀態的介面。請參閱傳送至各個裝置以取得程式碼範例和詳細文件。 |
訊息選項 | 表示透過 FCM 舊版 API 發送訊息時可以提供的選項的介面。請參閱建置傳送請求以取得程式碼範例和詳細文件。 |
訊息有效負載 | 表示 Firebase Cloud Messaging 訊息負載的介面。需要data 和notification 金鑰之一或兩者。請參閱建置傳送請求以取得程式碼範例和詳細文件。 |
訊息傳遞主題管理回應 | 表示來自Messaging.subscribeToTopic()和Messaging.unsubscribeFromTopic()方法的伺服器回應的介面。請參閱從伺服器管理主題以取得程式碼範例和詳細文件。 |
訊息主題回應 | 表示來自舊Messaging.sendToTopic()方法的伺服器回應的介面。請參閱傳送至主題以取得程式碼範例和詳細文件。 |
群播訊息 | Messaging.sendMulticast()方法的負載。有效負載包含 BaseMessage 類型中的所有欄位以及令牌清單。 |
通知 | 可包含在訊息中的通知。 |
通知訊息負載 | 表示 FCM 舊版 API 通知訊息負載的介面。通知訊息允許開發人員發送最多 4KB 的預定義鍵值對。接受的密鑰概述如下。請參閱建置傳送請求以取得程式碼範例和詳細文件。 |
發送回應 | 表示作為批次請求的一部分發送的單一訊息的狀態的介面。 |
令牌訊息 | |
主題留言 | |
Webpush配置 | 表示可以包含在訊息中的 WebPush 協定選項。 |
WebpushFcm選項 | 表示 FCM SDK for Web 提供的功能選項(不屬於 Webpush 標準的一部分)。 |
網頁推播通知 | 表示可以包含在WebpushConfig中的特定於 WebPush 的通知選項。這支援 Web 通知規範中定義的大多數標準選項。 |
類型別名
類型別名 | 描述 |
---|---|
訊息 | Messaging.send()操作的有效負載。有效負載包含 BaseMessage 類型中的所有字段,並且恰好是令牌、主題或條件之一。 |
獲取訊息傳遞()
取得預設應用程式或給定應用程式的訊息傳遞服務。
可以不帶任何參數呼叫admin.messaging()
來存取預設應用程式的Messaging
服務,或作為admin.messaging(app)
來存取與特定應用程式關聯的Messaging
服務。
簽名:
export declare function getMessaging(app?: App): Messaging;
參數
範圍 | 類型 | 描述 |
---|---|---|
應用程式 | 應用程式 | 返回其Messaging 服務的可選應用程式。如果未提供,將傳回預設的Messaging 服務。 |
返回:
預設Messaging
服務(如果未提供應用程式)或與所提供的應用程式關聯的Messaging
服務。
實施例1
// Get the Messaging service for the default app
const defaultMessaging = getMessaging();
實施例2
// Get the Messaging service for a given app
const otherMessaging = getMessaging(otherApp);
訊息
Messaging.send()操作的有效負載。有效負載包含 BaseMessage 類型中的所有字段,並且恰好是令牌、主題或條件之一。
簽名:
export type Message = TokenMessage | TopicMessage | ConditionMessage;