html5 plus.push,Push - 《HTML5 Plus API 指南》 - 书栈网 · BookStack
push
Push模块管理推送消息功能,可以实现在线、离线的消息推送,通过plus.push可获取推送消息管理对象。
方法:
对象:ClientInfo: JSON对象,获取的客户端标识信息
PushMessage: JSON对象,推送消息对象
MessageOptions: JSON对象,获客户端创建本地消息的参数
回调方法:
权限:
permissions{
// ...
"permissions":{
// ...
"Push":{
"description":"消息推送"
}
}
}
属性:cover: 设定显示推送消息的模式可取值true或false,true表示推送消息覆盖模式显示,即仅显示最后接收到的推送消息;false表示在系统消息中心显示多条消息。默认值为ture。
平台支持Android - 2.2+ (支持)
iOS - 4.3+ (不支持): 不支持覆盖消息,每条信息都在系统消息中心,忽略cover属性值。
addEventListener
添加推送消息事件监听器voidplus.push.addEventListener(event,listener,Boolean);
说明:
添加推送消息事件监听器,当指定推送事件发出时触发。
参数:type: (String)必选事件类型支持事件类型:"click"-从系统消息中心点击消息启动应用事件;"receive"-应用从推送服务器接收到推送消息事件。
listener:
capture: (Boolean)可选是否捕获事件,此处可忽略
返回值:
void: 无
平台支持:Android- 2.2+(支持)
iOS- 4.3+(支持): 在客户端在运行时收到推送消息触发receive事件,离线接收到的推送消息全部进入系统消息中心。
示例:
Push Example
// 监听plusready事件
document.addEventListener("plusready",function(){
// 扩展API加载完毕,现在可以正常调用扩展API
// 添加监听从系统消息中心点击某条消息启动应用事件
plus.push.addEventListener("click",function(msg){
// 分析msg.payload处理业务逻辑
alert("You clicked: "+msg.content);
},false);
},false);
clear
清空所有推送消息voidplus.push.clear();
说明:
清空系统消息中心所有的推送消息。
参数:
无
返回值:
void: 无
createMessage
创建本地消息voidplus.push.createMessage(content,payload,option);
说明:
在本地直接创建推送消息,并添加到系统消息中心。
参数:content: (String)必选消息显示的内容,在系统通知中心中显示的文本内容。
payload: (String)可选消息承载的数据,可根据业务逻辑自定义数据格式。
options:
返回值:
void: 无
getAllMessage
获取所有推送消息PushMessage[]plus.push.getAllMessage();
说明:
获取客户端接收到的所有推送消息。仅包括在系统消息中心显示的推送消息,不包括调用setAutoNotification(false)方法设置不显示推送消息后接收到的消息。
参数:
无
返回值:
PushMessage: Array[PushMessage]对象,推送消息PushMessage数组。
平台支持:Android- 2.2+(支持)
iOS- 4.3+(不支持): 无法获取系统消息中心的消息列表,调用此方法返回空数组。
getClientInfo
获取客户端推送标识信息ClientInfoplus.push.getClientInfo();
说明:
客户端标识信息用于业务服务器下发推送消息时提交给推送服务器的数据,用于说明下发推送消息的接收者(客户端)。需要客户端在第一次运行时提交到业务服务器保存。
参数:
无
返回值:
ClientInfo: 客户端推送标识信息对象
示例:
Push Example
// 监听plusready事件
document.addEventListener("plusready",function(){
// 扩展API加载完毕,现在可以正常调用扩展API
// 获取客户端标识信息
varinfo=plus.push.getClientInfo();
alert(JSON.stringify(info));
// 添加监听从系统消息中心点击消息启动事件
plus.push.addEventListener("click",function(msg){
// 分析msg.payload处理业务逻辑
alert("You clicked: "+msg.content);
},false);
},false);
setAutoNotification
设置程序是否将消息显示在系统消息中心voidplus.push.setAutoNotification(notify);
说明:
默认情况下程序在接收到推送消息后将会在系统消息中心显示,通过此方法可关闭默认行为,接收到推送消息后不在系统消息中心显示,通过addEventListener方法的“receive”事件监听处理接收到的消息。在这种模式下可通过createMessage方法创建在系统消息中心显示的消息。
参数:notify: (Boolean)必选是否自动提示推送消息可取值true或false,true表示自动显示推送消息,false则不显示。默认值为true。
返回值:
void: 无
平台支持:Android- 2.2+(支持): 如果程序没有运行时接收到推送消息,则在程序启动后调用addEventListener方法监听“receive”事件时返回接收到的消息。注意:个推平台仅透传消息才支持此功能,其它消息依然会显示到系统消息中心。
iOS- 4.3+(不支持): 无法修改是否显示离线推送消息,当程序在前台运行时接收到消息时一定不会添加到系统消息中心,当程序在不再前台运行时一定会添加到系统消息中。
示例:
Push Example
// 监听plusready事件
document.addEventListener("plusready",function(){
// 扩展API加载完毕,现在可以正常调用扩展API
// 在程序运行时接收到的消息不显示在系统消息中心
plus.push.setAutoNotification(false);
},false);
remove
删除推送消息voidplus.push.remove(message)
说明:
删除系统消息中心指定的推送消息,可通过getAllMessage方法获取所有的消息后进行操作。
参数:message:
返回值:
void: 无
平台支持:Android- 2.2+(支持)
iOS- 4.3+(不支持): 无法对单条消息进行删除操作,可调用clear()方法清空所有消息。
ClientInfo
JSON对象,获取的客户端标识信息
属性:id: (String类型)推送通道标识目前支持以下推送通道:"igexin" - 表示个推推送;"mipush" - 表示小米推送;"unipush" - 表示DCloud UniPush。
token: (String类型)设备令牌(iOS设备唯一标识),用于APNS服务推送中标识设备的身份
平台支持Android - 2.2+ (支持): 设备的唯一标识号,通常与clientid值一致。
iOS - 4.5+ (支持): 设备的DeviceToken值,向APNS服务器发送推送消息时使用。clientid: (String类型)推送服务令牌(设备唯一标识),用于标识推送信息接收者身份第三方推送服务器管理的设备唯一标识,在iOS平台此值通常与token不同;在其它平台此值通常与token值一致。此值与设备及应用都相关,即不同的apk/ipa安装到同一台设备上的值都不相同。appid: (String类型)第三方推送服务的应用标识第三方推送服务器管理的应用标识,通常需要在第三方推送服务器平台进行注册获取。
appkey: (String类型)第三方推送服务器的应用键值第三方推送服务器管理的应用键值,通常需要在第三方推送服务器平台进行注册获取。
PushMessage
JSON对象,推送消息对象
属性:title: (String类型)推送消息显示的标题
平台支持Android - 2.2+ (支持)
iOS - ALL (支持): 。content: (String类型)推送消息显示的内容
payload: (JSON类型)推送消息承载的数据如果推送消息中传输的数据不符合JSON格式,则作为String类型数据保存。aps: _(JSON类型)_Apple APNS推送协议数据
平台支持Android - 2.2+ (不支持): 不支持此数据,返回值为undefined。
iOS - 5.0+ (支持): 仅封装标准APNS协议中的数据,其它数据封装在payload中。如果是通过本地API创建的消息此属性值则为undefined。
MessageOptions
JSON对象,获客户端创建本地消息的参数
属性:appid: (String类型)要启动流应用的appid仅在流应用环境中有效,默认值为当前流应用的appid。
平台支持Android - ALL (不支持)
iOS - ALL (不支持)cover: (Boolean类型)是否覆盖上一次提示的消息可取值true或false,true为覆盖,false不覆盖。默认为false。
平台支持Android - ALL (支持)
iOS - 10.0+ (支持): iOS10以下系统不支持覆盖。delay: (Number类型)提示消息延迟显示的时间当设备接收到推送消息后,可不立即显示,而是延迟一段时间显示,延迟时间单位为s,默认为0s,立即显示。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”。
平台支持Android - 2.3+ (支持)
iOS - ALL (支持): 当程序在前台运行时,提示音不生效。注:通常应该设置延迟时间,当程序切换到后台才创建本地推送消息时生效。title: (String类型)推送消息的标题在系统消息中心显示的通知消息标题,默认值为程序的名称。
平台支持Android - ALL (支持)
iOS - 10+ (支持): iOS10及以上版本支持设置标题,低版本忽略此属性。subtitle: (String类型)推送消息的副标题
平台支持Android - ALL (不支持)
iOS - 10+ (支持): iOS10及以上版本支持设置副标题,低版本忽略此属性。when: (Date类型)消息上显示的提示时间默认为当前时间,如果延迟显示则使用延时后显示消息的时间。
平台支持Android - ALL (支持)
iOS - ALL (不支持): 不支持设定消息的显示时间,由系统自动管理消息的创建时间。
PushReceiveCallback
客户端接收到推动消息的回调函数voidonReceive(msg){
// Recieved push message code.
}
参数:msg: (String)必选接收到的推送信息msg
返回值:
void: 无
PushClickCallback
用户点击推送消息事件的回调函数voidonClick(msg){
// Clicked push message code.
}
参数:msg: (String)必选用户点击的推送信息msg
返回值:
void: 无
html5 plus.push,Push - 《HTML5 Plus API 指南》 - 书栈网 · BookStack相关推荐
- html5 api navigator,Navigator - 《HTML5 Plus API 指南》 - 书栈网 · BookStack
navigator navigator用于管理浏览器运行环境信息 方法: 对象: 回调方法: 权限: 5+功能模块(permissions){ // ... "permissions&quo ...
- typeorm mysql2_指南 - 使用 TypeORM 和 Express 的示例 - 《TypeORM v0.2.20 中文文档》 - 书栈网 · BookStack...
使用 TypeORM 和 Express 的示例 初始设置 让我们创建一个名为"user"的简单应用程序,它将用户存储在数据库中 并允许我们在 web api 创建.更新.删除和获 ...
- linux 分析磁盘性能,03.分析性能瓶颈 - 3.4.磁盘瓶颈 - 《Linux性能调优指南》 - 书栈网 · BookStack...
磁盘瓶颈磁盘瓶颈性能调优选项 磁盘子系统通常是服务器性能的最重要方面,是瓶颈问题的高发部件.但是,磁盘问题表现的有时候并不是那么直接,比如说可能是内存不足.如果CPU周期浪费在等待I/O任务完成,应用 ...
- apollo local 模式_Java客户端使用指南 - 五、本地开发模式 - 《携程 Apollo v1.4 开发指南》 - 书栈网 · BookStack...
五.本地开发模式 Apollo客户端还支持本地开发模式,这个主要用于当开发环境无法连接Apollo服务器的时候,比如在邮轮.飞机上做相关功能开发. 在本地开发模式下,Apollo只会从本地文件读取配置 ...
- px4 uavcan linux,UAVCAN总线 - UAVCAN固件升级 - 《PX4开发指南》 - 书栈网 · BookStack
UAVCAN 固件升级 电子调速器(ESC)矢量控制代码库 (Pixhawk ESC 1.6 and S2740VC) 下载ESC代码: git clone https://github.com/th ...
- linux tcp压测工具,02.监控和压测工具 - 2.4.压测工具 - 《Linux性能调优指南》 - 书栈网 · BookStack...
压测工具其它有用工具 在这里,我们会讨论主要的压力测试工具,选择合适的压测工具,才能准确衡量系统性能.好的压测工具有很多,可能的功能如下: 发起压力 监控性能 监控系统使用率 生成报告 基准测试无非就 ...
- python3怎么使用pyrex_用户指南 - Cython 和 Pyrex 之间的区别 - 《Cython 3.0 中文文档》 - 书栈网 · BookStack...
Cython 和 Pyrex 之间的区别 警告 Cython 和 Pyrex 都是移动目标.已经到了这一点,两个项目之间所有差异的明确列表将很难列出和跟踪,但希望这个高级列表能够了解存在的差异.应该注 ...
- HTML5 Audio标签方法和函数API介绍
问说网 > 文章教程 > 网页制作 > HTML5 Audio标签方法和函数API介绍 Audio APIHTML5HTML5 Audio预加载 HTML5 Audio标签方法和函 ...
- HTML5视频教程,HTML5项目实战,HTML5中文指南,HTML5使用手册
HTML5视频教程,HTML5项目实战,HTML5中文指南,HTML5使用手册. 超过2G 的 HTML5 视频教程免费分享,免费下载! 尚硅谷前端HTML5视频_HTML & CSS 核心基 ...
最新文章
- 中科院团队用算法追上谷歌“量子霸权”:谷歌量子处理器并没有比E级超算快...
- Polymorphic form--多态表单
- MongoDB最简单的入门教程之三 使用Java代码往MongoDB里插入数据
- 如何在 Kubernetes 上配置 Jenkins?
- @PathVariable为空时指定默认值
- fafu oj 1266 数数
- Python入门--创建类的对象
- 编译android模拟器,编译Android模拟器(make sdk),以及错误处理
- YUV444、YUV422、YUV420占用字节数
- matlab fftshift
- empty是什么意思 php,empty是什么意思中文翻译
- 1+X web证书(高级)的重要知识点的复习
- 社会网络分析:探索人人网好友推荐系统
- 狂神。JavaWeb学习(2)
- Flink学习笔记【巨详细!】(二)
- C语言(百钱买百鸡问题)
- 数字设计ic芯片流程
- CSDN博文大赛赛况简报
- 高通kernel 补丁网址
- 超详细版企业离线部署CDH6.10集群与配置使用