Thể hiện các tùy chọn thông báo dành riêng cho Android có thể được đưa vào AndroidConfig .
Chữ ký:
export interface AndroidNotification
Của cải
| Tài sản | Kiểu | Sự miêu tả |
|---|---|---|
| thân hình | sợi dây | Nội dung của thông báo Android. Khi được cung cấp, hãy ghi đè bộ nội dung thông qua admin.messaging.Notification . |
| cơ thểLocArgs | sợi dây[] | Một mảng các khóa tài nguyên sẽ được sử dụng thay cho bộ xác định định dạng trong bodyLocKey . |
| bodyLocKey | sợi dây | Khóa của chuỗi nội dung trong tài nguyên chuỗi của ứng dụng dùng để bản địa hóa văn bản nội dung. |
| kênh ID | sợi dây | ID kênh thông báo Android (mới trong Android O). Ứng dụng phải tạo một kênh có ID kênh này trước khi có thể nhận được bất kỳ thông báo nào có ID kênh này. Nếu bạn không gửi ID kênh này trong yêu cầu hoặc nếu ID kênh đã cung cấp chưa được ứng dụng tạo thì FCM sẽ sử dụng ID kênh được chỉ định trong tệp kê khai ứng dụng. |
| nhấp chuộtHành động | sợi dây | Hành động liên quan đến việc người dùng nhấp 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ẽ được khởi chạy khi người dùng nhấp vào thông báo. |
| màu sắc | sợi dây | Màu biểu tượng thông báo ở định dạng #rrggbb . |
| mặc địnhLightSettings | boolean | Nếu được đặt thành true , hãy sử dụng cài đặt đèn LED mặc định của khung Android cho thông báo. Giá trị mặc định được chỉ định trong config.xml . Nếu default_light_settings được đặt thành true và light_settings cũng được đặt thì light_settings do người dùng chỉ định sẽ được sử dụng thay vì giá trị mặc định. |
| âm thanh mặc định | boolean | Nếu được đặt thành true , hãy sử dụng âm thanh mặc định của khung Android cho thông báo. Giá trị mặc định được chỉ định trong config.xml . |
| mặc địnhRungThời gian | boolean | Nếu được đặt thành true , hãy sử dụng kiểu rung mặc định của khung Android cho thông báo. Giá trị mặc định được chỉ định trong config.xml . Nếu default_vibrate_timings được đặt thành true và vibrate_timings cũng được đặt thì giá trị mặc định sẽ được sử dụng thay vì vibrate_timings do người dùng chỉ định. |
| sự kiệnDấu thời gian | Ngày | Đối với các thông báo thông báo cho người dùng về các sự kiện có tham chiếu thời gian tuyệt đối, hãy đặt thời gian xảy 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 | sợi dây | Tài nguyên biểu tượng cho thông báo Android. |
| URL hình ảnh | sợi dây | URL của hình ảnh sẽ được hiển thị trong thông báo. |
| cài đặt ánh sáng | Cài đặt ánh sáng | Cài đặt để kiểm soát tốc độ và màu sắc nhấp nháy của đèn LED thông báo nếu đèn LED có sẵn trên thiết bị. Tổng thời gian nhấp nháy được điều khiển bởi hệ điều hành. |
| Chỉ địa phương | boolean | Đặt xem thông báo này 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. Gợi ý này có thể được đặt để đề xuất thông báo này không được bắc cầu. Xem hướng dẫn về Wear OS . |
| thông báoĐếm | con số | Đặt số lượng mục mà thông báo này đại diện. Có thể được hiển thị dưới dạng số lượng huy hiệu cho Trình khởi chạy hỗ trợ huy hiệu. Xem Huy hiệu thông báo . Ví dụ: điều này có thể hữu ích nếu bạn chỉ sử dụng một thông báo để thể hiện nhiều thư mới nhưng bạn muốn số lượng ở đây thể hiện tổng số thư mới. Nếu không hoặc không được chỉ định, các hệ thống hỗ trợ huy hiệu sẽ sử dụng mặc định, tức là tăng số hiển thị trên menu nhấn và giữ mỗi khi có thông báo mới. |
| sự ưu tiên | ('min' | 'thấp' | 'mặc định' | 'cao' | 'tối đa') | Đặ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. Lưu ý mức độ ưu tiên này khác với AndroidMessagePriority . Mức độ ưu tiên này được khách hàng xử lý 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 | sợi dây | Tên file âm thanh sẽ phát khi thiết bị nhận được thông báo. |
| dính | boolean | Khi được đặt thành false hoặc không được đặt, thông báo sẽ tự động bị loại bỏ khi người dùng nhấp vào thông báo đó trong bảng điều khiển. Khi được đặ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 nó. |
| nhãn | sợi dây | Thẻ thông báo. Đây là mã định danh được sử 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. |
| máy đánh dấu | sợi dây | Đặt văn bản "mã đánh dấu" được gửi đến các dịch vụ trợ năng. Trước API cấp 21 (Lollipop), đặt văn bản được hiển thị trên thanh trạng thái khi có thông báo lần đầu tiên. |
| tiêu đề | sợi dây | Tiêu đề của thông báo Android. Khi được cung cấp, sẽ ghi đè tiêu đề được đặt qua admin.messaging.Notification . |
| tiêu đềLocArgs | sợi dây[] | Một mảng khóa tài nguyên sẽ được sử dụng thay cho bộ xác định định dạng trong titleLocKey . |
| tiêu đềLocKey | sợi dây | Khóa của chuỗi tiêu đề trong tài nguyên chuỗi của ứng dụng dùng để bản địa hóa văn bản tiêu đề. |
| rungTimingsMillis | con số[] | Đặt kiểu rung để sử dụng. Truyền một khoả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 thời lượng duy trì bộ rung. Các giá trị tiếp theo xen kẽ giữa thời lượng để tắt bộ rung và bật bộ rung. Nếu vibrate_timings được đặt và default_vibrate_timings được đặt thành true , thì giá trị mặc định sẽ được sử dụng thay vì vibrate_timings do người dùng chỉ định. |
| hiển thị | ('riêng tư' | 'công khai' | 'bí mật') | Đặt mức độ hiển thị của thông báo. Phải là private , public hoặc secret . Nếu không được chỉ định, mặc định là private . |
AndroidNotification.body
Nội dung của thông báo Android. Khi được cung cấp, sẽ ghi đè bộ nội dung thông qua admin.messaging.Notification .
Chữ ký:
body?: string;
AndroidNotification.bodyLocArgs
Một mảng các khóa tài nguyên sẽ được sử dụng thay cho bộ xác định định dạng trong bodyLocKey .
Chữ ký:
bodyLocArgs?: string[];
AndroidNotification.bodyLocKey
Khóa của chuỗi nội dung trong tài nguyên chuỗi của ứng dụng dùng để bản địa hóa văn bản nội dung.
Chữ ký:
bodyLocKey?: string;
AndroidNotification.channelId
ID kênh thông báo Android (mới trong Android O). Ứng dụng phải tạo một kênh có ID kênh này trước khi có thể nhận được bất kỳ thông báo nào có ID kênh này. Nếu bạn không gửi ID kênh này trong yêu cầu hoặc nếu ID kênh đã cung cấp chưa được ứng dụng tạo thì FCM sẽ sử dụng ID 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 việc người dùng nhấp 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ẽ được khởi 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 được đặt thành true , hãy sử dụng cài đặt đèn LED mặc định của khung Android cho thông báo. Giá trị mặc định được chỉ định trong config.xml . Nếu default_light_settings được đặt thành true và light_settings cũng được đặt thì light_settings do người dùng chỉ định sẽ được sử dụng thay vì giá trị mặc định.
Chữ ký:
defaultLightSettings?: boolean;
AndroidNotification.defaultSound
Nếu được đặt thành true , hãy sử dụng âm thanh mặc định của khung Android cho thông báo. Giá trị mặc định được chỉ định trong config.xml .
Chữ ký:
defaultSound?: boolean;
AndroidNotification.defaultVibrateTimings
Nếu được đặt thành true , hãy sử dụng kiểu rung mặc định của khung Android cho thông báo. Giá trị mặc định được chỉ định trong config.xml . Nếu default_vibrate_timings được đặt thành true và vibrate_timings cũng được đặt thì giá trị mặc định sẽ được sử dụng thay vì vibrate_timings do người dùng chỉ định .
Chữ ký:
defaultVibrateTimings?: boolean;
AndroidNotification.eventTimestamp
Đối với các thông báo thông báo cho người dùng về các sự kiện có tham chiếu thời gian tuyệt đối, hãy đặt thời gian xảy 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 Android.
Chữ ký:
icon?: string;
AndroidNotification.imageUrl
URL của hình ảnh sẽ được hiển thị trong thông báo.
Chữ ký:
imageUrl?: string;
AndroidNotification.lightSettings
Cài đặt để kiểm soát tốc độ và màu sắc nhấp nháy của đèn LED thông báo nếu đèn LED có sẵn trên thiết bị. Tổng thời gian nhấp nháy được điều khiển bởi hệ điều hành.
Chữ ký:
lightSettings?: LightSettings;
AndroidNotification.localOnly
Đặt xem thông báo này 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. Gợi ý này có thể được đặt để đề xuất thông báo này không được bắc cầu. 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ể được hiển thị dưới dạng số lượng huy hiệu cho Trình khởi chạy hỗ trợ huy hiệu. Xem Huy hiệu thông báo . Ví dụ: điều này có thể hữu ích nếu bạn chỉ sử dụng một thông báo để thể hiện nhiều thư mới nhưng bạn muốn số lượng ở đây thể hiện tổng số thư mới. Nếu không hoặc không được chỉ định, các hệ thống hỗ trợ huy hiệu sẽ sử dụng mặc định, tức là tăng số hiển thị trên menu 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. Lưu ý mức độ ưu tiên này khác với AndroidMessagePriority . Mức độ ưu tiên này được khách hàng xử lý 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 file âm thanh sẽ phát khi thiết bị nhận được thông báo.
Chữ ký:
sound?: string;
AndroidNotification.sticky
Khi được đặt thành false hoặc không được đặt, thông báo sẽ tự động bị loại bỏ khi người dùng nhấp vào thông báo đó trong bảng điều khiển. Khi được đặ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 nó.
Chữ ký:
sticky?: boolean;
AndroidNotification.tag
Thẻ thông báo. Đây là mã định danh được sử 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.ticker
Đặt văn bản "mã đánh dấu" được gửi đến các dịch vụ trợ năng. Trước API cấp 21 (Lollipop), đặt văn bản được hiển thị trên thanh trạng thái khi có thông báo lần đầu tiên.
Chữ ký:
ticker?: string;
AndroidNotification.title
Tiêu đề của thông báo 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 các khóa tài nguyên sẽ được sử dụng thay cho bộ xác định định dạng trong titleLocKey .
Chữ ký:
titleLocArgs?: string[];
AndroidNotification.titleLocKey
Khóa của chuỗi tiêu đề trong tài nguyên chuỗi của ứng dụng dùng để bản địa hóa văn bản tiêu đề.
Chữ ký:
titleLocKey?: string;
AndroidNotification.vibrateTimingsMillis
Đặt kiểu rung để sử dụng. Truyền một khoả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 thời lượng duy trì bộ rung. Các giá trị tiếp theo xen kẽ giữa thời lượng để tắt bộ rung và bật bộ rung. Nếu vibrate_timings được đặt và default_vibrate_timings được đặt thành true , giá trị mặc định được sử dụng thay vì vibrate_timings do người dùng chỉ định .
Chữ ký:
vibrateTimingsMillis?: number[];
AndroidNotification.visibility
Đặt mức độ hiển thị của thông báo. Phải là private , public , hoặc secret . Nếu không được chỉ định, mặc định là private .
Chữ ký:
visibility?: ('private' | 'public' | 'secret');