NotificationMessagePayload interface

表示 FCM 舊版 API 通知訊息負載的介面。通知訊息允許開發人員發送最多 4KB 的預定義鍵值對。接受的密鑰概述如下。

請參閱建置傳送請求以取得程式碼範例和詳細文件。

簽名:

export interface NotificationMessagePayload 

特性

財產類型描述
徽章細繩主螢幕應用程式圖示上的徽章的值。如果未指定,則不會變更徽章。如果設定為0 ,則徽章將被刪除。 **平台:** iOS
身體細繩通知的正文。 **平台:** iOS、Android、Web
身體定位參數細繩用於取代body_loc_key中的格式說明符的變數字串值,用於將正文文字本地化為使用者目前的本地化。該值應該是字串化的 JSON 陣列。 **iOS:** 對應於 APNs 負載中的loc-args 。有關更多信息,請參閱有效負載密鑰參考本地化遠端通知的內容 **Android:** 請參閱格式和樣式以取得更多資訊。 **平台:** iOS、Android
身體鎖匙細繩應用程式字串資源中正文字串的鍵,用於將正文文字本地化為使用者目前的本地化。 **iOS:** 對應於 APNs 負載中的loc-key 。有關更多信息,請參閱有效負載密鑰參考本地化遠端通知的內容 **Android:** 請參閱字串資源以取得更多資訊。 **平台:** iOS、Android
點擊動作細繩與使用者點擊通知相關的操作。如果指定,當使用者按一下通知時,將啟動具有符合 Intent Filter 的活動。 * **平台:** Android
顏色細繩通知圖示的顏色,以#rrggbb格式表示。 **平台:** Android
圖示細繩通知的圖示。 **Android:** 將可繪製資源myicon的通知圖示設定為myicon 。如果您不在請求中傳送此金鑰,FCM 將顯示應用程式清單中指定的啟動器圖示。 **Web:** 用於通知圖示的 URL。 **平台:** Android、Web
聲音細繩設備收到通知時播放的聲音。支援裝置預設通知聲音或應用程式中捆綁的聲音資源的檔案名稱「預設」。聲音檔案必須位於/res/raw/中。 **平台:** Android
標籤細繩用於替換通知抽屜中現有通知的標識符。如果未指定,每個請求都會建立一個新通知。如果指定並且已顯示具有相同標籤的通知,則新通知將取代通知抽屜中的現有通知。 **平台:** Android
標題細繩通知的標題。 **平台:** iOS、Android、Web
標題定位參數細繩用於取代title_loc_key中的格式說明符的變數字串值,用於將標題文字本地化為使用者目前的本地化。該值應該是字串化的 JSON 陣列。 **iOS:** 對應於 APNs 負載中的title-loc-args 。有關更多信息,請參閱有效負載密鑰參考本地化遠端通知的內容 **Android:** 請參閱格式和樣式以取得更多資訊。 **平台:** iOS、Android
標題鎖鍵細繩應用程式字串資源中標題字串的鍵,用於將標題文字本地化為使用者目前的本地化版本。 **iOS:** 對應於 APNs 負載中的title-loc-key 。有關更多信息,請參閱有效負載密鑰參考本地化遠端通知的內容 **Android:** 請參閱字串資源以取得更多資訊。 **平台:** iOS、Android

通知訊息有效負載.badge

主螢幕應用程式圖示上的徽章的值。

如果未指定,則不會變更徽章。

如果設定為0 ,徽章被移除。

**平台:** iOS

簽名:

badge?: string;

通知訊息有效負載.body

通知的正文。

**平台:** iOS、Android、Web

簽名:

body?: string;

通知訊息負載.bodyLocArgs

用於取代body_loc_key中的格式說明符的變數字串值,用於將正文文字本地化為使用者目前的本地化。

該值應該是字串化的 JSON 陣列。

**iOS:** 對應於 APNs 負載中的loc-args 。有關更多信息,請參閱有效負載密鑰參考本地化遠端通知的內容

**Android:** 請參閱格式和樣式以取得更多資訊。

**平台:** iOS、Android

簽名:

bodyLocArgs?: string;

通知訊息有效負載.bodyLocKey

應用程式字串資源中正文字串的鍵,用於將正文文字本地化為使用者目前的本地化。

**iOS:** 對應於 APNs 負載中的loc-key 。有關更多信息,請參閱有效負載密鑰參考本地化遠端通知的內容

**Android:** 請參閱字串資源以取得更多資訊。

**平台:** iOS、Android

簽名:

bodyLocKey?: string;

通知訊息有效負載.clickAction

與使用者點擊通知相關的操作。如果指定,當使用者按一下通知時,將啟動具有符合 Intent Filter 的活動。

* **平台:** Android

簽名:

clickAction?: string;

通知訊息有效負載.color

通知圖示的顏色,以#rrggbb格式表示。

**平台:** Android

簽名:

color?: string;

通知訊息有效負載.icon

通知的圖示。

**Android:** 將可繪製資源myicon的通知圖示設定為myicon 。如果您不在請求中傳送此金鑰,FCM 將顯示應用程式清單中指定的啟動器圖示。

**Web:** 用於通知圖示的 URL。

**平台:** Android、Web

簽名:

icon?: string;

通知訊息有效負載.聲音

設備收到通知時播放的聲音。支援裝置預設通知聲音或應用程式中捆綁的聲音資源的檔案名稱「預設」。聲音檔案必須位於/res/raw/

**平台:** Android

簽名:

sound?: string;

通知訊息有效負載.tag

用於替換通知抽屜中現有通知的標識符。

如果未指定,每個請求都會建立一個新通知。

如果指定並且已顯示具有相同標籤的通知,則新通知將取代通知抽屜中的現有通知。

**平台:** Android

簽名:

tag?: string;

通知訊息有效負載.title

通知的標題。

**平台:** iOS、Android、Web

簽名:

title?: string;

NotificationMessagePayload.titleLocArgs

用於取代title_loc_key中的格式說明符的變數字串值,用於將標題文字本地化為使用者目前的本地化。

該值應該是字串化的 JSON 陣列。

**iOS:** 對應於 APNs 負載中的title-loc-args 。有關更多信息,請參閱有效負載密鑰參考本地化遠端通知的內容

**Android:** 請參閱格式和樣式以取得更多資訊。

**平台:** iOS、Android

簽名:

titleLocArgs?: string;

通知訊息有效負載.titleLocKey

應用程式字串資源中標題字串的鍵,用於將標題文字本地化為使用者目前的本地化版本。

**iOS:** 對應於 APNs 負載中的title-loc-key 。有關更多信息,請參閱有效負載密鑰參考本地化遠端通知的內容

**Android:** 請參閱字串資源以取得更多資訊。

**平台:** iOS、Android

簽名:

titleLocKey?: string;