firebase-admin.messaging package

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ụ Messaging (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ể.

Lớp học

Hạng Mô tả
FirebaseMessagingError Cấu trúc mã lỗi của tính năng Nhắn tin Firebase. Thao tác này mở rộng PrefixedFirebaseError.
Nhắn tin Dịch vụ nhắn tin liên kết với ứng dụng đã cung cấp.
MessagingClientErrorCode Mã lỗi của ứng dụng nhắn tin và các tin nhắn mặc định của chúng.

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ể được đưa vào trong Tin nhắn.
AndroidFcmOptions Biểu thị các tuỳ chọn cho các tính năng do SDK FCM dành cho Android cung cấp.
AndroidNotification Biểu thị các tuỳ chọn thông báo dành riêng cho Android có thể đưa vào AndroidConfig.
ApnsConfig Biểu thị các tuỳ chọn dành riêng cho APN có thể đưa vào trong Message (Thông báo). Tham khảo tài liệu của Apple để biết nhiều tiêu đề và trường tải trọng do APN hỗ trợ.
ApnsFcmOptions Biểu thị các tuỳ chọn cho các tính năng do SDK FCM dành cho iOS cung cấp.
ApnsPayload 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 tuỳ ý khác.
Aps Đại diện cho từ điển aps là một phần của thông báo APN.
ApsAlert
BaseMessage
BatchResponse 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 (Thông báo điều kiện)
CriticalAudio (âm thanh quan trọng) 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 tải trọng APN.
DataMessagePayload Giao diện biểu thị tải trọng thông báo dữ liệu API cũ FCM. Thông báo dữ liệu cho phép nhà phát triển gửi các cặp khoá-giá trị tuỳ chỉnh có kích thước lên đến 4KB. Cả khoá và giá trị phải là chuỗi. Khoá có thể là bất kỳ chuỗi tuỳ chỉnh nào, ngoại trừ các chuỗi dành riêng sau đây:
  • from
  • Bất kỳ giá trị nào bắt đầu bằng google.
Hãy xem bài viết Tạo yêu cầu gửi để biết mã mẫu và tài liệu chi tiết.
FcmOptions 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 SDK FCM cung cấp.
LightSettings (Cài đặt đèn) Biểu thị các chế độ cài đặt để kiểm soát đèn LED thông báo có thể đưa vào AndroidNotification.
MessagingConditionResponse Giao diện thể hiện phản hồi của máy chủ qua phương thức Messaging.sendToCondition() cũ.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.
MessagingDeviceGroupResponse Giao diện thể hiện phản hồi của máy chủ qua phương thức Messaging.sendToDeviceGroup().Hãy xem phần Gửi thông báo đến nhóm thiết bị để biết mã mẫu và tài liệu chi tiết.
MessagingDeviceResult Tải trọng phản hồi của từng trạng thái từ các thiết bị riêng lẻ
MessagingDevicesResponse Giao diện thể hiện trạng thái của thông báo được gửi đến một thiết bị riêng lẻ thông qua API cũ FCM.Hãy xem phần Gửi đến từng thiết bị để biết mã mẫu và tài liệu chi tiết.
MessagingOptions (Tuỳ chọn nhắn tin) Giao diện thể hiện các tuỳ chọn có thể được cung cấp khi gửi thông báo qua API FCM cũ.Hãy xem bài viết Tạo yêu cầu gửi để biết mã mẫu và tài liệu chi tiết.
MessagingPayload (Tải trọng) Giao diện biểu thị 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.Hãy xem phần Tạo yêu cầu gửi để biết mã mẫu và tài liệu chi tiết.
Nhắn tin chủ đềQuản lýResponse Giao diện biểu thị phản hồi của máy chủ qua phương thức Messaging.subscribeToTopics() và Messaging.unsubscribeFromTopics().Xem bài viết Quản lý chủ đề từ máy chủ để biết các mã mẫu và tài liệu chi tiết.
Nhắn tin (Chủ đề phản hồi) Giao diện thể hiện phản hồi của máy chủ qua phương thức Messaging.sendToTopics() cũ.Hãy xem phần Gửi đến một chủ đề để biết các mã mẫu và tài liệu chi tiết.
MulticastMessage Tải trọng của phương thức Messaging.sendMulticast(). Tải trọng chứa tất cả các trường trong loại BaseMessage và danh sách mã thông báo.
Thông báo Một thông báo có thể được đưa vào trong mục Tin nhắn.
NotificationMessagePayload Giao diện biểu thị tải trọng thông báo thông báo API cũ FCM. Nội dung thông báo cho phép nhà phát triển gửi tối đa 4KB cặp khoá-giá trị được xác định trước. Các khoá được chấp nhận được trình bày bên dưới.Hãy xem phần Tạo yêu cầu gửi để biết mã mẫu và tài liệu chi tiết.
Gửi phản hồi Giao diện thể hiện trạng thái của một thông báo riêng lẻ đã được gửi trong yêu cầu hàng loạt.
TokenMessage
TopicsMessage
WebpushConfig Biểu thị các tuỳ chọn giao thức WebPush có thể đưa vào Message.
WebpushFcmOptions Biểu thị các tuỳ chọn cho các tính năng do SDK FCM dành cho Web cung cấp (không nằm trong 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. Tính năng này hỗ trợ hầu hết các tuỳ chọn chuẩn như được xác định trong quy cách của Thông báo trên web.

Nhập bí danh

Nhập bí danh Mô tả
Tin nhắn Tải trọng của hoạt động Messaging.send(). Tải trọng chứa tất cả các trường trong loại BaseMessage và chính xác một trong các mã thông báo, chủ đề hoặc điều kiện.

getMessaging(ứng dụng)

Nhận dịch vụ Messaging (Nhắn tin) cho ứng dụng mặc định hoặc một ứng dụng cụ thể.

admin.messaging() có thể được gọi mà không có đối số để truy cập dịch vụ Messaging của ứng dụng mặc định hoặc dưới dạng admin.messaging(app) để truy cập 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:

Nhắn tin

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 của thao tác Messaging.send(). Tải trọng chứa tất cả các trường trong loại BaseMessage và chính xác một trong các mã thông báo, chủ đề hoặc điều kiện.

Chữ ký:

export type Message = TokenMessage | TopicMessage | ConditionMessage;