uni-app

最近更新时间:2024-09-24 17:51:41

我的收藏

接口概览

API
描述
注册推送服务, (必须在 App 用户同意了隐私政策后,再调用该接口使用推送服务)。
反注册关闭推送服务。
RegistrationID 是推送接收设备的唯一标识 ID。默认情况下,注册推送服务成功时自动生成该 ID,同时也支持您自定义设置。您可根据 RegistrationID 向指定设备推送消息。需要注意的是,卸载并重新安装设备会更改 RegistrationID,因此需要在注册推送服务之前调用 setRegistrationID 接口。
在成功注册推送服务后,可通过调用 getRegistrationID 接口获取推送接收设备的唯一标识 ID,即RegistrationID。您可根据 RegistrationID 向指定设备推送消息。
获取点击透传的内容。需要在 App onShow 回调函数内调用。

接口详情

注册推送服务

接口

registerPush(SDKAppID, appKey, onSuccess, onError)

参数说明:

参数
类型
说明
获取路径
SDKAppID
Number
推送服务 Push 的 SDKAppID。



appKey
String
推送服务 Push 的客户端密钥。
onSuccess
Function
注册推送成功的回调。

onError
Function |undefined
注册推送失败的回调。


反注册关闭推送服务

接口

unRegisterPush(onSuccess, onError)

参数说明:

参数
类型
说明
onSuccess
Function
反注册推送成功的回调。
onError
Function |undefined
反注册推送失败的回调。

设置推送 ID 标识 RegistrationID

说明:
需要在注册推送服务之前调用。

接口

setRegistrationID(registrationID, onSuccess)

参数说明:

参数
类型
说明
registrationID
String
自定义的推送 ID 标识。
onSuccess
Function
设置自定义推送 ID 标识成功后的回调。

获取推送 ID 标识 RegistrationID

说明:
需要在注册推送服务成功之后调用。

接口

getRegistrationID(onSuccess)

参数说明:

参数
类型
说明
onSuccess
Function
获取推送 ID 标识成功的回调。

获取点击透传的内容

说明:
获取点击透传的内容。需要在 App onShow 回调函数内调用。

接口

getNotificationExtInfo(onSuccess)

参数说明:

参数
类型
说明
onSuccess
Function
获取点击透传的内容成功的回调。