NotificationMessagePayload interface

Giao diện thể hiện tải trọng tin nhắn thông báo API kế thừa FCM. Tin nhắn thông báo cho phép nhà phát triển gửi tối đa 4KB cặp khóa-giá trị được xác định trước. Các khóa được chấp nhận được nêu dưới đây.

Xem Xây dựng gửi yêu cầu mẫu mã và tài liệu chi tiết.

Chữ ký:

export interface NotificationMessagePayload 

Của cải

Tài sản Kiểu Sự miêu tả
huy hiệu sợi dây Giá trị của huy hiệu trên biểu tượng ứng dụng màn hình chính. Nếu không được chỉ định, huy hiệu sẽ không được thay đổi. Nếu được đặt thành 0 , huy hiệu sẽ bị xóa. **Nền tảng:** iOS
thân hình sợi dây Nội dung của thông báo. **Nền tảng:** iOS, Android, Web
cơ thểLocArgs sợi dây Các giá trị chuỗi biến đổi được sử dụng thay cho bộ xác định định dạng trong body_loc_key để bản địa hóa nội dung văn bản sang bản địa hóa hiện tại của người dùng. Giá trị phải là một mảng JSON được xâu chuỗi. **iOS:** Tương ứng với loc-args trong tải trọng APN. Xem Tham khảo khóa tải trọngbản địa hóa nội dung thông báo từ xa của bạn để biết thêm thông tin. **Android:** Xem Định dạng và Tạo kiểu để biết thêm thông tin. **Nền tảng:** iOS, Android
bodyLocKey sợi dây Khóa cho chuỗi nội dung trong tài nguyên chuỗi của ứng dụng sẽ được sử dụng để bản địa hóa văn bản nội dung theo bản địa hóa hiện tại của người dùng. **iOS:** Tương ứng với loc-key trong tải trọng APN. Xem Tham khảo khóa tải trọngbản địa hóa nội dung thông báo từ xa của bạn để biết thêm thông tin. **Android:** Xem Tài nguyên chuỗi để biết thêm thông tin. **Nền tảng:** iOS, Android
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. * **Nền tảng:** Android
màu sắc sợi dây Màu của biểu tượng thông báo, được biểu thị ở định dạng #rrggbb . **Nền tảng:** Android
biểu tượng sợi dây Biểu tượng của thông báo **Android:** Đặt biểu tượng thông báo thành myicon cho tài nguyên có thể vẽ myicon . Nếu bạn không gửi khóa này trong yêu cầu, FCM sẽ hiển thị biểu tượng trình khởi chạy được chỉ định trong bảng kê khai ứng dụng của bạn. **Web:** URL sử dụng cho biểu tượng thông báo. **Nền tảng:** Android, Web
âm thanh sợi dây Âm thanh phát ra khi thiết bị nhận được thông báo. Hỗ trợ "mặc định" cho âm thanh thông báo mặc định của thiết bị hoặc tên tệp của tài nguyên âm thanh được gói trong ứng dụng. Các tệp âm thanh phải nằm trong /res/raw/ . **Nền tảng:** Android
nhãn sợi dây 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. Nếu được chỉ định và thông báo có cùng thẻ đã được hiển thị thì thông báo mới sẽ thay thế thông báo hiện có trong ngăn thông báo. **Nền tảng:** Android
tiêu đề sợi dây Tiêu đề của thông báo. **Nền tảng:** iOS, Android, Web
tiêu đềLocArgs sợi dây Các giá trị chuỗi biến đổi được sử dụng thay cho bộ xác định định dạng trong title_loc_key để bản địa hóa văn bản tiêu đề sang bản địa hóa hiện tại của người dùng. Giá trị phải là một mảng JSON được xâu chuỗi. **iOS:** Tương ứng với title-loc-args trong tải trọng APN. Xem Tham khảo khóa tải trọngbản địa hóa nội dung thông báo từ xa của bạn để biết thêm thông tin. **Android:** Xem Định dạng và Tạo kiểu để biết thêm thông tin. **Nền tảng:** iOS, Android
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 sẽ được sử dụng để bản địa hóa văn bản tiêu đề theo bản địa hóa hiện tại của người dùng. **iOS:** Tương ứng với title-loc-key trong tải trọng APN. Xem Tham khảo khóa tải trọngbản địa hóa nội dung thông báo từ xa của bạn để biết thêm thông tin. **Android:** Xem Tài nguyên chuỗi để biết thêm thông tin. **Nền tảng:** iOS, Android

Thông báoMessagePayload.badge

Giá trị của huy hiệu trên biểu tượng ứng dụng màn hình chính.

Nếu không được chỉ định, huy hiệu sẽ không được thay đổi.

Nếu được đặt thành 0 , huy hiệu sẽ bị xóa.

**Nền tảng:** iOS

Chữ ký:

badge?: string;

Thông báoMessagePayload.body

Nội dung của thông báo.

**Nền tảng:** iOS, Android, Web

Chữ ký:

body?: string;

Thông báoMessagePayload.bodyLocArgs

Các giá trị chuỗi biến đổi được sử dụng thay cho bộ xác định định dạng trong body_loc_key để bản địa hóa nội dung văn bản sang bản địa hóa hiện tại của người dùng.

Giá trị phải là một mảng JSON được xâu chuỗi.

**iOS:** Tương ứng với loc-args trong tải trọng APN. Xem Tham khảo khóa tải trọngbản địa hóa nội dung thông báo từ xa của bạn để biết thêm thông tin.

**Android:** Xem Định dạng và Tạo kiểu để biết thêm thông tin.

**Nền tảng:** iOS, Android

Chữ ký:

bodyLocArgs?: string;

Thông báoMessagePayload.bodyLocKey

Khóa cho chuỗi nội dung trong tài nguyên chuỗi của ứng dụng sẽ được sử dụng để bản địa hóa văn bản nội dung theo bản địa hóa hiện tại của người dùng.

**iOS:** Tương ứng với loc-key trong tải trọng APN. Xem Tham khảo khóa tải trọngbản địa hóa nội dung thông báo từ xa của bạn để biết thêm thông tin.

**Android:** Xem Tài nguyên chuỗi để biết thêm thông tin.

**Nền tảng:** iOS, Android

Chữ ký:

bodyLocKey?: string;

Thông báoMessagePayload.clickHành động

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.

* **Nền tảng:** Android

Chữ ký:

clickAction?: string;

Thông báoMessagePayload.color

Màu của biểu tượng thông báo, được biểu thị ở định dạng #rrggbb .

**Nền tảng:** Android

Chữ ký:

color?: string;

Thông báoMessagePayload.icon

Biểu tượng của thông báo

**Android:** Đặt biểu tượng thông báo thành myicon cho tài nguyên có thể vẽ myicon . Nếu bạn không gửi khóa này trong yêu cầu, FCM sẽ hiển thị biểu tượng trình khởi chạy được chỉ định trong bảng kê khai ứng dụng của bạn.

**Web:** URL sử dụng cho biểu tượng thông báo.

**Nền tảng:** Android, Web

Chữ ký:

icon?: string;

Thông báoMessagePayload.sound

Âm thanh phát ra khi thiết bị nhận được thông báo. Hỗ trợ "mặc định" cho âm thanh thông báo mặc định của thiết bị hoặc tên tệp của tài nguyên âm thanh được gói trong ứng dụng. Các tệp âm thanh phải nằm trong /res/raw/ .

**Nền tảng:** Android

Chữ ký:

sound?: string;

Thông báoMessagePayload.tag

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.

Nếu được chỉ định và thông báo có cùng thẻ đã được hiển thị thì thông báo mới sẽ thay thế thông báo hiện có trong ngăn thông báo.

**Nền tảng:** Android

Chữ ký:

tag?: string;

Thông báoMessagePayload.title

Tiêu đề của thông báo.

**Nền tảng:** iOS, Android, Web

Chữ ký:

title?: string;

Thông báoMessagePayload.titleLocArgs

Các giá trị chuỗi biến đổi được sử dụng thay cho bộ xác định định dạng trong title_loc_key để bản địa hóa văn bản tiêu đề sang bản địa hóa hiện tại của người dùng.

Giá trị phải là một mảng JSON được xâu chuỗi.

**iOS:** Tương ứng với title-loc-args trong tải trọng APN. Xem Tham khảo khóa tải trọngbản địa hóa nội dung thông báo từ xa của bạn để biết thêm thông tin.

**Android:** Xem Định dạng và Tạo kiểu để biết thêm thông tin.

**Nền tảng:** iOS, Android

Chữ ký:

titleLocArgs?: string;

Thông báoMessagePayload.titleLocKey

Khóa của chuỗi tiêu đề trong tài nguyên chuỗi của ứng dụng sẽ được sử dụng để bản địa hóa văn bản tiêu đề theo bản địa hóa hiện tại của người dùng.

**iOS:** Tương ứng với title-loc-key trong tải trọng APN. Xem Tham khảo khóa tải trọngbản địa hóa nội dung thông báo từ xa của bạn để biết thêm thông tin.

**Android:** Xem Tài nguyên chuỗi để biết thêm thông tin.

**Nền tảng:** iOS, Android

Chữ ký:

titleLocKey?: string;