Web

接口概览

API
描述
registerPush
注册推送服务, (必须在用户同意了隐私政策后,再调用该接口使用推送服务)。
unRegisterPush
关闭推送服务。
addPushListener
添加 Push 监听器。
removePushListener
移除 Push 监听器。

接口详情

注册推送服务

接口

registerPush(options): Promise<void>;

参数 options 说明

参数
类型
说明
SDKAppID
Number
推送服务 Push 的 SDKAppID。参考:快速接入 > 前置条件 > 开通服务 获取 SDKAppID。
appKey
String
推送服务 Push 的客户端密钥。参考:快速接入 > 前置条件 > 开通服务 获取 appKey。
userID
String
注册推送用户的 userID。用户的唯一标识符,由您定义,只能包含大小写字母(a-z,A-Z)、数字(0-9)、下划线和连字符。

关闭推送服务

接口

unRegisterPush(): Promise<void>;

添加 Push 监听器

接口

addPushListener(eventName: string, listener: (data: any) => void);

参数说明:

参数
类型
说明
eventName
String
推送事件类型:
WebPush.EVENT.MESSAGE_RECEIVED : 新通知到达。
WebPush.EVENT.MESSAGE_REVOKED:通知被撤回。
WebPush.EVENT.NOTIFICATION_CLICKED:通知被点击。
listener
Function
推送事件处理方法。

移除 Push 监听器

接口

removePushListener(eventName: string, listener?: (data: any) => void);

参数说明:

参数
类型
说明
eventName
String
推送事件类型:
WebPush.EVENT.MESSAGE_RECEIVED : 新通知到达。
WebPush.EVENT.MESSAGE_REVOKED:通知被撤回。
WebPush.EVENT.NOTIFICATION_CLICKED:通知被点击。
listener
Function | undefined
推送事件处理方法。