表示透過 FCM 舊版 API 發送訊息時可以提供的選項的介面。
請參閱建置傳送請求以取得程式碼範例和詳細文件。
簽名:
export interface MessagingOptions
特性
財產 | 類型 | 描述 |
---|---|---|
折疊鍵 | 細繩 | 標識一組可以折疊的訊息(例如“可用更新”)的字串,以便在可以恢復傳遞時僅發送最後一條訊息。這用於避免當設備恢復在線或變為活動狀態時發送太多相同的訊息。無法保證訊息發送的順序。在任何給定時間最多允許有四個不同的折疊鍵。這意味著 FCM 伺服器可以為每個客戶端應用程式同時儲存四個不同的發送同步訊息。如果超過此數量,則無法保證 FCM 伺服器將保留哪四個折疊鍵。 **預設值:** 無 |
內容可用 | 布林值 | 在 iOS 上,使用此欄位表示 APNs 負載中content-available 。當發送通知或資料訊息並將其設為true 時,將喚醒不活動的客戶端應用程式。在 Android 上,預設情況下數據訊息會喚醒應用程式。在 Chrome 上,目前不支援此標誌。 **預設值:** false |
幹運行 | 布林值 | 訊息是否應該實際發送。當設定為true 時,允許開發人員測試請求而無需實際發送訊息。當設定為false 時,將發送訊息。 **預設值:** false |
可變內容 | 布林值 | 在 iOS 上,使用此欄位來表示 APNs 負載中的mutable-content 。發送通知並將其設為true 時,可以使用通知服務應用程式擴充功能在顯示通知之前修改通知的內容。在 Android 和 Web 上,此參數將被忽略。 **預設值:** false |
優先事項 | 細繩 | 訊息的優先順序。有效值為"normal" 和"high". 在 iOS 上,這些對應於 APN 優先權5 和10 。預設情況下,通知訊息以高優先順序發送,資料訊息以普通優先權發送。正常優先順序可最佳化用戶端應用程式的電池消耗,除非需要立即交付,否則應使用正常優先順序。對於具有正常優先權的訊息,應用程式可能會以未指定的延遲接收訊息。當以高優先權發送訊息時,它會立即發送,並且應用程式可以喚醒休眠的裝置並打開與伺服器的網路連線。有關詳細信息,請參閱設定訊息優先級。 **預設值:** 通知訊息為"high" ,資料訊息為"normal" |
受限制的套件名稱 | 細繩 | 註冊令牌必須匹配的應用程式的包名稱才能接收訊息。 **預設值:** 無 |
生存時間 | 數位 | 如果設備離線,訊息應在 FCM 儲存中保留多長時間(以秒為單位)。支援的最長生存時間是四個星期,預設值也是四個星期。有關詳細信息,請參閱設定訊息的生命週期。 **預設值:** 2419200 (代表四個星期,單位為秒) |
MessagingOptions.collapseKey
標識一組可以折疊的訊息(例如“可用更新”)的字串,以便在可以恢復傳遞時僅發送最後一條訊息。這用於避免當設備恢復在線或變為活動狀態時發送太多相同的訊息。
無法保證訊息發送的順序。
在任何給定時間最多允許有四個不同的折疊鍵。這意味著 FCM 伺服器可以為每個客戶端應用程式同時儲存四個不同的發送同步訊息。如果超過此數量,則無法保證 FCM 伺服器將保留哪四個折疊鍵。
**預設值:** 無
簽名:
collapseKey?: string;
MessagingOptions.contentAvailable
在 iOS 上,使用此欄位表示 APNs 負載中content-available
。當發送通知或資料訊息且此項目設定為true
時,不活動的客戶端應用程式被喚醒。在 Android 上,預設情況下數據訊息會喚醒應用程式。在 Chrome 上,目前不支援此標誌。
**預設值:** false
簽名:
contentAvailable?: boolean;
訊息傳遞選項.dryRun
訊息是否應該實際發送。當設定為true
時,允許開發人員測試請求而無需實際發送訊息。當設定為false
時,訊息將被發送。
**預設值:** false
簽名:
dryRun?: boolean;
MessagingOptions.mutableContent
在 iOS 上,使用此欄位來表示 APNs 負載中的mutable-content
。當發送通知並將其設為true
時,可以使用通知服務應用程式擴充功能在顯示之前修改通知的內容。
在 Android 和 Web 上,此參數將被忽略。
**預設值:** false
簽名:
mutableContent?: boolean;
MessagingOptions.priority
訊息的優先順序。有效值為"normal"
和"high".
在 iOS 上,這些對應於 APN 優先權5
和10
。
預設情況下,通知訊息以高優先順序發送,資料訊息以普通優先權發送。正常優先順序可最佳化用戶端應用程式的電池消耗,除非需要立即交付,否則應使用正常優先順序。對於具有正常優先權的訊息,應用程式可能會以未指定的延遲接收訊息。
當以高優先權發送訊息時,它會立即發送,並且應用程式可以喚醒休眠的裝置並打開與伺服器的網路連線。
有關詳細信息,請參閱設定訊息優先級。
**預設值:** 通知訊息為"high"
,資料訊息為"normal"
簽名:
priority?: string;
MessagingOptions.restrictedPackageName
註冊令牌必須匹配的應用程式的包名稱才能接收訊息。
**預設值:** 無
簽名:
restrictedPackageName?: string;
MessagingOptions.timeToLive
如果設備離線,訊息應在 FCM 儲存中保留多長時間(以秒為單位)。支援的最長生存時間是四個星期,預設值也是四個星期。有關詳細信息,請參閱設定訊息的生命週期。
**預設值:** 2419200
(代表四個星期,單位為秒)
簽名:
timeToLive?: number;