@firebase/messaging

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, ...)
deleteToken(nhắn tin) Xóa mã thông báo đăng ký được liên kết với phiên bản Nhắn tin này và hủy đăng ký phiên bản Nhắn tin khỏi đăng ký đẩy.
getToken(nhắn tin, tùy chọn) Đăng ký phiên bản Nhắn tin để nhận thông báo đẩy. Trả về mã thông báo đăng ký Nhắn tin qua đám mây Firebase có thể được sử dụng để gửi tin nhắn đẩy đến phiên bản Nhắn tin đó. Nếu quyền thông báo chưa được cấp thì phương pháp này sẽ yêu cầu người dùng cấp quyền. Lời hứa được trả lại sẽ từ chối nếu người dùng không cho phép ứng dụng hiển thị thông báo.
onMessage(nhắn tin, nextOrObserver) Khi nhận được tin nhắn đẩy và người dùng hiện đang ở trên một trang gốc của bạn, tin nhắn đó sẽ được chuyển đến trang đó và một sự kiện onMessage() sẽ được gửi cùng với tải trọng của tin nhắn đẩy.
chức năng()
được hỗ trợ() Kiểm tra xem tất cả các API bắt buộc có tồn tại trong trình duyệt 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 getMessagingInWindow(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, ...)

deleteToken(nhắn tin)

Xóa mã thông báo đăng ký được liên kết với phiên bản Nhắn tin này và hủy đăng ký phiên bản Nhắn tin khỏi đăng ký đẩy.

Chữ ký:

export declare function deleteToken(messaging: Messaging): Promise<boolean>;

Thông số

Tham số Kiểu Sự miêu tả
nhắn tin Nhắn tin Ví dụ về Nhắn tin .

Trả về:

Lời hứa<boolean>

Lời hứa sẽ được giải quyết khi mã thông báo đã được xóa thành công.

getToken(nhắn tin, tùy chọn)

Đăng ký phiên bản Nhắn tin để nhận thông báo đẩy. Trả về mã thông báo đăng ký Nhắn tin qua đám mây Firebase có thể được sử dụng để gửi tin nhắn đẩy đến phiên bản Nhắn tin đó.

Nếu quyền thông báo chưa được cấp thì phương pháp này sẽ yêu cầu người dùng cấp quyền. Lời hứa được trả lại sẽ từ chối nếu người dùng không cho phép ứng dụng hiển thị thông báo.

Chữ ký:

export declare function getToken(messaging: Messaging, options?: GetTokenOptions): Promise<string>;

Thông số

Tham số Kiểu Sự miêu tả
nhắn tin Nhắn tin Ví dụ về Nhắn tin .
tùy chọn Tùy chọn GetToken Cung cấp khóa vapid tùy chọn và đăng ký nhân viên dịch vụ tùy chọn.

Trả về:

Hứa<string>

Lời hứa được giải quyết bằng mã thông báo đăng ký FCM.

onMessage(nhắn tin, nextOrObserver)

Khi nhận được tin nhắn đẩy và người dùng hiện đang ở trên một trang gốc của bạn, tin nhắn đó sẽ được chuyển đến trang đó và một sự kiện onMessage() sẽ được gửi cùng với tải trọng của tin nhắn đẩy.

Chữ ký:

export declare function onMessage(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ười dùng hiện đang xem trang của bạ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 bắt buộc có tồn tại trong trình duyệt hay không.

Chữ ký:

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

Trả về:

Lời hứa<boolean>

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