功能
功能 | 描述 |
---|---|
函数(应用程序,...) | |
获取消息(应用程序) | 检索 Firebase Cloud Messaging 实例。 |
功能(消息传递,...) | |
删除令牌(消息) | 删除与此Messaging实例关联的注册令牌,并从推送订阅中取消订阅Messaging实例。 |
getToken(消息,选项) | 订阅Messaging实例以推送通知。返回一个 Firebase Cloud Messaging 注册令牌,可用于将推送消息发送到该Messaging实例。如果尚未授予通知权限,此方法会请求用户授予权限。如果用户不允许应用程序显示通知,则返回的承诺将被拒绝。 |
onMessage(消息传递,nextOrObserver) | 当收到推送消息并且用户当前位于源页面上时,该消息将传递到该页面,并使用推送消息的有效负载调度onMessage() 事件。 |
功能() | |
isSupported() | 检查浏览器中是否存在所有必需的 API。 |
接口
界面 | 描述 |
---|---|
Fcm选项 | FCM SDK for Web 提供的功能选项。请参阅WebpushFcmOptions 。 |
获取令牌选项 | getToken()的选项。 |
消息负载 | 消息负载包含用NotificationPayload表示的通知负载和包含开发人员通过Send API发送的任意数量的键值对的数据负载。 |
消息传递 | Firebase 云消息传递 SDK 的公共接口。 |
通知负载 | 显示通知详细信息。详细信息通过发送 API 发送。 |
函数(应用程序,...)
获取消息(应用程序)
检索 Firebase Cloud Messaging 实例。
签名:
export declare function getMessagingInWindow(app?: FirebaseApp): Messaging;
参数
范围 | 类型 | 描述 |
---|---|---|
应用程序 | Firebase应用程序 |
返回:
与提供的 Firebase 应用关联的 Firebase Cloud Messaging 实例。
功能(消息传递,...)
删除令牌(消息)
删除与此Messaging实例关联的注册令牌,并从推送订阅中取消订阅Messaging实例。
签名:
export declare function deleteToken(messaging: Messaging): Promise<boolean>;
参数
范围 | 类型 | 描述 |
---|---|---|
消息传递 | 消息传递 | 消息传递实例。 |
返回:
承诺<布尔值>
当令牌被成功删除时,承诺就会解决。
getToken(消息,选项)
订阅Messaging实例以推送通知。返回一个 Firebase Cloud Messaging 注册令牌,可用于将推送消息发送到该Messaging实例。
如果尚未授予通知权限,此方法会请求用户授予权限。如果用户不允许应用程序显示通知,则返回的承诺将被拒绝。
签名:
export declare function getToken(messaging: Messaging, options?: GetTokenOptions): Promise<string>;
参数
范围 | 类型 | 描述 |
---|---|---|
消息传递 | 消息传递 | 消息传递实例。 |
选项 | 获取令牌选项 | 提供可选的 vapid 密钥和可选的 Service Worker 注册。 |
返回:
承诺<字符串>
该承诺通过 FCM 注册令牌来解决。
onMessage(消息传递,nextOrObserver)
当收到推送消息并且用户当前位于源页面上时,该消息将传递到该页面,并使用推送消息的有效负载调度onMessage()
事件。
签名:
export declare function onMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
参数
范围 | 类型 | 描述 |
---|---|---|
消息传递 | 消息传递 | 消息传递实例。 |
下一个或观察者 | 下一个Fn <消息有效负载> |观察者<消息有效负载> | 当收到消息并且用户当前正在查看您的页面时,将调用此函数或定义了next 观察者对象。 |
返回:
要停止侦听消息,请执行此返回的函数。
功能()
isSupported()
检查浏览器中是否存在所有必需的 API。
签名:
export declare function isWindowSupported(): Promise<boolean>;
返回:
承诺<布尔值>
解析为布尔值的 Promise。