uni.getPushClientId(OBJECT)
获取客户端唯一的推送标识
注意：这是一个异步的方法，且仅支持uni-push2.0；
OBJECT 参数说明
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| success | Function | 是 | 接口调用的回调函数，详见返回参数说明 |
| fail | Function | 否 | 接口调用失败的回调函数 |
| complete | Function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
success 返回参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| cid | String | 个推客户端推送id，对应uni-id-device表的push_clientid |
| errMsg | String | 错误描述 |
fail 返回参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| errMsg | String | 错误描述 |
常见报错：
getPushClientId:fail register fail: {\”errorCode\”:1,\”errorMsg\”:\”\”}
请检查：
- 当前应用是否已开通uni-push2.0
- 客户端对应平台是否已启用uni-push2.0
- HBuilderX3.5.1 App平台vue3项目首次启动调用uni.getPushClientId 存在可能获取不到cid的问题，HBuilderX3.5.2修复了此问题，请升级。
示例代码：
uni.getPushClientId({
success: (res) => {
console.log(res.cid);
},
fail(err) {
console.log(err)
}
})
uni.onPushMessage(callback)
启动监听推送消息事件
回调参数说明
| 名称 | 类型 | 描述 |
|---|---|---|
| type | String | 事件类型，”click”-从系统推送服务点击消息启动应用事件；”receive”-应用从推送服务器接收到推送消息事件。 |
| data | String、Object | 消息内容 |
代码示例：
uni.onPushMessage((res)=>{
console.log(res)
})
uni.offPushMessage(callback)
关闭推送消息监听事件
uni.createPushMessage(OBJECT)
创建本地通知栏消息（HBuilderX 3.5.2起支持）
OBJECT 参数说明
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| title | string | 否 | 推送消息的标题，在系统消息中心显示的通知消息标题，默认值为程序的名称。 Android – ALL (支持) iOS – 5.0+ (不支持): 不支持设置消息的标题，固定为程序的名称。 |
| content | string | 是 | 消息显示的内容，在系统通知中心中显示的文本内容。 |
| payload | string、Object | 否 | 消息承载的数据，可根据业务逻辑自定义数据格式。 |
| icon | string | 否 | 推送消息的图标 本地图片地址，相对路径 – 相对于当前页面的host位置，如”a.jpg”，注意当前页面为网络地址则不支持； 绝对路径 – 系统绝对路径，如Android平台”/sdcard/logo.png”，此类路径通常通过其它5+ API获取的； 扩展相对路径URL(RelativeURL) – 以”_”开头的相对路径，如”_www/a.jpg”； 本地路径URL – 以“file://”开头，后面跟随系统绝对路径。 Android – 2.3+ (支持) iOS – ALL (不支持): 不支持自定义图片，固定使用应用图标。 |
| sound | string | 否 | 显示消息时播放的提示音； 可取值： system表示使用系统通知提示音，none表示不使用提示音；(默认值为system)。注意：当程序在前台运行时，提示音不生效。 注：通常应该设置延迟时间，当程序切换到后台才创建本地推送消息时生效 支持的版本：Android 2.3+，iOS – 5.1+。 |
| cover | boolean | 否 | 是否覆盖上一次提示的消息 可取值： true或false，true为覆盖，false不覆盖，默认为permission中设置的cover值Android – ALL (支持) iOS – 5.0+ (不支持): 不支持覆盖消息，只能创建新的消息。 |
| delay | number | 否 | 提示消息延迟显示的时间 当设备接收到推送消息后，可不立即显示，而是延迟一段时间显示，延迟时间单位为s，默认为0s，立即显示。 |
| when | Date | 否 | 消息上显示的提示时间 默认为当前时间，如果延迟显示则使用延时后显示消息的时间。 Android – ALL (支持) iOS – 5.0+ (不支持): 不支持设定消息的显示时间，由系统自动管理消息的创建时间。 |
| channelId | string | 否 | 渠道id， 支持的版本：HBuilder X 4.02+ |
| category | string | 否 | 通知类别，支持的版本：HBuilder X 4.02+ |
| success | Function | 否 | 接口调用成功的回调函数 |
| fail | Function | 否 | 接口调用失败的回调函数 |
| complete | Function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
其他相关资源