Messaging class

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

Chữ ký:

export declare class Messaging

Thuộc tính

Tài sản Công cụ sửa đổi Loại Mô tả
ứng dụng Ứng dụng Ứng dụng được liên kết với thực thể dịch vụ Messaging hiện tại.

Phương thức

Phương thức Công cụ sửa đổi Mô tả
enablelegacyHttpTransport() Cho phép sử dụng công cụ truyền tải HTTP/1.1 cũ cho sendEach() và sendEachForMulticast().
send(tin nhắn,!Run) Gửi tin nhắn đã cho qua FCM.
sendAll(messages,!Run) Gửi tất cả tin nhắn trong mảng đã cho thông qua Giải pháp gửi thông báo qua đám mây của Firebase. Sử dụng việc phân lô để 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 để gửi nhiều tin nhắn.Danh sách phản hồi nhận được từ giá trị trả về tương ứng với thứ tự mã thông báo trong MulticastMessage. Lỗi trong phương thức này cho biết lỗi hoàn toàn, tức là không gửi được 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.
sendEach(messages, ryRun) Gửi từng tin nhắn trong mảng đã cho thông qua Giải pháp gửi thông báo qua đám mây của Firebase.Không giống như Messaging.sendAll(), phương thức này thực hiện một lệnh gọi RPC duy nhất cho mỗi thông báo trong mảng đã cho.Danh sách phản hồi nhận được từ giá trị trả về tương ứng với thứ tự của messages. Nếu phương thức này gặp lỗi hoặc một BatchResponse với tất cả lỗi đều cho biết lỗi hoàn toàn, tức là không gửi được thông báo nào trong danh sách. Lỗi một phần hoặc không có lỗi nào chỉ được biểu thị bằng giá trị trả về BatchResponse.
sendEachForMulticast(tin nhắn, ryRun) Gửi thông báo đa hướng đã cho tới tất 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() nâng cao để gửi thông báo đã cho tới tất cả người nhận mục tiêu. Danh sách phản hồi nhận được từ giá trị trả về tương ứng với thứ tự của mã thông báo trong MulticastMessage. Nếu một lỗi của phương thức này hoặc một BatchResponse với tất cả lỗi thì cho biết lỗi hoàn toàn, tức là có thể các thông báo trong danh sách đã đượ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,,ryRun) Gửi thông báo đa hướng đã cho đến tất cả mã thông báo đăng ký FCM được chỉ định trong đó.Phương thức này sử dụng API sendAll() nâng cao để gửi thông báo đã cho tới tất cả người nhận đích. Danh sách phản hồi nhận được từ giá trị trả về tương ứng với thứ tự của mã thông báo trong MulticastMessage. Lỗi trong phương thức này cho biết lỗi hoàn toàn, tức là thông báo 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, tuỳ chọn) Gửi thông báo FCM đến một điều kiện.Xem Gửi đến một điều kiện để biết mã mẫu và tài liệu chi tiết.
sendToDevice(registrationTokenOrTokens, tải trọng, tuỳ chọn) Gửi tin nhắn FCM tới một thiết bị tương ứng với mã thông báo đăng ký được cung cấp.Hãy xem phần Gửi đến các thiết bị riêng lẻ để biết mã mẫu và tài liệu chi tiết. Lấy registrationToken để gửi đến một thiết bị hoặc tham số registrationTokens chứa một mảng mã thông báo để gửi đến nhiều thiết bị.
sendToDeviceGroup(notificationKey, tải trọng, tuỳ chọn) Gửi tin nhắn FCM tới một nhóm thiết bị tương ứng với khoá thông báo được cung cấp.Hãy xem phần Gửi đến một nhóm thiết bị để biết mã mẫu và tài liệu chi tiết.
sendToTopics(chủ đề, tải trọng, các tuỳ chọn) Gửi tin nhắn FCM tới một chủ đề.Xem Gửi đến một chủ đề để biết mã mẫu và tài liệu chi tiết.
subscribeToChủ đề(registrationTokenOrTokens, chủ đề) Đăng ký thiết bị theo chủ đề FCM.Xem Đăng ký chủ đề để biết mã mẫu và tài liệu chi tiết. Nếu muốn, bạn có thể cung cấp một mảng mã thông báo để đăng ký nhiều thiết bị.
unsubscribeFromChủ đề(registrationTokenOrTokens, chủ đề) Huỷ đăng ký thiết bị khỏi chủ đề FCM.Xem Huỷ đăng ký theo dõi một chủ đề để biết mã mẫu và tài liệu chi tiết. Nếu muốn, bạn có thể cung cấp một mảng mã thông báo để huỷ đăng ký nhiều thiết bị.

Nhắn tin.app

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

Chữ ký:

get app(): App;

Ví dụ

var app = messaging.app;

Nhắn tin.enableCũHttpTransport()

Mã này sẽ bị loại bỏ khi phương thức triển khai truyền tải HTTP/2 đạt được độ ổn định tương tự như khi triển khai HTTP/1.1 cũ.

Cho phép sử dụng công cụ truyền tải HTTP/1.1 cũ cho sendEach() và sendEachForMulticast().

Chữ ký:

enableLegacyHttpTransport(): void;

Trường hợp trả lại hàng:

trống

Ví dụ

const messaging = getMessaging(app);
messaging.enableLegacyTransport();
messaging.sendEach(messages);

Nhắn tin.send()

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

Chữ ký:

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

Thông số

Thông số Loại Mô tả
tin nhắn Tin nhắn Tải trọng tin nhắn.
chạy khô boolean Liệu có gửi thông báo ở chế độ chạy thử nghiệm (chỉ xác thực) hay không.

Trường hợp trả lại hàng:

Cam kết<string>

Lời hứa được thực hiện bằng một chuỗi mã nhận dạng thông báo duy nhất sau khi thông báo được chuyển giao thành công sang 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 đã cho thông qua Giải pháp gửi thông báo qua đám mây của Firebase. Sử dụng việc phân lô để 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 nhận được từ giá trị trả về tương ứng với thứ tự của mã thông báo trong MulticastMessage. Lỗi trong phương thức này cho biết lỗi hoàn toàn, tức là không gửi được 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ý:

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

Thông số

Thông số Loại Mô tả
tin nhắn Tin nhắn[] Một mảng không trống chứa tối đa 500 thư.
chạy khô boolean Liệu có gửi thông báo ở chế độ chạy thử nghiệm (chỉ xác thực) hay không.

Trường hợp trả lại hàng:

Cam kết<BatchResponse>

Lời hứa được thực hiện bằng một đối tượng đại diện cho kết quả của thao tác gửi.

Nhắn tin.sendEach()

Gửi từng tin nhắn trong mảng đã cho thông qua Giải pháp gửi thông báo qua đám mây của Firebase.

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 từng thông báo trong mảng đã cho.

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

Chữ ký:

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

Thông số

Thông số Loại Mô tả
tin nhắn Tin nhắn[] Một mảng không trống chứa tối đa 500 thư.
chạy khô boolean Liệu có gửi thông báo ở chế độ chạy thử nghiệm (chỉ xác thực) hay không.

Trường hợp trả lại hàng:

Cam kết<BatchResponse>

Lời hứa được thực hiện bằng một đối tượng đại diện cho kết quả của thao tác gửi.

Messaging.sendEachForMulticast()

Gửi thông báo đa hướng đã cho tới tất 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() nâng cao để gửi thông báo đã cho tới tất cả người nhận mục tiêu. Danh sách phản hồi nhận được từ giá trị trả về tương ứng với thứ tự của mã thông báo trong MulticastMessage. Nếu một lỗi của phương thức này hoặc một BatchResponse với tất cả lỗi thì cho biết lỗi hoàn toàn, tức là có thể các thông báo trong danh sách đã đượ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ố

Thông số Loại Mô tả
tin nhắn MulticastMessage Một tin nhắn đa hướng chứa tối đa 500 mã thông báo.
chạy khô boolean Liệu có gửi thông báo ở chế độ chạy thử nghiệm (chỉ xác thực) hay không.

Trường hợp trả lại hàng:

Cam kết<BatchResponse>

Lời hứa được thực hiện bằng một đối tượng đại diện cho kết quả của thao tác gửi.

Messaging.sendMulticast()

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

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

Phương thức này sử dụng API sendAll() nâng cao để gửi thông báo nhất định cho tất cả người nhận đích. Danh sách phản hồi nhận được từ giá trị trả về tương ứng với thứ tự của mã thông báo trong MulticastMessage. Lỗi trong phương thức này cho biết lỗi hoàn toàn, tức là thông báo 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ố

Thông số Loại Mô tả
tin nhắn MulticastMessage Một tin nhắn đa hướng chứa tối đa 500 mã thông báo.
chạy khô boolean Liệu có gửi thông báo ở chế độ chạy thử nghiệm (chỉ xác thực) hay không.

Trường hợp trả lại hàng:

Cam kết<BatchResponse>

Lời hứa được thực hiện bằng một đối tượng đại diện cho kết quả của thao tác gửi.

Messaging.sendToCondition()

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

Gửi thông báo FCM đến một điều kiện.

Hãy xem phần Gửi đến một điều kiện để biết mã mẫu và tài liệu chi tiết.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
điều kiện chuỗi Điều kiện xác định chủ đề để gửi thông báo.
tải trọng MessagingPayload (Tải trọng) Tải trọng tin nhắn.
tuỳ chọn MessagingOptions (Tuỳ chọn nhắn tin) Các lựa chọn không bắt buộc để thay đổi nội dung thông báo.

Trường hợp trả lại hàng:

Cam kết<MessagingConditionResponse>

Lời hứa được thực hiện bằng phản hồi của máy chủ sau khi gửi tin nhắn.

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.

Hãy xem phần Gửi đến các thiết bị riêng lẻ để biết mã mẫu và tài liệu chi tiết. Lấy registrationToken để gửi đến một thiết bị hoặc tham số registrationTokens chứa một mảng 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ố

Thông số Loại Mô tả
đăng kýMã chuỗi | chuỗi[]
tải trọng MessagingPayload (Tải trọng) Tải trọng tin nhắn.
tuỳ chọn MessagingOptions (Tuỳ chọn nhắn tin) Các lựa chọn không bắt buộc để thay đổi nội dung thông báo.

Trường hợp trả lại hàng:

Cam kết<MessagingDevicesResponse>

Lời hứa được thực hiện bằng phản hồi của máy chủ sau khi gửi tin nhắn.

Messaging.sendToDeviceGroup()

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

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

Hãy xem phần Gửi đến một nhóm thiết bị để biết mã mẫu và tài liệu chi tiết.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
khoá thông báo chuỗi Phím thông báo cho nhóm thiết bị mà bạn nhận tin nhắn được gửi đến.
tải trọng MessagingPayload (Tải trọng) Tải trọng tin nhắn.
tuỳ chọn MessagingOptions (Tuỳ chọn nhắn tin) Các lựa chọn không bắt buộc để thay đổi nội dung thông báo.

Trường hợp trả lại hàng:

Hứa hẹn<MessagingDeviceGroupResponse>

Lời hứa được thực hiện bằng phản hồi của máy chủ sau khi gửi tin nhắn.

Messaging.sendToTopics()

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

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

Hãy xem phần Gửi đến một chủ đề để biết mã mẫu và tài liệu chi tiết.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
chủ đề chuỗi Chủ đề mà bạn muốn gửi thư.
tải trọng MessagingPayload (Tải trọng) Tải trọng tin nhắn.
tuỳ chọn MessagingOptions (Tuỳ chọn nhắn tin) Các lựa chọn không bắt buộc để thay đổi nội dung thông báo.

Trường hợp trả lại hàng:

Cam kết<MessagingTopicsResponse>

Lời hứa được thực hiện bằng phản hồi của máy chủ sau khi gửi tin nhắn.

Nhắn tin.subscribeToChủ đề()

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

Xem phần Đăng ký một chủ đề để biết mã mẫu và tài liệu chi tiết. Nếu muốn, bạn có thể cung cấp một mảng 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ố

Thông số Loại Mô tả
đăng kýMã chuỗi | chuỗi[]
chủ đề chuỗi Chủ đề mà bạn muốn đăng ký.

Trường hợp trả lại hàng:

Hứa hẹn<MessagingSentManagementResponse>

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 đăng ký vào chủ đề.

Gửi tin nhắn.unsubscribeFromChủ đề()

Huỷ đăng ký thiết bị khỏi chủ đề FCM.

Hãy xem phần Huỷ đăng ký theo dõi một chủ đề để biết mã mẫu và tài liệu chi tiết. Nếu muốn, bạn có thể cung cấp một mảng mã thông báo để huỷ đăng ký nhiều thiết bị.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
đăng kýMã chuỗi | chuỗi[]
chủ đề chuỗi Chủ đề mà bạn muốn huỷ đăng ký.

Trường hợp trả lại hàng:

Hứa hẹn<MessagingSentManagementResponse>

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ị đã huỷ đăng ký khỏi chủ đề.