diff --git a/docs/uniCloud/uni-cloud-push/api.md b/docs/uniCloud/uni-cloud-push/api.md index 34c1377f64048caf9f8d7a6aea5710b6b17cf838..baf43a39b08c399e83cf847de1ccd26e15e278fe 100644 --- a/docs/uniCloud/uni-cloud-push/api.md +++ b/docs/uniCloud/uni-cloud-push/api.md @@ -77,7 +77,7 @@ await uniPush.sendMessage(OBJECT) |check_token|Boolean|否|true|校验客户端登陆状态是否有效(含token过期)
仅通过`user_id`、`user_tag`指定消息接收者时有效| | |title|String|是|无|通知栏标题,长度小于20|APP| |content|String|是|无|通知栏内容,长度小于50|APP| -|payload|String、Object|是|无|推送透传数据,app程序接受的数据,长度小于800;
注意:为了确保离线厂商通道,可以获得payload的值,请用Object格式如:`{"text":"xxx"}`| | +|payload|String、Object|是|无|推送透传数据,app程序接受的数据,长度小于800字符;
注意:为了确保离线厂商通道,可以获得payload的值,请用Object格式如:`{"text":"xxx"}`| | |force_notification|Boolean|否|false|无论是离线推送还是在线推送,都自创建通知栏消息。HBuilderX 3.5.2 及其以上版本的客户端支持| App| |badge|Number、String|否|+1|设置应用右上角数字,用于提醒用户未阅读消息数量,支持在原有数字上的+、-操作;
例如:badge=+1,表示当前角标+1;
badge=-1,(仅iOS支持)表示当前角标-1(角标>=0);
badge=1,(仅iOS和华为EMUI版本10.0.0+支持)表示当前角标置成1。| ios、android-华为| |channel|Object|否|无|消息渠道设置,避免被限量推送、静默推送(静音且需下拉系统通知栏才可见通知内容),需要在各家发邮件申请,详情下方[channel说明](#channel)
此功能依赖uni原生插件[点此打开](https://ext.dcloud.net.cn/plugin?id=7482)打包后生效。| android|