@firebase/messaging/sw

函数

函数 说明
function(应用, ...)
getMessaging(应用) 检索 Firebase Cloud Messaging 实例。
function(messaging, ...)
experimentalSetDeliveryMetricsExportedToBigQueryEnabled(messaging, enable) 启用或停用将 Firebase Cloud Messaging 消息传送指标导出至 BigQuery 的功能。默认情况下，消息传送指标不会导出到 BigQuery。使用此方法可在运行时启用或停用导出。
onBackgroundMessage(messaging, nextOrObserver) 收到消息且应用在后台运行时调用。如果未显示活动窗口，则应用被视为在后台运行。
函数
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 getMessagingInSw(app?: FirebaseApp): Messaging;

参数

参数 类型 说明
应用 FirebaseApp

返回：

消息传送

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

function(messaging, ...)

ExperimentalSetDeliveryMetricsExportedToBigQueryEnabled(messaging, enable)

启用或停用将 Firebase Cloud Messaging 消息传送指标导出至 BigQuery 的功能。默认情况下，消息传送指标不会导出到 BigQuery。使用此方法可在运行时启用或停用导出。

签名：

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

参数

参数 类型 说明
消息传递 消息传送 FirebaseMessaging 实例。
启用 布尔值 Firebase Cloud Messaging 是否应将消息传送指标导出到 BigQuery。

返回：

void

onBackgroundMessage(messaging, nextOrObserver)

收到消息且应用在后台运行时调用。如果未显示活动窗口，则应用被视为在后台运行。

签名：

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

参数

参数 类型 说明
消息传递 消息传送 Messaging 实例。
nextOrObserver 观察 NextFn<<消息载荷 >|观察者<MessagePayload> 当系统收到消息且应用当前位于后台时，系统会调用此函数或定义了 next 的观察器对象。

返回：

退订

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

function()

isSupported()

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

签名：

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

返回：

Promise&lt;boolean&gt;

解析为布尔值的 Promise。