Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
littlefishear
unidocs-zh
提交
506688a3
unidocs-zh
项目概览
littlefishear
/
unidocs-zh
与 Fork 源项目一致
Fork自
DCloud / unidocs-zh
通知
1
Star
0
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
DevOps
流水线
流水线任务
计划
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
unidocs-zh
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
DevOps
DevOps
流水线
流水线任务
计划
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
流水线任务
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
未验证
提交
506688a3
编写于
7月 20, 2022
作者:
DCloud_JSON
提交者:
Gitee
7月 20, 2022
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
update docs/api/plugins/push.md.
上级
bac8bf14
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
108 addition
and
107 deletion
+108
-107
docs/api/plugins/push.md
docs/api/plugins/push.md
+108
-107
未找到文件。
docs/api/plugins/push.md
浏览文件 @
506688a3
> 以下为uni-push2.0的api文档,业务介绍[详情参考](/unipush-v2)
`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
[
详情参考
](
https://uniapp.dcloud.io/unipush-v2.html#%E7%AC%AC%E4%B8%80%E6%AD%A5-%E5%BC%80%E9%80%9A
)
2.
客户端对应平台是否已启用uni-push2.0
[
详情参考
](
https://uniapp.dcloud.io/unipush-v2.html#%E5%AE%A2%E6%88%B7%E7%AB%AF%E5%90%AF%E7%94%A8unipush2-0
)
示例代码:
```
js
uni
.
getPushClientId
({
success
:
(
res
)
=>
{
console
.
log
(
res
.
cid
);
},
fail
(
err
)
{
console
.
log
(
err
)
}
})
```
### uni.onPushMessage([callback,eventName])
启动监听推送消息事件
代码示例:
```
js
uni
.
onPushMessage
((
res
)
=>
{
console
.
log
(
res
)
})
```
#### 回调参数说明
|名称 |类型 |描述 |
|-- |-- |-- |
|type |String | 事件类型,"click"-从系统推送服务点击消息启动应用事件;"receive"-应用从推送服务器接收到推送消息事件。|
|data |String、Object|消息内容|
### uni.offPushMessage([eventName])
关闭推送消息监听事件
示例代码:
```
js
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 |否 |推送消息的标题,在系统消息中心显示的通知消息标题,默认值为程序的名称。
</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 |否 |接口调用结束的回调函数(调用成功、失败都会执行)
> 以下为uni-push2.0的api文档,业务介绍[详情参考](/unipush-v2)
`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
[
详情参考
](
https://uniapp.dcloud.io/unipush-v2.html#%E7%AC%AC%E4%B8%80%E6%AD%A5-%E5%BC%80%E9%80%9A
)
2.
客户端对应平台是否已启用uni-push2.0
[
详情参考
](
https://uniapp.dcloud.io/unipush-v2.html#%E5%AE%A2%E6%88%B7%E7%AB%AF%E5%90%AF%E7%94%A8unipush2-0
)
3.
HBuilderX3.5.1 App平台vue3项目首次启动调用uni.getPushClientId 存在可能获取不到cid的问题,HBuilderX3.5.2修复了此问题,请升级。
示例代码:
```
js
uni
.
getPushClientId
({
success
:
(
res
)
=>
{
console
.
log
(
res
.
cid
);
},
fail
(
err
)
{
console
.
log
(
err
)
}
})
```
### uni.onPushMessage([callback,eventName])
启动监听推送消息事件
代码示例:
```
js
uni
.
onPushMessage
((
res
)
=>
{
console
.
log
(
res
)
})
```
#### 回调参数说明
|名称 |类型 |描述 |
|-- |-- |-- |
|type |String | 事件类型,"click"-从系统推送服务点击消息启动应用事件;"receive"-应用从推送服务器接收到推送消息事件。|
|data |String、Object|消息内容|
### uni.offPushMessage([eventName])
关闭推送消息监听事件
示例代码:
```
js
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 |否 |推送消息的标题,在系统消息中心显示的通知消息标题,默认值为程序的名称。
</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 |否 |接口调用结束的回调函数(调用成功、失败都会执行)
**其他相关资源**
...
...
@@ -129,6 +130,6 @@ uni.offPushMessage(eventName);
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
](
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
)
华为快应用推送文档:
[
https://developer.huawei.com/consumer/cn/doc/development/quickApp-References/webview-api-hwpush
](
https://developer.huawei.com/consumer/cn/doc/development/quickApp-References/webview-api-hwpush
)
华为快应用推送文档:
[
https://developer.huawei.com/consumer/cn/doc/development/quickApp-References/webview-api-hwpush
](
https://developer.huawei.com/consumer/cn/doc/development/quickApp-References/webview-api-hwpush
)
## 服务端Api [详情参考](/uniCloud/uni-cloud-push/api)
\ No newline at end of file
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录