Messaging class

訊息服務綁定到所提供的應用程式。

簽名:

export declare class Messaging 

特性

財產修飾符類型描述
應用程式應用程式與目前Messaging服務實例關聯的應用程式

方法

方法修飾符描述
發送(訊息,dryRun)透過 FCM 發送給定訊息。
發送全部(訊息,dryRun)透過 Firebase Cloud Messaging 發送給定數組中的所有訊息。採用批次將整個清單作為單一 RPC 呼叫傳送。與send()方法相比,此方法是發送多個訊息的更有效的方法。從傳回值獲得的回應清單對應於MulticastMessage中的標記順序。此方法的錯誤表示完全失敗,這意味著清單中的任何訊息都無法發送。部分失敗由BatchResponse回傳值指示。
sendEach(訊息,dryRun)透過 Firebase Cloud Messaging 發送給定數組中的每個訊息。Messaging.sendAll()不同,此方法對給定數組中的每個訊息進行一次 RPC 呼叫。從傳回值中獲得的回應清單與messages的順序相對應。此方法的錯誤或全部失敗的BatchResponse表示完全失敗,這表示清單中的任何訊息都無法傳送。部分失敗或無失敗僅由BatchResponse傳回值指示。
sendEachForMulticast(訊息,dryRun)將給定的多播訊息傳送到其中指定的所有 FCM 註冊令牌。此方法在底層使用Messaging.sendEach() API 將給定訊息傳送給所有目標收件者。從傳回值獲得的回應清單對應於MulticastMessage中的標記順序。此方法中的錯誤或包含所有失敗的BatchResponse表示完全失敗,這表示可以傳送清單中的訊息。部分失敗或失敗僅由BatchResponse回傳值指示。
發送多播(訊息,dryRun)將給定的多播訊息傳送到其中指定的所有 FCM 註冊令牌。此方法在底層使用sendAll() API 將給定訊息傳送給所有目標收件者。從傳回值獲得的回應清單對應於MulticastMessage中的標記順序。此方法的錯誤表示完全失敗,這表示訊息未發送到清單中的任何令牌。部分失敗由BatchResponse回傳值指示。
sendToCondition(條件,有效負載,選項)向條件發送 FCM 訊息。請參閱傳送至條件以取得程式碼範例和詳細文件。
sendToDevice(registrationTokenOrTokens,有效負載,選項)將 FCM 訊息傳送到與所提供的註冊令牌相對應的單一裝置。請參閱傳送至各個裝置以取得程式碼範例和詳細文件。接受一個registrationToken傳送到單一設備,或接受一個包含令牌數組的registrationTokens參數傳送到多個設備。
sendToDeviceGroup(通知金鑰、有效負載、選項)將 FCM 訊息傳送到與提供的通知金鑰對應的設備群組。請參閱傳送至設備群組以取得程式碼範例和詳細文件。
sendToTopic(主題,有效負載,選項)向主題發送 FCM 訊息。請參閱傳送至主題以取得程式碼範例和詳細文件。
subscribeToTopic(registrationTokenOrTokens,主題)為設備訂閱 FCM 主題。請參閱訂閱主題以取得程式碼範例和詳細文件。或者,您可以提供一系列令牌來訂閱多個裝置。
取消訂閱主題(registrationTokenOrTokens,主題)取消設備對 FCM 主題的訂閱。請參閱取消訂閱主題以取得程式碼範例和詳細文件。或者,您可以提供一系列令牌來取消訂閱多個裝置。

訊息傳遞.app

與目前Messaging服務實例關聯的應用程式

簽名:

get app(): App;

例子

var app = messaging.app;

訊息傳遞.send()

透過 FCM 發送給定訊息。

簽名:

send(message: Message, dryRun?: boolean): Promise<string>;

參數

範圍類型描述
訊息訊息訊息有效負載。
幹運行布林值是否以試運行(僅驗證)模式發送訊息。

返回:

承諾<字串>

在訊息成功移交給 FCM 服務進行傳遞後,透過唯一的訊息 ID 字串履行承諾。

訊息傳遞.sendAll()

請改用Messaging.sendEach()

透過 Firebase Cloud Messaging 發送給定數組中的所有訊息。採用批次將整個清單作為單一 RPC 呼叫傳送。與send()方法相比,此方法是發送多個訊息的更有效的方法。

從傳回值中取得的回應清單與MulticastMessage中的標記順序相對應。此方法的錯誤表示完全失敗,這意味著清單中的任何訊息都無法發送。部分失敗由BatchResponse回傳值指示。

簽名:

sendAll(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;

參數

範圍類型描述
訊息訊息[]最多包含 500 個訊息的非空數組。
幹運行布林值是否以試運行(僅驗證)模式發送訊息。

返回:

Promise<批次回應>

用表示發送操作結果的物件來實現的 Promise。

訊息傳遞.sendEach()

透過 Firebase Cloud Messaging 發送給定數組中的每個訊息。

Messaging.sendAll()不同,此方法對給定數組中的每個訊息進行一次 RPC 呼叫。

從傳回值得到的回應清單對應messages的順序。此方法的錯誤或全部失敗的BatchResponse表示完全失敗,這表示清單中的任何訊息都無法傳送。部分失敗或無失敗僅由BatchResponse傳回值指示。

簽名:

sendEach(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;

參數

範圍類型描述
訊息訊息[]最多包含 500 個訊息的非空數組。
幹運行布林值是否以試運行(僅驗證)模式發送訊息。

返回:

Promise<批次回應>

用表示發送操作結果的物件來實現的 Promise。

訊息傳遞.sendEachForMulticast()

將給定的多播訊息傳送到其中指定的所有 FCM 註冊令牌。

此方法在底層使用Messaging.sendEach() API 將給定訊息傳送給所有目標收件者。從傳回值中取得的回應清單與MulticastMessage中的標記順序相對應。此方法中的錯誤或包含所有失敗的BatchResponse表示完全失敗,這表示可以傳送清單中的訊息。部分失敗或失敗僅由BatchResponse回傳值指示。

簽名:

sendEachForMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;

參數

範圍類型描述
訊息群播訊息最多包含 500 個令牌的多播訊息。
幹運行布林值是否以試運行(僅驗證)模式發送訊息。

返回:

Promise<批次回應>

用表示發送操作結果的物件來實現的 Promise。

訊息傳遞.sendMulticast()

請改用Messaging.sendEachForMulticast()

將給定的多播訊息傳送到其中指定的所有 FCM 註冊令牌。

此方法在底層使用sendAll() API 將給定訊息傳送給所有目標收件者。從傳回值中取得的回應清單與MulticastMessage中的標記順序相對應。此方法的錯誤表示完全失敗,這表示訊息未發送到清單中的任何令牌。部分失敗由BatchResponse回傳值指示。

簽名:

sendMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;

參數

範圍類型描述
訊息群播訊息最多包含 500 個令牌的多播訊息。
幹運行布林值是否以試運行(僅驗證)模式發送訊息。

返回:

Promise<批次回應>

用表示發送操作結果的物件來實現的 Promise。

訊息傳遞.sendToCondition()

向條件發送 FCM 訊息。

請參閱傳送至條件以取得程式碼範例和詳細文件。

簽名:

sendToCondition(condition: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingConditionResponse>;

參數

範圍類型描述
狀態細繩確定將訊息傳送到哪些主題的條件。
有效載荷訊息有效負載訊息有效負載。
選項訊息選項用於更改訊息的可選選項。

返回:

Promise<訊息條件回應>

訊息發送後伺服器回應履行的承諾。

訊息傳遞.sendToDevice()

請改用Messaging.send()

將 FCM 訊息傳送到與所提供的註冊令牌相對應的單一裝置。

請參閱傳送至各個裝置以取得程式碼範例和詳細文件。接受一個registrationToken傳送到單一設備,或接受一個包含令牌數組的registrationTokens參數傳送到多個設備。

簽名:

sendToDevice(registrationTokenOrTokens: string | string[], payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDevicesResponse>;

參數

範圍類型描述
註冊令牌或令牌字串|細繩[]
有效載荷訊息有效負載訊息有效負載。
選項訊息選項用於更改訊息的可選選項。

返回:

Promise< MessagingDevicesResponse >

訊息發送後伺服器回應履行的承諾。

訊息傳遞.sendToDeviceGroup()

請改用Messaging.send()

將 FCM 訊息傳送到與提供的通知金鑰對應的設備群組。

請參閱傳送至設備群組以取得程式碼範例和詳細文件。

簽名:

sendToDeviceGroup(notificationKey: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDeviceGroupResponse>;

參數

範圍類型描述
通知鍵細繩向其發送訊息的設備群組的通知鍵。
有效載荷訊息有效負載訊息有效負載。
選項訊息選項用於更改訊息的可選選項。

返回:

Promise< MessagingDeviceGroupResponse >

訊息發送後伺服器回應履行的承諾。

訊息傳遞.sendToTopic()

向主題發送 FCM 訊息。

請參閱傳送至主題以取得程式碼範例和詳細文件。

簽名:

sendToTopic(topic: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingTopicResponse>;

參數

範圍類型描述
話題細繩要將訊息傳送到的主題。
有效載荷訊息有效負載訊息有效負載。
選項訊息選項用於更改訊息的可選選項。

返回:

Promise<訊息主題回應>

訊息發送後伺服器回應履行的承諾。

訊息傳遞.subscribeToTopic()

為設備訂閱 FCM 主題。

請參閱訂閱主題以取得程式碼範例和詳細文件。或者,您可以提供一系列令牌來訂閱多個裝置。

簽名:

subscribeToTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;

參數

範圍類型描述
註冊令牌或令牌字串|細繩[]
話題細繩要訂閱的主題。

返回:

Promise< MessagingTopicManagementResponse >

設備訂閱主題後,透過伺服器的回應履行承諾。

訊息傳遞.unsubscribeFromTopic()

取消設備對 FCM 主題的訂閱。

請參閱取消訂閱主題以取得程式碼範例和詳細文件。或者,您可以提供一系列令牌來取消訂閱多個裝置。

簽名:

unsubscribeFromTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;

參數

範圍類型描述
註冊令牌或令牌字串|細繩[]
話題細繩要取消訂閱的主題。

返回:

Promise< MessagingTopicManagementResponse >

設備取消訂閱主題後,伺服器的回應將履行承諾。