Messaging class

Dịch vụ nhắn tin được liên kết với ứng dụng được cung cấp.

Chữ ký:

export declare class Messaging 

Của cải

Tài sản sửa đổi Kiểu Sự miêu tả
ứng dụng Ứng dụng Ứng dụng được liên kết với phiên bản dịch vụ Messaging hiện tại.

phương pháp

Phương pháp sửa đổi Sự miêu tả
gửi (tin nhắn, dryRun) Gửi tin nhắn đã cho qua FCM.
sendAll(tin nhắn, dryRun) Gửi tất cả tin nhắn trong mảng nhất định thông qua Firebase Cloud Messaging. Sử dụng tính năng gộp để gửi toàn bộ danh sách dưới dạng một lệnh gọi RPC. So với phương thức send() , phương thức này là cách hiệu quả hơn đáng kể để gửi nhiều tin nhắn. Danh sách phản hồi thu được từ giá trị trả về tương ứng với thứ tự các token trong MulticastMessage . Một lỗi từ phương pháp này cho thấy lỗi hoàn toàn, nghĩa là không có thư nào trong danh sách có thể được gửi đi. Lỗi một phần được biểu thị bằng giá trị trả về BatchResponse .
sendEach(tin nhắn, dryRun) Gửi từng tin nhắn trong mảng nhất định thông qua Firebase Cloud Messaging. Không giống như Messaging.sendAll() , phương thức này thực hiện một lệnh gọi RPC cho mỗi thông báo trong mảng đã cho. Danh sách phản hồi thu được từ giá trị trả về tương ứng với thứ tự của messages . Một lỗi từ phương pháp này hoặc một BatchResponse với tất cả các lỗi đều biểu thị lỗi hoàn toàn, nghĩa là không có tin nhắn nào trong danh sách có thể được gửi đi. Lỗi một phần hoặc không có lỗi chỉ được biểu thị bằng giá trị trả về BatchResponse .
sendEachForMulticast(tin nhắn, dryRun) Gửi tin nhắn multicast đã cho tới tất cả các mã thông báo đăng ký FCM được chỉ định trong đó. Phương thức này sử dụng API Messaging.sendEach() để gửi tin nhắn đã cho đến tất cả người nhận mục tiêu. Danh sách phản hồi thu được từ giá trị trả về tương ứng với thứ tự các token trong MulticastMessage . Một lỗi từ phương pháp này hoặc một BatchResponse với tất cả các lỗi đều cho biết lỗi hoàn toàn, nghĩa là các thông báo trong danh sách có thể được gửi đi. Lỗi một phần hoặc lỗi chỉ được biểu thị bằng giá trị trả về BatchResponse .
sendMulticast(tin nhắn, dryRun) Gửi tin nhắn multicast đã cho tới tất cả các mã thông báo đăng ký FCM được chỉ định trong đó. Phương thức này sử dụng API sendAll() để gửi tin nhắn đã cho đến tất cả người nhận mục tiêu. Danh sách phản hồi thu được từ giá trị trả về tương ứng với thứ tự các token trong MulticastMessage . Lỗi từ phương pháp này cho thấy lỗi hoàn toàn, nghĩa là tin nhắn không được gửi đến bất kỳ mã thông báo nào trong danh sách. Lỗi một phần được biểu thị bằng giá trị trả về BatchResponse .
sendToCondition(điều kiện, tải trọng, tùy chọn) Gửi tin nhắn FCM đến một điều kiện. Xem Gửi đến một điều kiện để biết các mẫu mã và tài liệu chi tiết.
sendToDevice(registrationTokenOrTokens, tải trọng, tùy chọn) Gửi tin nhắn FCM đến một thiết bị tương ứng với mã thông báo đăng ký được cung cấp. Xem Gửi tới từng thiết bị để biết mẫu mã và tài liệu chi tiết. Lấy một registrationToken để gửi đến một thiết bị hoặc tham số registrationTokens chứa một loạt mã thông báo để gửi đến nhiều thiết bị.
sendToDeviceGroup(notificationKey, payload, options) Gửi tin nhắn FCM đến nhóm thiết bị tương ứng với khóa thông báo được cung cấp. Xem Gửi đến nhóm thiết bị để biết mẫu mã và tài liệu chi tiết.
sendToTopic(chủ đề, tải trọng, tùy chọn) Gửi tin nhắn FCM đến một chủ đề. Xem Gửi đến chủ đề để biết mẫu mã và tài liệu chi tiết.
subscribeToTopic(registrationTokenOrTokens, topic) Đăng ký một thiết bị vào một chủ đề FCM. Xem Đăng ký chủ đề để biết mẫu mã và tài liệu chi tiết. Tùy chọn, bạn có thể cung cấp một loạt mã thông báo để đăng ký nhiều thiết bị.
hủy đăng kýFromTopic(registrationTokenOrTokens, topic) Hủy đăng ký một thiết bị khỏi chủ đề FCM. Xem Hủy đăng ký chủ đề để biết mẫu mã và tài liệu chi tiết. Tùy chọn, bạn có thể cung cấp một loạt mã thông báo để hủy đăng ký nhiều thiết bị.

Nhắn tin.app

Ứng dụng được liên kết với phiên bản dịch vụ Messaging hiện tại.

Chữ ký:

get app(): App;

Ví dụ

var app = messaging.app;

Nhắn tin.send()

Gửi tin nhắn đã cho qua FCM.

Chữ ký:

send(message: Message, dryRun?: boolean): Promise<string>;

Thông số

Tham số Kiểu Sự miêu tả
tin nhắn Tin nhắn Tải trọng tin nhắn.
chạy khô boolean Có gửi tin nhắn ở chế độ chạy thử (chỉ xác thực) hay không.

Trả về:

Hứa<string>

Một lời hứa được thực hiện bằng chuỗi ID tin nhắn duy nhất sau khi tin nhắn được chuyển thành công đến dịch vụ FCM để gửi.

Nhắn tin.sendAll()

Thay vào đó hãy sử dụng Messaging.sendEach() .

Gửi tất cả tin nhắn trong mảng nhất định thông qua Firebase Cloud Messaging. Sử dụng tính năng gộp để gửi toàn bộ danh sách dưới dạng một lệnh gọi RPC. So với phương thức send() , phương thức này là cách hiệu quả hơn đáng kể để gửi nhiều tin nhắn.

Danh sách phản hồi thu được từ giá trị trả về tương ứng với thứ tự các token trong MulticastMessage . Một lỗi từ phương pháp này cho thấy lỗi hoàn toàn, nghĩa là không có thư nào trong danh sách có thể được gửi đi. Lỗi một phần được biểu thị bằng giá trị trả về BatchResponse .

Chữ ký:

sendAll(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;

Thông số

Tham số Kiểu Sự miêu tả
tin nhắn Tin nhắn [] Một mảng không trống chứa tối đa 500 tin nhắn.
chạy khô boolean Có gửi tin nhắn ở chế độ chạy thử (chỉ xác thực) hay không.

Trả về:

Lời hứa< BatchResponse >

Một Lời hứa được thực hiện với một đối tượng thể hiện kết quả của thao tác gửi.

Nhắn tin.sendEach()

Gửi từng tin nhắn trong mảng nhất định thông qua Firebase Cloud Messaging.

Không giống như Messaging.sendAll() , phương thức này thực hiện một lệnh gọi RPC cho mỗi thông báo trong mảng đã cho.

Danh sách phản hồi thu được từ giá trị trả về tương ứng với thứ tự messages . Một lỗi từ phương pháp này hoặc một BatchResponse với tất cả các lỗi đều biểu thị lỗi hoàn toàn, nghĩa là không có tin nhắn nào trong danh sách có thể được gửi đi. Lỗi một phần hoặc không có lỗi chỉ được biểu thị bằng giá trị trả về BatchResponse .

Chữ ký:

sendEach(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;

Thông số

Tham số Kiểu Sự miêu tả
tin nhắn Tin nhắn [] Một mảng không trống chứa tối đa 500 tin nhắn.
chạy khô boolean Có gửi tin nhắn ở chế độ chạy thử (chỉ xác thực) hay không.

Trả về:

Lời hứa< BatchResponse >

Một Lời hứa được thực hiện với một đối tượng thể hiện kết quả của thao tác gửi.

Messaging.sendEachForMulticast()

Gửi tin nhắn multicast đã cho tới tất cả các mã thông báo đăng ký FCM được chỉ định trong đó.

Phương thức này sử dụng API Messaging.sendEach() để gửi tin nhắn đã cho đến tất cả người nhận mục tiêu. Danh sách phản hồi thu được từ giá trị trả về tương ứng với thứ tự các token trong MulticastMessage . Một lỗi từ phương pháp này hoặc một BatchResponse với tất cả các lỗi đều cho biết lỗi hoàn toàn, nghĩa là các thông báo trong danh sách có thể được gửi đi. Lỗi một phần hoặc lỗi chỉ được biểu thị bằng giá trị trả về BatchResponse .

Chữ ký:

sendEachForMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;

Thông số

Tham số Kiểu Sự miêu tả
tin nhắn Tin nhắn Multicast Một tin nhắn multicast chứa tới 500 token.
chạy khô boolean Có gửi tin nhắn ở chế độ chạy thử (chỉ xác thực) hay không.

Trả về:

Lời hứa< BatchResponse >

Một Lời hứa được thực hiện với một đối tượng thể hiện kết quả của thao tác gửi.

Nhắn tin.sendMulticast()

Thay vào đó hãy sử dụng Messaging.sendEachForMulticast() .

Gửi tin nhắn multicast đã cho tới tất cả các mã thông báo đăng ký FCM được chỉ định trong đó.

Phương thức này sử dụng API sendAll() để gửi tin nhắn đã cho đến tất cả người nhận mục tiêu. Danh sách phản hồi thu được từ giá trị trả về tương ứng với thứ tự các token trong MulticastMessage . Lỗi từ phương pháp này cho thấy lỗi hoàn toàn, nghĩa là tin nhắn không được gửi đến bất kỳ mã thông báo nào trong danh sách. Lỗi một phần được biểu thị bằng giá trị trả về BatchResponse .

Chữ ký:

sendMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;

Thông số

Tham số Kiểu Sự miêu tả
tin nhắn Tin nhắn Multicast Một tin nhắn multicast chứa tới 500 token.
chạy khô boolean Có gửi tin nhắn ở chế độ chạy thử (chỉ xác thực) hay không.

Trả về:

Lời hứa< BatchResponse >

Một Lời hứa được thực hiện với một đối tượng thể hiện kết quả của thao tác gửi.

Nhắn tin.sendToCondition()

Gửi tin nhắn FCM đến một điều kiện.

Xem Gửi đến một điều kiện để biết các mẫu mã và tài liệu chi tiết.

Chữ ký:

sendToCondition(condition: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingConditionResponse>;

Thông số

Tham số Kiểu Sự miêu tả
tình trạng sợi dây Điều kiện xác định chủ đề nào sẽ gửi tin nhắn.
khối hàng Tải trọng tin nhắn Tải trọng tin nhắn.
tùy chọn Tùy chọn nhắn tin Tùy chọn tùy chọn để thay đổi tin nhắn.

Trả về:

Lời hứa< Nhắn tinĐiều kiệnPhản hồi >

Một lời hứa được thực hiện với phản hồi của máy chủ sau khi tin nhắn được gửi.

Nhắn tin.sendToDevice()

Thay vào đó hãy sử dụng Messaging.send() .

Gửi tin nhắn FCM đến một thiết bị tương ứng với mã thông báo đăng ký được cung cấp.

Xem Gửi tới từng thiết bị để biết mẫu mã và tài liệu chi tiết. Lấy một registrationToken để gửi đến một thiết bị hoặc tham số registrationTokens chứa một loạt mã thông báo để gửi đến nhiều thiết bị.

Chữ ký:

sendToDevice(registrationTokenOrTokens: string | string[], payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDevicesResponse>;

Thông số

Tham số Kiểu Sự miêu tả
đăng kýTokenHoặcTokens chuỗi | sợi dây[]
khối hàng Tải trọng tin nhắn Tải trọng tin nhắn.
tùy chọn Tùy chọn nhắn tin Tùy chọn tùy chọn để thay đổi tin nhắn.

Trả về:

Lời hứa< MessagingDevicesResponse >

Một lời hứa được thực hiện với phản hồi của máy chủ sau khi tin nhắn được gửi.

Messaging.sendToDeviceGroup()

Thay vào đó hãy sử dụng Messaging.send() .

Gửi tin nhắn FCM đến nhóm thiết bị tương ứng với khóa thông báo được cung cấp.

Xem Gửi đến nhóm thiết bị để biết mẫu mã và tài liệu chi tiết.

Chữ ký:

sendToDeviceGroup(notificationKey: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDeviceGroupResponse>;

Thông số

Tham số Kiểu Sự miêu tả
thông báoKey sợi dây Phím thông báo dành cho nhóm thiết bị sẽ gửi tin nhắn.
khối hàng Tải trọng tin nhắn Tải trọng tin nhắn.
tùy chọn Tùy chọn nhắn tin Tùy chọn tùy chọn để thay đổi tin nhắn.

Trả về:

Lời hứa< MessagingDeviceGroupResponse >

Một lời hứa được thực hiện với phản hồi của máy chủ sau khi tin nhắn được gửi.

Messaging.sendToTopic()

Gửi tin nhắn FCM đến một chủ đề.

Xem Gửi đến chủ đề để biết mẫu mã và tài liệu chi tiết.

Chữ ký:

sendToTopic(topic: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingTopicResponse>;

Thông số

Tham số Kiểu Sự miêu tả
đề tài sợi dây Chủ đề để gửi tin nhắn.
khối hàng Tải trọng tin nhắn Tải trọng tin nhắn.
tùy chọn Tùy chọn nhắn tin Tùy chọn tùy chọn để thay đổi tin nhắn.

Trả về:

Lời hứa< MessagingTopicResponse >

Một lời hứa được thực hiện với phản hồi của máy chủ sau khi tin nhắn được gửi.

Nhắn tin.subscribeToTopic()

Đăng ký một thiết bị vào một chủ đề FCM.

Xem Đăng ký chủ đề để biết mẫu mã và tài liệu chi tiết. Tùy chọn, bạn có thể cung cấp một loạt mã thông báo để đăng ký nhiều thiết bị.

Chữ ký:

subscribeToTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;

Thông số

Tham số Kiểu Sự miêu tả
đăng kýTokenHoặcTokens chuỗi | sợi dây[]
đề tài sợi dây Chủ đề để đăng ký.

Trả về:

Lời hứa< Nhắn tinTopicQuản lýPhản hồi >

Một lời hứa được thực hiện với phản hồi của máy chủ sau khi thiết bị đã đăng ký chủ đề.

Nhắn tin.unsubscribeFromTopic()

Hủy đăng ký một thiết bị khỏi chủ đề FCM.

Xem Hủy đăng ký chủ đề để biết mẫu mã và tài liệu chi tiết. Tùy chọn, bạn có thể cung cấp một loạt mã thông báo để hủy đăng ký nhiều thiết bị.

Chữ ký:

unsubscribeFromTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;

Thông số

Tham số Kiểu Sự miêu tả
đăng kýTokenHoặcTokens chuỗi | sợi dây[]
đề tài sợi dây Chủ đề để hủy đăng ký.

Trả về:

Lời hứa< Nhắn tinTopicQuản lýPhản hồi >

Một lời hứa được thực hiện với phản hồi của máy chủ sau khi thiết bị được hủy đăng ký khỏi chủ đề.