未验证 提交 1f9c51ba 编写于 作者: DCloud_JSON's avatar DCloud_JSON 提交者: Gitee

update docs/uniCloud/uni-push.md.

上级 5e52670f
...@@ -155,8 +155,8 @@ const uniPush = uniCloud.push({appid:"__UNI__XXXXXX"}) //注意这里需要传 ...@@ -155,8 +155,8 @@ const uniPush = uniCloud.push({appid:"__UNI__XXXXXX"}) //注意这里需要传
exports.main = async (event, context) => { exports.main = async (event, context) => {
return await uniPush.sendMessage({ return await uniPush.sendMessage({
"user_id": "cbddf0af60d46da61252b29f4e4e6339", "user_id": "cbddf0af60d46da61252b29f4e4e6339",
"title": "离线时显示的标题", "title": "通知栏显示的标题",
"subtitle": "离线时显示的副标题", "content": "通知栏显示的内容",
"payload": { "payload": {
"type": "im", "type": "im",
"data": { "data": {
...@@ -188,7 +188,7 @@ await uniPush.sendMessage(OBJECT) ...@@ -188,7 +188,7 @@ await uniPush.sendMessage(OBJECT)
|alias|String、Array|否|无|基于用户别名,指定消息接收者。</br>支持多个以数组的形式指定多个设备,如["alias-1","alias-2"],数组长度不大于1000| | |alias|String、Array|否|无|基于用户别名,指定消息接收者。</br>支持多个以数组的形式指定多个设备,如["alias-1","alias-2"],数组长度不大于1000| |
|cid|String、Array|否|无|基于uni.getPushCid获取的客户端推送标识,指定消息接收者。</br>支持多个以数组的形式指定多个设备,如["cid-1","cid-2"],数组长度不大于1000| | |cid|String、Array|否|无|基于uni.getPushCid获取的客户端推送标识,指定消息接收者。</br>支持多个以数组的形式指定多个设备,如["cid-1","cid-2"],数组长度不大于1000| |
|title|String|是|无|通知栏标题,长度小于20|APP-PLUS| |title|String|是|无|通知栏标题,长度小于20|APP-PLUS|
|subtitle|String|是|无|通知栏内容,长度小于50|APP-PLUS| |content|String|是|无|通知栏内容,长度小于50|APP-PLUS|
|payload|String、Objcet|是|无|透传内容,长度小于800| | |payload|String、Objcet|是|无|透传内容,长度小于800| |
|badge|Number、String|否|无|设置应用右上角数字,用于提醒用户未阅读消息数量,支持在原有数字上的+、-操作;</br>例如:badge=+1,表示当前角标+1;</br>badge=-1,(仅iOS支持)表示当前角标-1(角标>=0);</br>badge=1,(仅iOS和华为EMUI版本10.0.0+支持)表示当前角标置成1。| ios、android-华为| |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|Json|否|无|消息渠道设置,避免被限量推送,需要在各家发邮件申请,详情下方[channel说明](#channel 说明)| android| |channel|Json|否|无|消息渠道设置,避免被限量推送,需要在各家发邮件申请,详情下方[channel说明](#channel 说明)| android|
...@@ -269,6 +269,7 @@ await uniPush.sendMessage(OBJECT) ...@@ -269,6 +269,7 @@ await uniPush.sendMessage(OBJECT)
``` ```
>返回结构说明请参考[公共返回结构](#公共返回结构) >返回结构说明请参考[公共返回结构](#公共返回结构)
* 返回参数`data`说明 * 返回参数`data`说明
| 名称 | 类型 | 描述 | | 名称 | 类型 | 描述 |
| ------ | ---- | -------- | | ------ | ---- | -------- |
| $taskid | Json | 任务编号 | | $taskid | Json | 任务编号 |
...@@ -303,6 +304,7 @@ await uniPush.sendMessage(OBJECT) ...@@ -303,6 +304,7 @@ await uniPush.sendMessage(OBJECT)
>返回结构说明请参考[公共返回结构](#公共返回结构) >返回结构说明请参考[公共返回结构](#公共返回结构)
* 返回参数`data`说明 * 返回参数`data`说明
| 名称 | 类型 | 描述 | | 名称 | 类型 | 描述 |
| ------ | ---- | -------- | | ------ | ---- | -------- |
| $taskid | Json | 任务编号 | | $taskid | Json | 任务编号 |
...@@ -467,6 +469,7 @@ await push.cidBindAlias(OBJECT) ...@@ -467,6 +469,7 @@ await push.cidBindAlias(OBJECT)
* 请求参数说明 * 请求参数说明
数据列表,数组长度不大于1000 数据列表,数组长度不大于1000
| 名称 | 类型 | 是否必须 | 默认值 | 描述 | | 名称 | 类型 | 是否必须 | 默认值 | 描述 |
| --------- | ------------- | ---- | ---- | -------- | | --------- | ------------- | ---- | ---- | -------- |
| cid |String|是|无| cid,用户标识| | cid |String|是|无| cid,用户标识|
...@@ -571,6 +574,7 @@ await push.unboundAlias(Array) ...@@ -571,6 +574,7 @@ await push.unboundAlias(Array)
``` ```
* 请求参数说明 * 请求参数说明
| 名称 | 类型 | 是否必须 | 默认值 | 描述 | | 名称 | 类型 | 是否必须 | 默认值 | 描述 |
| --------- | ------------- | ---- | ---- | -------- | | --------- | ------------- | ---- | ---- | -------- |
| cid |String|是|无| 客户端标识| | cid |String|是|无| 客户端标识|
...@@ -638,6 +642,7 @@ await push.cidBindCustomTags(OBJECT) ...@@ -638,6 +642,7 @@ await push.cidBindCustomTags(OBJECT)
``` ```
* 请求参数说明 * 请求参数说明
| 名称 | 类型 | 是否必须 | 默认值| 说明 | | 名称 | 类型 | 是否必须 | 默认值| 说明 |
| ------ | ------ | ------ | ------ | ------ | | ------ | ------ | ------ | ------ | ------ |
| cid | String | 是 | 无 | 用户标识 | | cid | String | 是 | 无 | 用户标识 |
...@@ -1694,4 +1699,4 @@ uni.offPushMessage(eventName); ...@@ -1694,4 +1699,4 @@ uni.offPushMessage(eventName);
## 问题记录: ## 问题记录:
注意:3个月未登陆的cid会被清空,所以uni-id的token过期事件不能超过3个月否则有故障。 注意:3个月未登陆的cid会被清空,所以uni-id的token过期事件不能超过3个月否则有故障。
\ No newline at end of file
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册