firebase-admin.messaging package

Nhắn tin qua đám mây Firebase (FCM).

Chức năng

Chức năng Sự miêu 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 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 được liên kết với một ứng dụng cụ thể.

Các lớp học

Lớp học Sự miêu tả
Nhắn tin Dịch vụ nhắn tin được liên kết với ứng dụng được cung cấp.

Giao diện

Giao diện Sự miêu tả
Cấu hình Android Thể hiện các tùy chọn dành riêng cho Android có thể được đưa vào Tin nhắn .
Tùy chọn AndroidFcm Thể hiện các tùy chọn cho các tính năng do FCM SDK dành cho Android cung cấp.
Thông báo Android Thể hiện các tùy chọn thông báo dành riêng cho Android có thể được đưa vào AndroidConfig .
ApnsConfig Thể hiện các tùy chọn dành riêng cho APN có thể được đưa vào Tin nhắn . Tham khảo tài liệu của Apple để biết các trường tiêu đề và tải trọng khác nhau được APN hỗ trợ.
ApnsFcmTùy chọn Thể hiện các tùy chọn cho các tính năng do FCM SDK dành cho iOS cung cấp.
ApnsTải trọng Thể hiện tải trọng của tin nhắn APN. Chủ yếu bao gồm từ điển aps . Nhưng cũng có thể chứa các khóa tùy chỉnh tùy ý khác.
Ứng dụng Đại diện cho từ điển aps là một phần của tin nhắn APN.
Thông báo Aps
Tin nhắn cơ sở
Phản hồi hàng loạt Giao diện thể hiện phản hồi của máy chủ từ các phương thức Messaging.sendAll()Messaging.sendMulticast() .
Thông báo tình trạng
âm thanh quan trọng Thể hiện cấu hình âm thanh quan trọng có thể được đưa vào từ điển aps của tải trọng APN.
DataMessageTải trọng Giao diện thể hiện tải trọng thông báo dữ liệu API kế thừa FCM. Thông báo dữ liệu cho phép nhà phát triển gửi tối đa 4KB cặp khóa-giá trị tùy chỉnh. Cả khóa và giá trị đều phải là chuỗi. Khóa có thể là bất kỳ chuỗi tùy chỉnh nào, ngoại trừ các chuỗi dành riêng sau:
  • from
  • Bất cứ điều gì bắt đầu với google.
Xem Xây dựng gửi yêu cầu mẫu mã và tài liệu chi tiết.
Tùy chọn Fcm Trình bày các tùy chọn không phụ thuộc vào nền tảng cho các tính năng do SDK FCM cung cấp.
Cài đặt ánh sáng Thể hiện cài đặt để điều khiển đèn LED thông báo có thể được bao gồm trong AndroidNotification .
Nhắn tinĐiều kiệnPhản hồi Giao diện thể hiện phản hồi của máy chủ từ phương thức Messaging.sendToCondition() cũ. 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.
Nhắn tinThiết bịNhómPhản hồi Giao diện thể hiện phản hồi của máy chủ từ phương thức Messaging.sendToDeviceGroup() . Xem Gửi tin nhắn đến nhóm thiết bị để biết mẫu mã và tài liệu chi tiết.
Nhắn tinThiết bịKết quả Tải trọng phản hồi trạng thái riêng lẻ từ các thiết bị đơn lẻ
Tin nhắnThiết bịPhản hồi Giao diện biểu thị trạng thái của tin nhắn được gửi đến một thiết bị riêng lẻ thông qua API kế thừa FCM. Xem Gửi tới từng thiết bị để biết mẫu mã và tài liệu chi tiết.
Tùy chọn nhắn tin Giao diện thể hiện các tùy chọn có thể được cung cấp khi gửi tin nhắn qua API kế thừa FCM. Xem Xây dựng gửi yêu cầu mẫu mã và tài liệu chi tiết.
Tải trọng tin nhắn Giao diện đại diện cho tải trọng tin nhắn Firebase Cloud Messaging. Cần có một hoặc cả hai khóa datanotification . Xem Xây dựng gửi yêu cầu mẫu mã và tài liệu chi tiết.
Nhắn tinChủ đềQuản lýPhản hồi Giao diện thể hiện phản hồi của máy chủ từ các phương thức Messaging.subscribeToTopic()Messaging.unsubscribeFromTopic() . Xem Quản lý chủ đề từ máy chủ để biết mẫu mã và tài liệu chi tiết.
Nhắn tinTopicResponse Giao diện thể hiện phản hồi của máy chủ từ phương thức Messaging.sendToTopic() cũ. Xem Gửi đến chủ đề để biết mẫu mã và tài liệu chi tiết.
Tin nhắn Multicast Tải trọng cho 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 Tin nhắn .
Thông báoTin nhắnTải trọng 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.
Gửi phản hồi Giao diện thể hiện trạng thái của một tin nhắn riêng lẻ được gửi như một phần của yêu cầu hàng loạt.
tin nhắn mã thông báo
Chủ đềTin nhắn
WebpushConfig Thể hiện các tùy chọn giao thức WebPush có thể được đưa vào Tin nhắn .
WebpushFcmTùy chọn Thể hiện các tùy chọn cho các tính năng do FCM SDK dành cho Web cung cấp (không thuộc tiêu chuẩn Webpush).
WebpushThông báo Đại diện cho các tùy chọn thông báo dành riêng cho WebPush có thể được bao gồm trong WebpushConfig . Điều này hỗ trợ hầu hết các tùy chọn tiêu chuẩn như được xác định trong đặc tả Thông báo Web .

Nhập bí danh

Nhập bí danh Sự miêu tả
Tin nhắn Tải trọng cho 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()

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 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 được 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ố

Tham số Kiểu Sự miêu tả
ứng dụng Ứng dụng Ứng dụng tùy chọn có dịch vụ Messaging sẽ quay trở lại. Nếu không được cung cấp, dịch vụ Messaging mặc định sẽ được trả về.

Trả về:

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 được liên kết với ứng dụng được 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);

Tin nhắn

Tải trọng cho 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.

Chữ ký:

export type Message = TokenMessage | TopicMessage | ConditionMessage;