@firebase/messaging/sw

Chức năng

Chức năng Sự miêu tả
chức năng (ứng dụng, ...)
getMessaging(ứng dụng) Truy xuất phiên bản Nhắn tin qua đám mây của Firebase.
chức năng (nhắn tin, ...)
thử nghiệmSetDeliveryMetricsExportedToBigQueryEnabled(nhắn tin, bật) Bật hoặc tắt tính năng xuất số liệu gửi tin nhắn của Firebase Cloud Messaging sang BigQuery. Theo mặc định, số liệu gửi tin nhắn không được xuất sang BigQuery. Sử dụng phương pháp này để bật hoặc tắt tính năng xuất khi chạy.
onBackgroundMessage(nhắn tin, nextOrObserver) Được gọi khi nhận được tin nhắn trong khi ứng dụng ở chế độ nền. Một ứng dụng được coi là chạy nền nếu không có cửa sổ đang hoạt động nào được hiển thị.
chức năng()
được hỗ trợ() Kiểm tra xem tất cả các API được yêu cầu có tồn tại trong SW Context hay không

Giao diện

Giao diện Sự miêu tả
Tùy chọn Fcm Tùy chọn cho các tính năng do FCM SDK dành cho Web cung cấp. Xem WebpushFcmOptions .
Tùy chọn GetToken Tùy chọn cho getToken() .
Tin nhắnTải trọng Tải trọng tin nhắn chứa tải trọng thông báo được biểu thị bằng notificationPayload và tải trọng dữ liệu chứa số lượng cặp khóa-giá trị tùy ý được nhà phát triển gửi thông qua API Gửi .
Nhắn tin Giao diện công khai của SDK nhắn tin qua đám mây Firebase.
Tải trọng thông báo Hiển thị chi tiết thông báo. Thông tin chi tiết được gửi qua API gửi .

chức năng (ứng dụng, ...)

getMessaging(ứng dụng)

Truy xuất phiên bản Nhắn tin qua đám mây của Firebase.

Chữ ký:

export declare function getMessagingInSw(app?: FirebaseApp): Messaging;

Thông số

Tham số Kiểu Sự miêu tả
ứng dụng Ứng dụng Firebase

Trả về:

Nhắn tin

Phiên bản Nhắn tin qua đám mây của Firebase được liên kết với ứng dụng firebase được cung cấp.

chức năng (nhắn tin, ...)

thử nghiệmSetDeliveryMetricsExportedToBigQueryEnabled(nhắn tin, bật)

Bật hoặc tắt tính năng xuất số liệu gửi tin nhắn của Firebase Cloud Messaging sang BigQuery. Theo mặc định, số liệu gửi tin nhắn không được xuất sang BigQuery. Sử dụng phương pháp này để bật hoặc tắt tính năng xuất khi chạy.

Chữ ký:

export declare function experimentalSetDeliveryMetricsExportedToBigQueryEnabled(messaging: Messaging, enable: boolean): void;

Thông số

Tham số Kiểu Sự miêu tả
nhắn tin Nhắn tin Phiên bản FirebaseMessaging .
cho phép boolean Liệu Nhắn tin qua đám mây của Firebase có nên xuất số liệu gửi tin nhắn sang BigQuery hay không.

Trả về:

trống rỗng

onBackgroundMessage(nhắn tin, nextOrObserver)

Được gọi khi nhận được tin nhắn trong khi ứng dụng ở chế độ nền. Một ứng dụng được coi là chạy nền nếu không có cửa sổ đang hoạt động nào được hiển thị.

Chữ ký:

export declare function onBackgroundMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;

Thông số

Tham số Kiểu Sự miêu tả
nhắn tin Nhắn tin Ví dụ về Nhắn tin .
tiếp theoHoặcObserver Tiếp theoFn < Tin nhắnTải trọng > | Người quan sát < Tin nhắnTải trọng > Hàm này hoặc đối tượng quan sát được xác định next , được gọi khi nhận được tin nhắn và ứng dụng hiện đang ở chế độ nền.

Trả về:

Hủy đăng ký

Để ngừng nghe tin nhắn, hãy thực hiện chức năng trả về này

chức năng()

được hỗ trợ()

Kiểm tra xem tất cả các API được yêu cầu có tồn tại trong SW Context hay không

Chữ ký:

export declare function isSwSupported(): Promise<boolean>;

Trả về:

Lời hứa<boolean>

một Promise có thể phân giải thành boolean.