Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
DCloud
unidocs-zh
提交
73c7f0eb
unidocs-zh
项目概览
DCloud
/
unidocs-zh
通知
3211
Star
106
Fork
815
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
94
列表
看板
标记
里程碑
合并请求
70
DevOps
流水线
流水线任务
计划
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
unidocs-zh
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
94
Issue
94
列表
看板
标记
里程碑
合并请求
70
合并请求
70
Pages
DevOps
DevOps
流水线
流水线任务
计划
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
流水线任务
提交
Issue看板
提交
73c7f0eb
编写于
2年前
作者:
DCloud_JSON
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
添加 uni.createPushMessage文档
上级
354484a8
master
auto-translate
dev
docs/merge-docs
feat-renderjs
fix-title_By_HRK
m0_73422081-master-patch-62620
shili8889-master-patch-08795
shili8889-master-patch-18004
无相关合并请求
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
31 addition
and
3 deletion
+31
-3
docs/uniCloud/uni-cloud-push/api.md
docs/uniCloud/uni-cloud-push/api.md
+31
-3
未找到文件。
docs/uniCloud/uni-cloud-push/api.md
浏览文件 @
73c7f0eb
...
...
@@ -12,7 +12,7 @@
## 客户端API
### getPushClientId(OBJECT)
###
uni.
getPushClientId(OBJECT)
获取客户端唯一的推送标识
注意:这是一个异步的方法,且仅支持uni-push2.0
...
...
@@ -57,7 +57,7 @@
```
### onPushMessage([callback,eventName])
###
uni.
onPushMessage([callback,eventName])
启动监听推送消息事件
代码示例:
```
js
...
...
@@ -71,7 +71,7 @@ uni.onPushMessage((res)=>{
|type |String | 事件类型,"click"-从系统推送服务点击消息启动应用事件;"receive"-应用从推送服务器接收到推送消息事件。|
|data |String、Object|消息内容|
### offPushMessage([eventName])
###
uni.
offPushMessage([eventName])
关闭推送消息监听事件
示例代码:
```
js
...
...
@@ -87,6 +87,33 @@ uni.offPushMessage(eventName);
-
如果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 |否 |推送消息的标题,在系统消息中心显示的通知消息标题,默认值为程序的名称。
</br>
Android - ALL (支持)
</br>
iOS - 5.0+ (不支持): 不支持设置消息的标题,固定为程序的名称。 |
|content |string |是 |消息显示的内容,在系统通知中心中显示的文本内容。 |
|payload |string、Object |否 |消息承载的数据,可根据业务逻辑自定义数据格式。 |
|icon |string |否 |推送消息的图标
</br>
本地图片地址,相对路径 - 相对于当前页面的host位置,如"a.jpg",注意当前页面为网络地址则不支持; 绝对路径 - 系统绝对路径,如Android平台"/sdcard/logo.png",此类路径通常通过其它5+ API获取的; 扩展相对路径URL(RelativeURL) - 以"_"开头的相对路径,如"_www/a.jpg"; 本地路径URL - 以“file://”开头,后面跟随系统绝对路径。
</br>
Android - 2.3+ (支持)
</br>
iOS - ALL (不支持): 不支持自定义图片,固定使用应用图标。 |
|sound |string |否 |'system' 'none'推送消息的提示音
</br>
显示消息时的播放的提示音,可取值: “system”-表示使用系统通知提示音; “none”-表示不使用提示音; 默认值为“system”。
</br>
Android - 2.3+ (支持)
</br>
iOS - 5.1+ (支持): 当程序在前台运行时,提示音不生效。 注:通常应该设置延迟时间,当程序切换到后台才创建本地推送消息时生效。 |
|cover |boolean |否 |是否覆盖上一次提示的消息
</br>
可取值true或false,true为覆盖,false不覆盖,默认为permission中设置的cover值
</br>
Android - ALL (支持)
</br>
iOS - 5.0+ (不支持): 不支持覆盖消息,只能创建新的消息。 |
|delay |number |否 |提示消息延迟显示的时间
</br>
当设备接收到推送消息后,可不立即显示,而是延迟一段时间显示,延迟时间单位为s,默认为0s,立即显示。 |
|when |Date |否 |消息上显示的提示时间
</br>
默认为当前时间,如果延迟显示则使用延时后显示消息的时间。
</br>
Android - ALL (支持)
</br>
iOS - 5.0+ (不支持): 不支持设定消息的显示时间,由系统自动管理消息的创建时间。 |
|success |Function |否 |接口调用成功的回调函数 |
|fail |Function |否 |接口调用失败的回调函数 |
|complete |Function |否 |接口调用结束的回调函数(调用成功、失败都会执行) |
## 服务端Api @uni-cloud-push
以下为uni-cloud-push扩展库的api文档;关于uni-cloud-push扩展库的详细介绍,以及如何在需要操作uni-push的云函数里,手动配置uni-cloud-push扩展库
[
详情参考
](
https://uniapp.dcloud.io/unipush-v2.html#%E7%AC%AC%E5%9B%9B%E6%AD%A5-%E6%9C%8D%E5%8A%A1%E7%AB%AF%E6%8E%A8%E9%80%81%E6%B6%88%E6%81%AF
)
...
...
@@ -133,6 +160,7 @@ await uniPush.sendMessage(OBJECT)
|title|String|是|无|通知栏标题,长度小于20|APP|
|content|String|是|无|通知栏内容,长度小于50|APP|
|payload|String、Objcet|是|无|推送透传数据,app程序接受的数据,长度小于800| |
|forceNotification|Boolean|否|false|无论是离线推送还是在线推送,都自创建通知栏消息。HBuilderX 3.5.2 及其以上版本的客户端支持| App|
|badge|Number、String|否|无|设置应用右上角数字,用于提醒用户未阅读消息数量,支持在原有数字上的+、-操作;
</br>
例如:badge=+1,表示当前角标+1;
</br>
badge=-1,(仅iOS支持)表示当前角标-1(角标>=0);
</br>
badge=1,(仅iOS和华为EMUI版本10.0.0+支持)表示当前角标置成1。| ios、android-华为|
|channel|Object|否|无|消息渠道设置,避免被限量推送、静默推送(静音且需下拉系统通知栏才可见通知内容),需要在各家发邮件申请,详情下方
[
channel说明
](
#channel
)
| android|
|request_id|String|否|无|请求唯一标识号,10-32位之间;如果
`request_id`
重复,会导致消息丢失||
...
...
This diff is collapsed.
Click to expand it.
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录
反馈
建议
客服
返回
顶部