Biểu thị các tuỳ chọn thông báo dành riêng cho Android có thể đưa vào AndroidConfig.
Chữ ký:
export interface AndroidNotification
Thuộc tính
| Tài sản | Loại | Mô tả |
|---|---|---|
| phần thân | chuỗi | Nội dung của thông báo trên Android. Khi được cung cấp, hãy ghi đè phần nội dung được đặt qua admin.messaging.Notification. |
| bodyLocArgs | chuỗi[] | Một mảng khoá tài nguyên sẽ được dùng thay cho thông số định dạng trong bodyLocKey. |
| bodyLocKey | chuỗi | Khoá của chuỗi nội dung trong tài nguyên chuỗi của ứng dụng dùng để bản địa hoá văn bản nội dung. |
| mã nhận dạng kênh | chuỗi | Mã nhận dạng kênh thông báo trên Android (mới trong Android O). Ứng dụng phải tạo một kênh bằng mã nhận dạng kênh này thì mới có thể nhận được bất kỳ thông báo nào có mã nhận dạng kênh này. Nếu bạn không gửi mã nhận dạng kênh này trong yêu cầu hoặc nếu ứng dụng chưa tạo mã nhận dạng kênh được cung cấp, thì FCM sẽ sử dụng mã nhận dạng kênh được chỉ định trong tệp kê khai ứng dụng. |
| clickAction | chuỗi | Hành động liên quan đến lượt nhấp của người dùng vào thông báo. Nếu được chỉ định, một hoạt động có Bộ lọc ý định phù hợp sẽ chạy khi người dùng nhấp vào thông báo. |
| màu sắc | chuỗi | Màu biểu tượng thông báo ở định dạng #rrggbb. |
| defaultLightSettings | boolean | Nếu bạn đặt thành true, hãy dùng chế độ cài đặt đèn LED mặc định của khung Android cho thông báo. Các giá trị mặc định được chỉ định trong config.xml. Nếu bạn đặt default_light_settings thành true và light_settings cũng được thiết lập, thì light_settings do người dùng chỉ định sẽ được dùng thay cho giá trị mặc định. |
| defaultÂm thanh | boolean | Nếu bạn đặt chính sách này thành true, hãy dùng âm thanh mặc định của khung Android cho thông báo. Các giá trị mặc định được chỉ định trong config.xml. |
| defaultRungTimings | boolean | Nếu bạn đặt thành true, hãy sử dụng mẫu rung mặc định của khung Android cho thông báo. Các giá trị mặc định được chỉ định trong config.xml. Nếu bạn đặt default_vibrate_timings thành true và cũng đặt vibrate_timings, thì giá trị mặc định sẽ được sử dụng thay cho vibrate_timings do người dùng chỉ định. |
| eventTimestamp | Ngày | Đối với các thông báo cho người dùng biết về các sự kiện có tham chiếu thời gian tuyệt đối, hãy đặt thời gian diễn ra sự kiện trong thông báo. Thông báo trong bảng điều khiển được sắp xếp theo thời gian này. |
| biểu tượng | chuỗi | Tài nguyên biểu tượng cho thông báo trên Android. |
| imageUrl | chuỗi | URL của hình ảnh sẽ hiển thị trong thông báo. |
| lightSettings | LightSettings (Cài đặt đèn) | Các chế độ cài đặt để kiểm soát màu và tốc độ nhấp nháy đèn LED của thông báo nếu thiết bị có đèn LED. Tổng thời gian nhấp nháy do hệ điều hành kiểm soát. |
| localOnly | boolean | Thiết lập xem thông báo này có chỉ liên quan đến thiết bị hiện tại hay không. Một số thông báo có thể được kết nối với các thiết bị khác để hiển thị từ xa, chẳng hạn như đồng hồ Wear OS. Bạn có thể đặt gợi ý này để đề xuất không nên bắc cầu thông báo này. Xem Hướng dẫn về Wear OS. |
| notificationCount | số | Đặt số lượng mục mà thông báo này đại diện. Có thể hiển thị dưới dạng số lượng huy hiệu đối với các Trình chạy có hỗ trợ huy hiệu. Hãy xem phần NotificationHuy (Thông báo). Ví dụ: điều này có thể hữu ích nếu bạn đang sử dụng chỉ một thông báo để thể hiện nhiều thư mới nhưng lại muốn số lượng ở đây thể hiện tổng số thư mới. Nếu bằng 0 hoặc chưa được chỉ định, các hệ thống hỗ trợ huy hiệu sẽ sử dụng chế độ mặc định, tức là tăng một số hiển thị trên trình đơn nhấn và giữ mỗi khi có thông báo mới. |
| mức độ ưu tiên | ('min' | 'low' | 'default' | 'high' | 'max') | Đặt mức độ ưu tiên tương đối cho thông báo này. Thông báo có mức độ ưu tiên thấp có thể bị ẩn khỏi người dùng trong một số trường hợp nhất định. Xin lưu ý rằng mức độ ưu tiên này khác với AndroidMessagePriority. Ứng dụng sẽ xử lý mức độ ưu tiên này sau khi tin nhắn được gửi. Trong khi đó, AndroidMessagePriority là một khái niệm FCM kiểm soát thời điểm gửi tin nhắn. |
| âm thanh | chuỗi | Tên tệp của âm thanh sẽ được phát khi thiết bị nhận được thông báo. |
| hấp dẫn | boolean | Nếu bạn đặt chính sách này thành false hoặc không đặt, thông báo sẽ tự động bị đóng khi người dùng nhấp vào thông báo trong bảng điều khiển. Khi bạn đặt thành true, thông báo vẫn tồn tại ngay cả khi người dùng nhấp vào thông báo đó. |
| thẻ | chuỗi | Thẻ thông báo. Đây là giá trị nhận dạng dùng để thay thế các thông báo hiện có trong ngăn thông báo. Nếu không được chỉ định, mỗi yêu cầu sẽ tạo một thông báo mới. |
| đầu cuộc trò chuyện | chuỗi | Đặt "biểu ngữ" văn bản, được gửi đến dịch vụ hỗ trợ tiếp cận. Trước API cấp 21 (Lollipop), thiết lập văn bản được hiển thị trên thanh trạng thái khi thông báo xuất hiện lần đầu. |
| tiêu đề | chuỗi | Tiêu đề của thông báo trên Android. Khi được cung cấp, hãy ghi đè tiêu đề được đặt qua admin.messaging.Notification. |
| titleLocArgs | chuỗi[] | Một mảng khoá tài nguyên sẽ được dùng thay cho thông số định dạng trong titleLocKey. |
| titleLocKey | chuỗi | Khoá của chuỗi tiêu đề trong tài nguyên chuỗi của ứng dụng dùng để bản địa hoá văn bản tiêu đề. |
| vibrateTimingsMillis | số[] | Đặt mẫu rung để sử dụng. Truyền một mảng mili giây để bật hoặc tắt bộ rung. Giá trị đầu tiên cho biết khoảng thời gian chờ trước khi bật bộ rung. Giá trị tiếp theo cho biết khoảng thời gian duy trì bộ rung. Các giá trị tiếp theo sẽ thay đổi khoảng thời gian để tắt bộ rung và bật bộ rung. Nếu bạn đặt vibrate_timings và đặt default_vibrate_timings thành true, thì giá trị mặc định sẽ được sử dụng thay cho vibrate_timings do người dùng chỉ định. |
| khả năng hiển thị | ("riêng tư" | "công khai" | "bí mật") | Đặt chế độ hiển thị của thông báo. Phải là private, public hoặc secret. Nếu bạn không chỉ định, giá trị mặc định sẽ là private. |
AndroidNotification.body
Nội dung của thông báo trên Android. Khi được cung cấp, hãy ghi đè phần nội dung được đặt qua admin.messaging.Notification.
Chữ ký:
body?: string;
AndroidNotification.bodyLocArgs
Một mảng khoá tài nguyên sẽ được dùng thay cho thông số định dạng trong bodyLocKey.
Chữ ký:
bodyLocArgs?: string[];
AndroidNotification.bodyLocKey
Khoá của chuỗi nội dung trong tài nguyên chuỗi của ứng dụng dùng để bản địa hoá văn bản nội dung.
Chữ ký:
bodyLocKey?: string;
AndroidNotification.channelId
Mã nhận dạng kênh thông báo trên Android (mới trong Android O). Ứng dụng phải tạo một kênh bằng mã nhận dạng kênh này thì mới có thể nhận được bất kỳ thông báo nào có mã nhận dạng kênh này. Nếu bạn không gửi mã nhận dạng kênh này trong yêu cầu hoặc nếu ứng dụng chưa tạo mã nhận dạng kênh được cung cấp, thì FCM sẽ sử dụng mã nhận dạng kênh được chỉ định trong tệp kê khai ứng dụng.
Chữ ký:
channelId?: string;
AndroidNotification.clickAction
Hành động liên quan đến lượt nhấp của người dùng vào thông báo. Nếu được chỉ định, một hoạt động có Bộ lọc ý định phù hợp sẽ chạy khi người dùng nhấp vào thông báo.
Chữ ký:
clickAction?: string;
AndroidNotification.color
Màu biểu tượng thông báo ở định dạng #rrggbb.
Chữ ký:
color?: string;
AndroidNotification.defaultLightSettings
Nếu bạn đặt thành true, hãy dùng chế độ cài đặt đèn LED mặc định của khung Android cho thông báo. Các giá trị mặc định được chỉ định trong config.xml. Nếu bạn đặt default_light_settings thành true và light_settings cũng được thiết lập, thì light_settings do người dùng chỉ định sẽ được dùng thay cho giá trị mặc định.
Chữ ký:
defaultLightSettings?: boolean;
AndroidNotification.defaultÂm thanh
Nếu bạn đặt chính sách này thành true, hãy dùng âm thanh mặc định của khung Android cho thông báo. Các giá trị mặc định được chỉ định trong config.xml.
Chữ ký:
defaultSound?: boolean;
AndroidNotification.defaultRungTimings
Nếu bạn đặt thành true, hãy sử dụng mẫu rung mặc định của khung Android cho thông báo. Các giá trị mặc định được chỉ định trong config.xml. Nếu bạn đặt default_vibrate_timings thành true và cũng đặt vibrate_timings, thì giá trị mặc định sẽ được sử dụng thay cho vibrate_timings do người dùng chỉ định.
Chữ ký:
defaultVibrateTimings?: boolean;
AndroidNotification.eventTimestamp
Đối với các thông báo cho người dùng biết về các sự kiện có tham chiếu thời gian tuyệt đối, hãy đặt thời gian diễn ra sự kiện trong thông báo. Thông báo trong bảng điều khiển được sắp xếp theo thời gian này.
Chữ ký:
eventTimestamp?: Date;
AndroidNotification.icon
Tài nguyên biểu tượng cho thông báo trên Android.
Chữ ký:
icon?: string;
AndroidNotification.imageUrl
URL của hình ảnh sẽ hiển thị trong thông báo.
Chữ ký:
imageUrl?: string;
AndroidNotification.lightSettings
Các chế độ cài đặt để kiểm soát màu và tốc độ nhấp nháy đèn LED của thông báo nếu thiết bị có đèn LED. Tổng thời gian nhấp nháy do hệ điều hành kiểm soát.
Chữ ký:
lightSettings?: LightSettings;
AndroidNotification.localOnly
Thiết lập xem thông báo này có chỉ liên quan đến thiết bị hiện tại hay không. Một số thông báo có thể được kết nối với các thiết bị khác để hiển thị từ xa, chẳng hạn như đồng hồ Wear OS. Bạn có thể đặt gợi ý này để đề xuất không nên bắc cầu thông báo này. Xem Hướng dẫn về Wear OS.
Chữ ký:
localOnly?: boolean;
AndroidNotification.notificationCount
Đặt số lượng mục mà thông báo này đại diện. Có thể hiển thị dưới dạng số lượng huy hiệu đối với các Trình chạy có hỗ trợ huy hiệu. Hãy xem phần NotificationHuy (Thông báo). Ví dụ: điều này có thể hữu ích nếu bạn đang sử dụng chỉ một thông báo để thể hiện nhiều thư mới nhưng lại muốn số lượng ở đây thể hiện tổng số thư mới. Nếu bằng 0 hoặc chưa được chỉ định, các hệ thống hỗ trợ huy hiệu sẽ sử dụng chế độ mặc định, tức là tăng một số hiển thị trên trình đơn nhấn và giữ mỗi khi có thông báo mới.
Chữ ký:
notificationCount?: number;
AndroidNotification.Priority
Đặt mức độ ưu tiên tương đối cho thông báo này. Thông báo có mức độ ưu tiên thấp có thể bị ẩn khỏi người dùng trong một số trường hợp nhất định. Xin lưu ý rằng mức độ ưu tiên này khác với AndroidMessagePriority. Ứng dụng sẽ xử lý mức độ ưu tiên này sau khi tin nhắn được gửi. Trong khi đó, AndroidMessagePriority là một khái niệm FCM kiểm soát thời điểm gửi tin nhắn.
Chữ ký:
priority?: ('min' | 'low' | 'default' | 'high' | 'max');
AndroidNotification.sound
Tên tệp của âm thanh sẽ được phát khi thiết bị nhận được thông báo.
Chữ ký:
sound?: string;
AndroidNotification.sticky
Nếu bạn đặt chính sách này thành false hoặc không đặt, thông báo sẽ tự động bị đóng khi người dùng nhấp vào thông báo trong bảng điều khiển. Khi bạn đặt thành true, thông báo vẫn tồn tại ngay cả khi người dùng nhấp vào thông báo đó.
Chữ ký:
sticky?: boolean;
AndroidNotification.tag
Thẻ thông báo. Đây là giá trị nhận dạng dùng để thay thế các thông báo hiện có trong ngăn thông báo. Nếu không được chỉ định, mỗi yêu cầu sẽ tạo một thông báo mới.
Chữ ký:
tag?: string;
AndroidNotification.trace
Đặt "biểu ngữ" văn bản, được gửi đến dịch vụ hỗ trợ tiếp cận. Trước API cấp 21 (Lollipop), thiết lập văn bản được hiển thị trên thanh trạng thái khi thông báo xuất hiện lần đầu.
Chữ ký:
ticker?: string;
Tiêu đề AndroidNotification.title
Tiêu đề của thông báo trên Android. Khi được cung cấp, hãy ghi đè tiêu đề được đặt qua admin.messaging.Notification.
Chữ ký:
title?: string;
AndroidNotification.titleLocArgs
Một mảng khoá tài nguyên sẽ được dùng thay cho thông số định dạng trong titleLocKey.
Chữ ký:
titleLocArgs?: string[];
AndroidNotification.titleLocKey
Khoá của chuỗi tiêu đề trong tài nguyên chuỗi của ứng dụng dùng để bản địa hoá văn bản tiêu đề.
Chữ ký:
titleLocKey?: string;
AndroidNotification.vibrateTimingsMillis
Đặt mẫu rung để sử dụng. Truyền một mảng mili giây để bật hoặc tắt bộ rung. Giá trị đầu tiên cho biết khoảng thời gian chờ trước khi bật bộ rung. Giá trị tiếp theo cho biết khoảng thời gian duy trì bộ rung. Các giá trị tiếp theo sẽ thay đổi khoảng thời gian để tắt bộ rung và bật bộ rung. Nếu bạn đặt vibrate_timings và đặt default_vibrate_timings thành true, thì giá trị mặc định sẽ được sử dụng thay cho vibrate_timings do người dùng chỉ định.
Chữ ký:
vibrateTimingsMillis?: number[];
AndroidNotification.visibility
Đặt chế độ hiển thị của thông báo. Phải là private, public hoặc secret. Nếu bạn không chỉ định, chế độ mặc định sẽ là private.
Chữ ký:
visibility?: ('private' | 'public' | 'secret');