代表可納入 AndroidConfig 的 Android 專屬通知選項。
簽名：
export interface AndroidNotification
屬性
| 屬性 | 類型 | 說明 |
|---|---|---|
| 內文 | 字串 | Android 通知的內文。如有提供，請透過 admin.messaging.Notification 覆寫主體設定。 |
| bodyLocArgs | string[] | 資源索引鍵陣列，用於取代 bodyLocKey 中的格式指定碼。 |
| bodyLocKey | 字串 | 應用程式字串資源中的主體字串鍵，用來本地化內文。 |
| channelId | 字串 | Android 通知管道 ID (Android O 新功能)。應用程式必須使用這個頻道 ID 建立頻道，才能接收與此頻道 ID 相關的通知。如果您未在要求中傳送這個頻道 ID，或是尚未建立應用程式提供的頻道 ID，FCM 會使用應用程式資訊清單中指定的頻道 ID。 |
| 點擊動作 | 字串 | 與使用者點擊通知相關的動作。如果有指定，系統就會在使用者點擊通知時啟動包含相符意圖篩選器的活動。 |
| 顏色 | 字串 | 通知圖示顏色 (#rrggbb 格式)。 |
| defaultLightSettings | 布林值 | 如果設為 true，請使用 Android 架構的預設 LED 燈設定通知。預設值是在 config.xml 中指定。如果將 default_light_settings 設為 true，且同時設定了 light_settings，系統會使用使用者指定的 light_settings，而非預設值。 |
| 預設音效 | 布林值 | 如果設為 true，請使用 Android 架構的預設通知音效。預設值是在 config.xml 中指定。 |
| 預設震動 | 布林值 | 如果設為 true，請使用 Android 架構的預設震動模式來傳送通知。預設值是在 config.xml 中指定。如果將 default_vibrate_timings 設為 true，且同時設定了 vibrate_timings，系統會使用預設值，而非使用者指定的 vibrate_timings。 |
| eventTimestamp | 日期 | 若通知會透過絕對時間參照通知使用者事件，請設定通知中事件發生的時間。面板中的通知會依時間排序。 |
| 圖示 | 字串 | Android 通知的圖示資源。 |
| imageUrl | 字串 | 通知中顯示的圖片網址。 |
| 燈具設定 | 燈具設定 | 設定：如果裝置有 LED 燈，則可控制通知的 LED 閃爍率和顏色。總閃爍時間是由 OS 控制。 |
| localOnly | 布林值 | 設定這則通知是否僅與目前的裝置相關。部分通知可橋接至其他裝置，以便顯示遠端顯示畫面，例如 Wear OS 手錶。可設定這項提示，讓系統不要橋接通知。請參閱 Wear OS 指南。 |
| notificationCount | 數字 | 設定這則通知代表的項目數量。針對支援徽章的啟動器可能會以徽章數量顯示。請參閱「NotificationBadge」。舉例來說，如果你只使用一則通知來代表多則新訊息，但想這裡計數代表新訊息總數，這項功能就非常實用。如果零或未指定，支援徽章的系統會使用預設值，也就是每次有新通知時，長按選單上顯示的數字遞增。 |
| 優先順序 | ('min' | 'low' | 'default' | 'high' | 'max') | 設定這則通知的相對優先順序。在某些情況下，使用者可能無法看到低優先順序通知。請注意，這個優先順序與 AndroidMessagePriority 不同。訊息傳送後，用戶端會處理這個優先順序。AndroidMessagePriority 是 FCM 概念，可控制訊息的傳送時間。 |
| 音效 | 字串 | 裝置收到通知時要播放的音效檔案名稱。 |
| 黏著度 | 布林值 | 如果設為 false 或未設定，則當使用者在面板中點選通知時，通知會自動關閉。如果設為 true，則即使使用者點選通知，通知仍會持續顯示。 |
| 代碼 | 字串 | 通知標記。這個 ID 用於取代通知導覽匣中現有的通知。如未指定，每個要求都會建立新通知。 |
| 貼圖 | 字串 | 設定「代號」傳送至無障礙服務的文字在 API 級別 21 (Lollipop) 之前，設定當通知首次收到時，狀態列中顯示的文字。 |
| title | 字串 | Android 通知的標題。如有提供，則會覆寫透過 admin.messaging.Notification 設定的標題。 |
| titleLocArgs | string[] | 資源索引鍵陣列，用於取代 titleLocKey 中的格式指定碼。 |
| titleLocKey | 字串 | 應用程式字串資源中標題字串的鍵，用來將標題文字本地化。 |
| vibrateTimingsMillis | 數字 [] | 設定要使用的震動模式。傳入毫秒陣列，即可開啟或關閉震動功能。第一個值表示開啟震動功能之前的等待時間。下一個值表示震動功能保持開啟的持續時間。後續的值會在指定時間間替換，以關閉震動功能及開啟震動功能。如果設定 vibrate_timings 且 default_vibrate_timings 設為 true，則會使用預設值，而非使用者指定的 vibrate_timings。 |
| 瀏覽權限 | ('私人' | '公開' | '秘密') | 設定通知的顯示設定。必須是 private、public 或 secret。如果未指定，則預設為 private。 |
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
與使用者點擊通知相關的動作。如果有指定，系統就會在使用者點擊通知時啟動包含相符意圖篩選器的活動。
簽名：
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.圖示
Android 通知的圖示資源。
簽名：
icon?: string;
AndroidNotification.imageUrl
通知中顯示的圖片網址。
簽名：
imageUrl?: string;
AndroidNotification.lightSettings
設定：如果裝置有 LED 燈，則可控制通知的 LED 閃爍率和顏色。總閃爍時間是由 OS 控制。
簽名：
lightSettings?: LightSettings;
AndroidNotification.localOnly
設定這則通知是否僅與目前的裝置相關。部分通知可橋接至其他裝置，以便顯示遠端顯示畫面，例如 Wear OS 手錶。可設定這項提示，讓系統不要橋接通知。請參閱 Wear OS 指南。
簽名：
localOnly?: boolean;
AndroidNotification.notificationCount
設定這則通知代表的項目數量。針對支援徽章的啟動器可能會以徽章數量顯示。請參閱「NotificationBadge」。舉例來說，如果你只使用一則通知來代表多則新訊息，但想這裡計數代表新訊息總數，這項功能就非常實用。如果零或未指定，支援徽章的系統會使用預設值，也就是每次有新通知時，長按選單上顯示的數字遞增。
簽名：
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
通知標記。這個 ID 用於取代通知導覽匣中現有的通知。如未指定，每個要求都會建立新通知。
簽名：
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');