Firebase 雲端通訊 (FCM)。
函式
| 函式 | 說明 |
|---|---|
| getMessaging(應用程式) | 取得預設應用程式或特定應用程式的「訊息」服務。不用引數即可呼叫 admin.messaging()，藉此存取預設應用程式的 Messaging 服務，也可以做為 admin.messaging(app) 來存取與特定應用程式相關聯的 Messaging 服務。 |
等級
| 類別 | 說明 |
|---|---|
| 訊息 | 繫結至所提供應用程式的訊息服務。 |
介面
| 介面 | 說明 |
|---|---|
| AndroidConfig | 代表可納入 Message 的 Android 專用選項。 |
| AndroidFcmOptions | 代表 FCM SDK for Android 提供的功能選項。 |
| Android 通知 | 代表可納入 AndroidConfig 的 Android 專屬通知選項。 |
| ApnsConfig | 代表可納入「訊息」 的 APN 特定選項。如要瞭解 APN 支援的各種標頭和酬載欄位，請參閱 Apple 說明文件。 |
| ApnsFcmOptions | 代表 FCM SDK for iOS 提供的功能選項。 |
| ApnsPayload | 代表 APN 訊息的酬載。主要是由 aps 字典組成。但也可能包含其他任意自訂鍵。 |
| Aps | 代表 APN 訊息中的 aps 字典。 |
| ApsAlert | |
| BaseMessage | |
| BatchResponse | 代表伺服器回應的 Messaging.sendAll() 和 Messaging.sendMulticast() 方法的介面。 |
| 條件訊息 | |
| CriticalSound (關鍵音效) | 代表可包含在 APN 酬載 aps 字典中的重要音效設定。 |
| DataMessagePayload | 代表 FCM 舊版 API 資料訊息酬載的介面。資料訊息可讓開發人員傳送多達 4 KB 的自訂鍵/值組合。鍵和值都必須是字串。鍵可以是任何自訂字串，但下列保留字串除外：
|
| FcmOptions | 代表與 FCM SDK 所提供功能相關的平台選項。 |
| 燈具設定 | 代表可控制在 AndroidNotification 中的通知 LED 設定。 |
| MessagingConditionResponse | 代表舊版 Messaging.sendToCondition() 方法的伺服器回應的介面。如需程式碼範例和詳細說明文件，請參閱「傳送至條件」一節。 |
| MessagingDeviceGroupResponse | 代表伺服器回應的 Messaging.sendToDeviceGroup() 方法的回應介面。如需程式碼範例和詳細的說明文件，請參閱「傳送訊息給裝置群組」。 |
| MessagingDeviceResult | 單一裝置的個別狀態回應酬載 |
| MessagingDevicesResponse | 代表透過 FCM 舊版 API 傳送到個別裝置的訊息狀態的介面。如需程式碼範例和詳細的說明文件，請參閱「傳送至個別裝置」。 |
| 訊息選項 | 代表透過 FCM 舊版 API 傳送訊息時可提供的選項的介面。如需程式碼範例和詳細的說明文件，請參閱「建構傳送要求」。 |
| MessagingPayload | 代表 Firebase 雲端通訊訊息酬載的介面。必須提供 data 和/或 notification 鍵。如需程式碼範例和詳細說明文件，請參閱「建構傳送要求」。 |
| 訊息主題管理回應 | 代表伺服器回應的 Messaging.subscribeToTopic() 和 Messaging.unsubscribeFromTopic() 方法的介面。如需程式碼範例和詳細的說明文件，請參閱「從伺服器管理主題」一文。 |
| 訊息主題回應 | 代表來自舊版 Messaging.sendToTopic() 方法的伺服器回應的介面。如需程式碼範例和詳細說明文件，請參閱「傳送至主題」。 |
| 多點傳送訊息 | Messaging.sendMulticast() 方法的酬載。酬載包含 BaseMessage 類型中的所有欄位，以及權杖清單。 |
| 通知 | 可從「訊息」中加入的通知。 |
| NotificationMessagePayload | 代表 FCM 舊版 API 通知訊息酬載的介面。開發人員可利用通知訊息，傳送最多 4 KB 的預先定義鍵/值組合。以下概述接受的金鑰。如需程式碼範例和詳細的說明文件，請參閱「建構傳送要求」。 |
| SendResponse | 代表在批次要求中所傳送的個別訊息狀態的介面。 |
| TokenMessage | |
| 主題訊息 | |
| WebpushConfig | 代表可包含在訊息中的 WebPush 通訊協定選項。 |
| WebpushFcmOptions | 代表網頁版 FCM SDK 提供的功能選項 (不屬於 Webpush 標準)。 |
| WebpushNotification | 代表可包含在 WebpushConfig 中的 WebPush 專屬通知選項。這項功能支援網路通知的規格中定義的大多數標準選項。 |
類型別名
| 類型別名 | 說明 |
|---|---|
| 傳送訊息 | Messaging.send() 作業的酬載。酬載包含 BaseMessage 類型中的所有欄位，以及下列其中一個符記、主題或條件。 |
getMessaging(應用程式)
呼叫 admin.messaging() 時無需引數，即可存取預設應用程式的 Messaging 服務，或做為 admin.messaging(app) 存取與特定應用程式相關聯的 Messaging 服務。
簽名：
export declare function getMessaging(app?: App): Messaging;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| app | 應用程式 | 選用應用程式，指定 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;