firebase-admin.messaging package

Firebase 雲端通訊 (FCM)。

函式

函式 說明
getMessaging(應用程式) 取得預設應用程式或特定應用程式的訊息服務。admin.messaging() 在無需引數的情況下呼叫 admin.messaging(),即可存取預設應用程式的 Messaging 服務,也可使用 admin.messaging(app) 存取與特定應用程式相關聯的 Messaging 服務。

類別

類別 說明
FirebaseMessagingError Firebase 通訊錯誤代碼結構。這會擴充 PrefixedFirebaseError。
訊息 繫結至所提供應用程式的訊息服務。
MessagingClientErrorCode 訊息用戶端錯誤代碼和預設訊息。

介面

介面 說明
Android 設定 代表可納入「訊息」 中的 Android 專用選項。
AndroidFcm 選項 代表 FCM SDK for Android 提供的功能選項。
Android 通知 代表可納入 AndroidConfig 的 Android 專屬通知選項。
ApnsConfig 代表可納入「訊息」 中的 APN 專用選項。如要查看 APN 支援的各種標頭和酬載欄位,請參閱 Apple 說明文件
ApnsFcm 選項 代表 FCM SDK for iOS 提供的功能選項。
ApnsPayload 代表 APN 訊息的酬載。主要由 aps 字典組成。但也可以包含其他任意自訂鍵。
Aps 代表屬於 APN 訊息中的 aps 字典
ApsAlert
BaseMessage
BatchResponse 這個介面代表來自 Messaging.sendAll()Messaging.sendMulticast() 方法的伺服器回應。
ConditionMessage
嚴重音效 代表可納入 APN 酬載的 aps 字典中的重要音效設定。
DataMessagePayload 這個介面代表 FCM 舊版 API 資料訊息酬載。開發人員可以透過資料訊息,傳送多達 4 KB 的自訂鍵/值組合。索引鍵和值都必須為字串。鍵可以是任何自訂字串,但下列保留字串除外:
  • from
  • 任何開頭為 google. 的項目
如需程式碼範例和詳細說明文件,請參閱「建構傳送要求」一文。
Fcm 選項 代表 FCM SDK 所提供功能在平台以外的選項。
燈具設定 代表可控制 AndroidNotification 中通知 LED 的設定。
MessagingConditionResponse 這個介面代表來自舊版 Messaging.sendToCondition() 方法的伺服器回應。如需程式碼範例和詳細說明文件,請參閱「傳送到條件」一節。
MessagingDeviceGroupResponse 此介面代表來自 Messaging.sendToDeviceGroup() 方法的伺服器回應。如需程式碼範例和詳細說明文件,請參閱「傳送訊息給裝置群組」。
MessagingDeviceResult 單一裝置的個別狀態回應酬載
MessagingDevicesResponse 這個介面代表訊息透過 FCM 舊版 API 傳送到個別裝置的狀態。如需程式碼範例和詳細說明文件,請參閱「傳送至個別裝置」。
訊息選項 這個介面代表透過 FCM 舊版 API 傳送訊息時可提供哪些選項。如需程式碼範例和詳細說明文件,請參閱「建構傳送要求」部分。
MessagingPayload 代表 Firebase 雲端通訊訊息酬載的介面。datanotification 鍵須擇一使用。如需程式碼範例和詳細說明文件,請參閱「建構傳送要求」。
訊息主題管理回應 這個介面代表來自 Messaging.subscribeToTopic()Messaging.unsubscribeFromTopic() 方法的伺服器回應。如需程式碼範例和詳細說明文件,請參閱從伺服器管理主題
訊息主題回應 這個介面代表來自舊版 Messaging.sendToTopic() 方法的伺服器回應。如需程式碼範例和詳細說明文件,請參閱「傳送至主題」一節。
多點傳播訊息 Messaging.sendMulticast() 方法的酬載。酬載包含 BaseMessage 類型中的所有欄位,以及權杖清單。
通知 可納入「訊息」的通知。
NotificationMessagePayload 代表 FCM 舊版 API 通知訊息酬載的介面。通知訊息可讓開發人員傳送多達 4 KB 的預先定義鍵/值組合。以下是可接受的金鑰。如需程式碼範例和說明文件,請參閱「建構傳送要求」。
SendResponse (傳送回應) 這個介面代表個別訊息在批次要求中傳送的狀態。
TokenMessage
主題訊息
WebpushConfig 代表可包含在 Message 中的 WebPush 通訊協定選項。
WebpushFcm 選項 代表網頁版 FCM SDK 提供的功能選項 (不屬於 Webpush 標準)。
網頁 push 通知 代表可納入 WebpushConfig 中的 WebPush 專屬通知選項。可支援大多數標準選項 (如網頁通知規格所述)。

型別別名

類型別名 說明
傳送訊息 Messaging.send() 作業的酬載。酬載包含 BaseMessage 類型中的所有欄位,以及一個符記、主題或條件。

getMessaging(應用程式)

取得預設應用程式或特定應用程式的訊息服務。

呼叫 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;