以下为uni-push2.0的api文档,业务介绍详情参考

uni-push有服务器API和客户端API。

# 客户端API

# 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\":\"\"}
请检查:

  1. 当前应用是否已开通uni-push2.0 详情参考 (opens new window)
  2. 客户端对应平台是否已启用uni-push2.0详情参考 (opens new window)
  3. 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,eventName])

启动监听推送消息事件 代码示例:

uni.onPushMessage((res)=>{
	console.log(res)
})

# 回调参数说明

名称 类型 描述
type String 事件类型,"click"-从系统推送服务点击消息启动应用事件;"receive"-应用从推送服务器接收到推送消息事件。
data String、Object 消息内容

# uni.offPushMessage([eventName])

关闭推送消息监听事件 示例代码:

let eventName = (res)=>{
	console.log(res)
}
//启动推送事件监听
uni.onPushMessage(eventName);
//关闭推送事件监听
uni.offPushMessage(eventName);

# Tips

  • 如果uni.offPushMessage没有传入参数,则移除App级别的所有事件监听器;
  • 如果只提供了事件名(eventName),则移除该事件名对应的所有监听器;

# uni.createPushMessage(OBJECT)

创建本地通知栏消息(HBuilderX 3.5.2起支持)

平台差异说明

App H5 快应用 微信小程序 支付宝小程序 百度小程序 字节跳动小程序、飞书小程序 QQ小程序 快手小程序 京东小程序
x x x x x x x x x

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”-表示使用系统通知提示音; “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+ (不支持): 不支持设定消息的显示时间,由系统自动管理消息的创建时间。
success Function 接口调用成功的回调函数
fail Function 接口调用失败的回调函数
complete Function 接口调用结束的回调函数(调用成功、失败都会执行)

其他相关资源

# 小程序平台

小程序平台的类似概念叫做模板消息,也有的平台改名为订阅消息

以微信为例,开发者的服务器发送消息给微信的服务器,微信服务器会发送一条订阅消息,折叠到微信的消息列表中的服务通知里。它属于后台开发,和手机端无关。

如果使用uniCloud发送微信、支付宝订阅消息,参考:https://ext.dcloud.net.cn/plugin?id=1810 (opens new window)

微信订阅消息文档:https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/subscribe-message.html (opens new window)

支付宝模板消息文档:https://docs.alipay.com/mini/introduce/message (opens new window)

百度模板消息文档:https://smartprogram.baidu.com/docs/develop/third/api/ (opens new window)

字节跳动订阅消息文档:https://microapp.bytedance.com/docs/zh-CN/mini-app/develop/functional-plug-in/subscribemessage/ (opens new window)

QQ小程序订阅消息文档:https://q.qq.com/wiki/develop/miniprogram/frame/open_ability/open_message.html#%E8%AE%A2%E9%98%85%E6%B6%88%E6%81%AF (opens new window)

华为快应用推送文档:https://developer.huawei.com/consumer/cn/doc/development/quickApp-References/webview-api-hwpush (opens new window)

# 服务端Api 详情参考