@firebase/messaging/sw

功能

功能描述
函数(应用程序,...)
获取消息(应用程序)检索 Firebase Cloud Messaging 实例。
功能(消息传递,...)
ExperimentalSetDeliveryMetricsExportedToBigQueryEnabled(消息传递,启用)启用或禁用 Firebase Cloud Messaging 消息传送指标导出到 BigQuery。默认情况下,消息传送指标不会导出到 BigQuery。使用此方法可以在运行时启用或禁用导出。
onBackgroundMessage(消息传递,nextOrObserver)当应用程序在后台收到消息时调用。如果没有显示活动窗口,则应用程序被视为处于后台。
功能()
isSupported()检查所有必需的 API 是否存在于 SW 上下文中

接口

界面描述
Fcm选项FCM SDK for Web 提供的功能选项。请参阅WebpushFcmOptions
获取令牌选项getToken()的选项
消息负载消息负载包含用NotificationPayload表示的通知负载和包含开发人员通过Send API发送的任意数量的键值对的数据负载
消息传递Firebase 云消息传递 SDK 的公共接口。
通知负载显示通知详细信息。详细信息通过发送 API 发送

函数(应用程序,...)

获取消息(应用程序)

检索 Firebase Cloud Messaging 实例。

签名:

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

参数

范围类型描述
应用程序Firebase应用程序

返回:

消息传递

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

功能(消息传递,...)

ExperimentalSetDeliveryMetricsExportedToBigQueryEnabled(消息传递,启用)

启用或禁用 Firebase Cloud Messaging 消息传送指标导出到 BigQuery。默认情况下,消息传送指标不会导出到 BigQuery。使用此方法可以在运行时启用或禁用导出。

签名:

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

参数

范围类型描述
消息传递消息传递FirebaseMessaging实例。
使能够布尔值Firebase Cloud Messaging 是否应将消息传送指标导出到 BigQuery。

返回:

空白

onBackgroundMessage(消息传递,nextOrObserver)

当应用程序在后台收到消息时调用。如果没有显示活动窗口,则应用程序被视为处于后台。

签名:

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

参数

范围类型描述
消息传递消息传递消息传递实例。
下一个或观察者下一个Fn <消息有效负载> |观察者<消息有效负载>当收到消息并且应用程序当前位于后台时,将调用此函数或定义了next观察者对象。

返回:

退订

要停止监听消息,请执行此返回的函数

功能()

isSupported()

检查 SW 上下文中是否存在所有必需的 API

签名:

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

返回:

承诺<布尔值>

解析为布尔值的 Promise。