AndroidNotification interface

表示可以包含在AndroidConfig中的 Android 特定通知選項。

簽名：

export interface AndroidNotification 

特性

AndroidNotification.body

Android 通知的正文。提供後，覆蓋透過admin.messaging.Notification設定的正文。

簽名：

body?: string;

AndroidNotification.bodyLocArgs

將用於取代bodyLocKey中的格式說明符的資源鍵數組。

簽名：

bodyLocArgs?: string[];

AndroidNotification.bodyLocKey

應用程式字串資源中正文字串的鍵，用於本地化正文文字。

簽名：

bodyLocKey?: string;

AndroidNotification.channelId

Android 通知頻道 ID（Android O 中的新增功能）。應用程式必須先建立具有此通道 ID 的通道，然後才能接收具有此通道 ID 的任何通知。如果您未在請求中傳送此通道 ID，或套用尚未建立提供的通道 ID，則 FCM 將使用應用程式清單中指定的通道 ID。

簽名：

channelId?: string;

AndroidNotification.clickAction

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

簽名：

clickAction?: string;

AndroidNotification.color

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

簽名：

color?: string;

AndroidNotification.defaultLightSettings

如果設定為true ，使用 Android 框架的預設 LED 燈設定進行通知。預設值在config.xml中指定。如果default_light_settings設定為true且light_settings也被設置，則使用使用者指定的light_settings而不是預設值。

簽名：

defaultLightSettings?: boolean;

AndroidNotification.defaultSound

如果設定為true ，使用Android框架的預設聲音進行通知。預設值在config.xml中指定。

簽名：

defaultSound?: boolean;

AndroidNotification.defaultVibrateTimings

如果設定為true ，使用 Android 框架的預設振動模式進行通知。預設值在config.xml中指定。如果default_vibrate_timings設定為true並且vibrate_timings也被設置，則使用預設值而不是使用者指定的vibrate_timings 。

簽名：

defaultVibrateTimings?: boolean;

AndroidNotification.eventTimestamp

對於透過絕對時間參考向使用者通知事件的通知，設定通知中事件發生的時間。面板中的通知按時間排序。

簽名：

eventTimestamp?: Date;

AndroidNotification.icon

Android 通知的圖示資源。

簽名：

icon?: string;

AndroidNotification.imageUrl

要在通知中顯示的圖像的 URL。

簽名：

imageUrl?: string;

AndroidNotification.lightSettings

用於控制通知的 LED 閃爍頻率和顏色（如果設備上有 LED）的設定。總閃爍時間由作業系統控制。

簽名：

lightSettings?: LightSettings;

AndroidNotification.localOnly

設定此通知是否僅與目前設備相關。某些通知可以橋接到其他裝置以進行遠端顯示，例如 Wear OS 手錶。可以設定此提示以建議不要橋接此通知。請參閱Wear OS 指南。

簽名：

localOnly?: boolean;

AndroidNotification.notificationCount

設定此通知代表的項目數。對於支援徽章的啟動器，可能會顯示為徽章計數。請參閱通知徽章。例如，如果您僅使用一個通知來表示多個新訊息，但您希望此處的計數表示新訊息總數，則這可能會很有用。如果為零或未指定，支援徽章的系統將使用預設值，即每次新通知到達時增加長按選單上顯示的數字。

簽名：

notificationCount?: number;

AndroidNotification.priority

設定此通知的相對優先順序。在某些情況下，低優先權通知可​​能會對使用者隱藏。請注意，此優先權與AndroidMessagePriority不同。此優先順序由客戶端在訊息傳送後處理。而AndroidMessagePriority是一個 FCM 概念，用來控制訊息的傳遞時間。

簽名：

priority?: ('min' | 'low' | 'default' | 'high' | 'max');

AndroidNotification.sound

裝置收到通知時播放的聲音的檔案名稱。

簽名：

sound?: string;

AndroidNotification.sticky

當設定為false或未設定時，當使用者在面板中按一下通知時，通知將自動關閉。當設定為true時，即使使用者點擊通知，通知仍然存在。

簽名：

sticky?: boolean;

AndroidNotification.tag

通知標籤。這是用於替換通知抽屜中現有通知的標識符。如果未指定，每個請求都會建立一個新通知。

簽名：

tag?: string;

AndroidNotification.ticker

設定發送到輔助服務的“股票代碼”文字。在 API 等級 21 (Lollipop) 之前，設定通知首次到達時狀態列中顯示的文字。

簽名：

ticker?: string;

AndroidNotification.title

Android 通知的標題。提供後，覆蓋透過admin.messaging.Notification設定的標題。

簽名：

title?: string;

AndroidNotification.titleLocArgs

將用於取代titleLocKey中的格式說明符的資源鍵數組。

簽名：

titleLocArgs?: string[];

AndroidNotification.titleLocKey

應用程式字串資源中標題字串的鍵，用於本地化標題文字。

簽名：

titleLocKey?: string;

AndroidNotification.vibrateTimingsMillis

設定要使用的振動模式。傳遞一個毫秒數組來打開或關閉振動器。第一個值表示打開振動器之前等待的持續時間。下一個值表示保持振動器打開的持續時間。隨後的值在關閉振動器和打開振動器的持續時間之間交替。如果設定了vibrate_timings並且default_vibrate_timings設定為true ，使用預設值代替使用者指定的vibrate_timings 。

簽名：

vibrateTimingsMillis?: number[];

AndroidNotification.visibility

設定通知的可見性。必須是private ， public ，或secret 。如果未指定，則預設為private 。

簽名：

visibility?: ('private' | 'public' | 'secret');