Giải pháp gửi thông báo qua đám mây của Firebase (FCM).
Hàm
| Chức năng | Mô tả |
|---|---|
| getMessaging(ứng dụng) | Nhận dịch vụ Nhắn tin cho ứng dụng mặc định hoặc một ứng dụng nhất định.admin.messaging() có thể được gọi mà không cần đối số để truy cập vào dịch vụ Messaging của ứng dụng mặc định hoặc dưới dạng admin.messaging(app) để truy cập vào dịch vụ Messaging liên kết với một ứng dụng cụ thể. |
Hạng
| Hạng | Mô tả |
|---|---|
| Nhắn tin | Dịch vụ nhắn tin liên kết với ứng dụng cho sẵn. |
Giao diện
| Giao diện | Mô tả |
|---|---|
| AndroidConfig | Đại diện cho các tuỳ chọn dành riêng cho Android có thể đưa vào trong một Tin nhắn. |
| AndroidFcmOptions | Biểu thị các tùy chọn cho các tính năng do SDK FCM dành cho Android cung cấp. |
| Thông báo trên Android | Đại diện cho các tuỳ chọn thông báo dành riêng cho Android có thể đưa vào AndroidConfig. |
| ApnsConfig | Đại diện cho các tuỳ chọn dành riêng cho APN có thể được đưa vào trong một Thông báo. Hãy tham khảo Tài liệu của Apple để biết nhiều tiêu đề và trường tải trọng mà APN hỗ trợ. |
| ApnsFcmOptions | Biểu thị các tùy chọn cho các tính năng do SDK FCM cung cấp dành cho iOS. |
| Tải trọng Apns | Biểu thị tải trọng của thông báo APN. Chủ yếu bao gồm từ điển aps. Tuy nhiên, cũng có thể chứa các khoá tuỳ chỉnh khác. |
| Aps | Đại diện cho từ điển aps thuộc thông báo APN. |
| ApsAlert | |
| BaseMessage | |
| BatchResponse (Phản hồi hàng loạt) | Giao diện biểu thị phản hồi của máy chủ qua phương thức Messaging.sendAll() và Messaging.sendMulticast(). |
| ConditionMessage | |
| Phê duyệt âm thanh | Biểu thị một cấu hình âm thanh quan trọng có thể đưa vào từ điển aps của một tải trọng APN. |
| DataMessagePayload | Giao diện đại diện cho tải trọng thông báo dữ liệu API cũ của FCM. Thông báo dữ liệu cho phép nhà phát triển gửi tối đa 4KB các cặp khoá-giá trị tuỳ chỉnh. Cả khoá và giá trị phải là chuỗi. Khoá có thể là chuỗi tuỳ chỉnh bất kỳ, ngoại trừ các chuỗi dành riêng sau:
|
| Tuỳ chọn Fcm | Biểu thị các tuỳ chọn độc lập với nền tảng cho các tính năng do FCM SDK cung cấp. |
| LightSettings (Cài đặt ánh sáng) | Biểu thị các chế độ cài đặt để điều khiển đèn LED thông báo có thể đưa vào AndroidNotification. |
| MessagingConditionResponse | Giao diện biểu thị phản hồi của máy chủ qua phương thức Messaging.sendToCondition() cũ.Xem phần Gửi đến một điều kiện để xem mã mẫu và tài liệu chi tiết. |
| MessagingDeviceGroupResponse | Giao diện biểu thị phản hồi của máy chủ từ phương thức Messaging.sendToDeviceGroup().Xem phần Gửi thông báo đến các nhóm thiết bị để xem các mã mẫu và tài liệu chi tiết. |
| MessagingDeviceResult | Tải trọng phản hồi trạng thái riêng lẻ từ các thiết bị duy nhất |
| Nhắn tin phản hồi cho thiết bị tin nhắn | Giao diện biểu thị trạng thái của một tin nhắn được gửi tới từng thiết bị thông qua API cũ của FCM.Xem mục Gửi đến từng thiết bị để xem mã mẫu và tài liệu chi tiết. |
| Tuỳ chọn nhắn tin | Giao diện biểu thị các tuỳ chọn có thể được cung cấp khi gửi tin nhắn qua API cũ của FCM.Xem bài viết Tạo yêu cầu gửi để xem mã mẫu và tài liệu chi tiết. |
| Tải trọng nhắn tin | Giao diện thể hiện tải trọng tin nhắn của Giải pháp gửi thông báo qua đám mây của Firebase. Bắt buộc phải có một hoặc cả hai khoá data và notification.Xem bài viết Gửi yêu cầu tạo bản dựng để xem mã mẫu và tài liệu chi tiết. |
| Nhắn tin phản hồi về chủ đề quản lý chủ đề | Giao diện biểu thị phản hồi của máy chủ qua phương thức Messaging.subscribeToTopic() và Messaging.unsubscribeFromTopic().Xem Quản lý các chủ đề từ máy chủ để xem mã mẫu và tài liệu chi tiết. |
| Nhắn tin phản hồi chủ đề | Giao diện biểu thị phản hồi của máy chủ từ phương thức Messaging.sendToTopic() cũ.Xem phần Gửi đến một chủ đề để xem mã mẫu và tài liệu chi tiết. |
| MulticastMessage | Tải trọng cho phương thức Messaging.sendMulticast(). Tải trọng này chứa tất cả các trường trong loại BaseMessage và một danh sách mã thông báo. |
| Thông báo | Một thông báo có thể được đưa vào Tin nhắn. |
| NotificationMessagePayload | Giao diện thể hiện tải trọng tin nhắn thông báo API cũ của FCM. Tin nhắn thông báo cho phép nhà phát triển gửi tối đa 4KB các cặp khoá-giá trị được xác định trước. Các khoá được chấp nhận được nêu bên dưới.Xem Yêu cầu gửi bản dựng để biết mã mẫu và tài liệu chi tiết. |
| SendResponse (Gửi phản hồi) | Giao diện biểu thị trạng thái của từng thư được gửi trong một yêu cầu hàng loạt. |
| Mã thông báo | |
| TopicsMessage | |
| WebpushConfig | Đại diện cho các tuỳ chọn giao thức WebPush có thể đưa vào trong Message. |
| WebpushFcmOptions | Biểu thị các tùy chọn cho các tính năng do SDK FCM dành cho web cung cấp (không thuộc tiêu chuẩn Webpush). |
| WebpushNotification | Đại diện cho các tuỳ chọn thông báo dành riêng cho WebPush có thể đưa vào WebpushConfig. Giao diện này hỗ trợ hầu hết các tuỳ chọn chuẩn như được xác định trong quy cách Thông báo trên web. |
Loại bí danh
| Loại bí danh | Mô tả |
|---|---|
| Tin nhắn | Tải trọng cho thao tác Messaging.send(). Tải trọng chứa tất cả các trường thuộc loại BaseMessage và chính xác một mã thông báo, chủ đề hoặc điều kiện. |
getNhắn tin(ứng dụng)
Nhận dịch vụ Nhắn tin cho ứng dụng mặc định hoặc một ứng dụng cụ thể.
Có thể gọi admin.messaging() mà không có đối số để truy cập vào dịch vụ Messaging của ứng dụng mặc định hoặc dưới dạng admin.messaging(app) để truy cập vào dịch vụ Messaging liên kết với một ứng dụng cụ thể.
Chữ ký:
export declare function getMessaging(app?: App): Messaging;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| ứng dụng | Ứng dụng | Ứng dụng không bắt buộc có dịch vụ Messaging cần trả về. Nếu không được cung cấp, dịch vụ Messaging mặc định sẽ được trả về. |
Trường hợp trả lại hàng:
Dịch vụ Messaging mặc định nếu không có ứng dụng nào được cung cấp hoặc dịch vụ Messaging liên kết với ứng dụng đã cung cấp.
Ví dụ 1
// Get the Messaging service for the default app
const defaultMessaging = getMessaging();
Ví dụ 2
// Get the Messaging service for a given app
const otherMessaging = getMessaging(otherApp);
Nội dung
Tải trọng cho thao tác Messaging.send(). Tải trọng chứa tất cả các trường thuộc loại BaseMessage và chính xác một mã thông báo, chủ đề hoặc điều kiện.
Chữ ký:
export type Message = TokenMessage | TopicMessage | ConditionMessage;