@firebase/messaging

函数

函数 说明
function(应用, ...)
getMessaging(应用) 检索 Firebase Cloud Messaging 实例。
function(messaging, ...)
deleteToken(messaging) 删除与此 Messaging 实例关联的注册令牌，并为 Messaging 实例退订推送订阅。
getToken(messaging, options) 为 Messaging 实例订阅推送通知。返回一个 Firebase Cloud Messaging 注册令牌，该令牌可用于向该 Messaging 实例发送推送消息。如果尚未授予通知权限，此方法会要求用户授予权限。如果用户不允许应用显示通知，则返回的 promise 会拒绝。
onMessage(messaging, nextOrObserver) 收到推送消息且用户当前位于您源站的网页时，该消息会传递到该网页，并会分派 onMessage() 事件和推送消息的载荷。
函数
isSupported() 检查浏览器中是否存在所有必需的 API。

接口

接口 说明
FcmOptions Web 版 FCM SDK 所提供功能的选项。请参阅 WebpushFcmOptions。
GetTokenOptions getToken() 的选项。
MessagePayload 消息载荷包含通知载荷（用 NotificationPayload 表示）和数据载荷，数据载荷包含开发者通过 Send API 发送的任意数量的键值对。
消息传送 Firebase Cloud Messaging SDK 的公共接口。
通知载荷 显示通知详细信息。详细信息通过 Send API 发送。

function(应用, ...)

getMessaging(应用)

检索 Firebase Cloud Messaging 实例。

签名：

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

参数

参数 类型 说明
应用 FirebaseApp

返回：

消息传送

与提供的 Firebase 应用相关联的 Firebase Cloud Messaging 实例。

function(messaging, ...)

deleteToken(messaging)

删除与此 Messaging 实例关联的注册令牌，并为 Messaging 实例退订推送订阅。

签名：

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

参数

参数 类型 说明
消息传递 消息传送 Messaging 实例。

返回：

Promise&lt;boolean&gt;

成功删除令牌后，promise 进行解析。

getToken(messaging, options)

为 Messaging 实例订阅推送通知。返回一个 Firebase Cloud Messaging 注册令牌，该令牌可用于向该 Messaging 实例发送推送消息。

如果尚未授予通知权限，此方法会要求用户授予权限。如果用户不允许应用显示通知，则返回的 promise 会拒绝。

签名：

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

参数

参数 类型 说明
消息传递 消息传送 Messaging 实例。
选项 GetTokenOptions 提供可选的 vapid 密钥和可选的 Service Worker 注册。

返回：

承诺<字符串>

promise 使用 FCM 注册令牌进行解析。

onMessage(messaging, nextOrObserver)

收到推送消息且用户当前位于您源站的网页时，该消息会传递到该网页，并会分派 onMessage() 事件和推送消息的载荷。

签名：

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

参数

参数 类型 说明
消息传递 消息传送 Messaging 实例。
nextOrObserver 观察 NextFn<<消息载荷 >|观察者<MessagePayload> 当系统收到消息且用户当前正在查看您的页面时，系统会调用此函数或定义了 next 的观察器对象。

返回：

退订

如需停止监听消息，请执行此返回的函数。

function()

isSupported()

检查浏览器中是否存在所有必需的 API。

签名：

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

返回：

Promise&lt;boolean&gt;

解析为布尔值的 Promise。