山东杰瑞数字做网站,丰都网站,行业网站建设报价,产品是做网站Push模块管理推送消息功能#xff0c;可以实现在线、离线的消息推送#xff0c;通过plus.push可获取推送消息管理对象。方法#xff1a;对象#xff1a;ClientInfo: JSON对象#xff0c;获取的客户端标识信息PushMessage: JSON对象#xff0c;推送消息对象MessageOptions…Push模块管理推送消息功能可以实现在线、离线的消息推送通过plus.push可获取推送消息管理对象。方法对象ClientInfo: JSON对象获取的客户端标识信息PushMessage: JSON对象推送消息对象MessageOptions: JSON对象获客户端创建本地消息的参数回调方法权限permissions{// ...permissions:{// ...Push: {description: 消息推送}}}属性cover: 设定显示推送消息的模式可取值true或falsetrue表示推送消息覆盖模式显示即仅显示最后接收到的推送消息false表示在系统消息中心显示多条消息。默认值为ture。平台支持Android - 2.2 (支持)iOS - 4.3 (不支持):不支持覆盖消息每条信息都在系统消息中心忽略cover属性值。添加推送消息事件监听器void plus.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);清空所有推送消息void plus.push.clear();说明清空系统消息中心所有的推送消息。参数无返回值void: 无创建本地消息void plus.push.createMessage( content, payload, option );说明在本地直接创建推送消息并添加到系统消息中心。参数content:(String)必选消息显示的内容在系统通知中心中显示的文本内容。payload:(String)可选消息承载的数据可根据业务逻辑自定义数据格式。options:创建消息的额外参数参考MessageOptions。返回值void: 无获取所有推送消息PushMessage[] plus.push.getAllMessage();说明获取客户端接收到的所有推送消息。仅包括在系统消息中心显示的推送消息不包括调用setAutoNotification(false)方法设置不显示推送消息后接收到的消息。参数无返回值PushMessage: Array[PushMessage]对象推送消息PushMessage数组。平台支持Android- 2.2(支持)iOS- 4.3(不支持):无法获取系统消息中心的消息列表调用此方法返回空数组。获取客户端推送标识信息ClientInfo plus.push.getClientInfo();说明客户端标识信息用于业务服务器下发推送消息时提交给推送服务器的数据用于说明下发推送消息的接收者(客户端)。通常需要客户端在第一次运行时获取并提交到业务服务器绑定。参数无返回值ClientInfo: 客户端推送标识信息对象示例Push Example// 监听plusready事件document.addEventListener(‘plusready’, function(){// 扩展API加载完毕现在可以正常调用扩展API// 获取客户端标识信息var info plus.push.getClientInfo();alert( JSON.stringify( info ) );// 添加监听从系统消息中心点击消息启动事件plus.push.addEventListener(‘click’, function(msg){// 分析msg.payload处理业务逻辑alert(You clicked: msg.content);}, false);}, false);异步获取客户端推送标识信息void plus.push.getClientInfoAsync(successCB, errorCB);说明HBuilderX2.5.11版本新增。用于解决plus.push.getClientInfo同步获取可能返回数据为空的问题。客户端标识信息用于业务服务器下发推送消息时提交给推送服务器的数据用于说明下发推送消息的接收者(客户端)。通常需要客户端在第一次运行时获取并提交到业务服务器绑定。参数successCB:成功获取客户端推送标识信息时触发。errorCB:获取客户端推送标识信息发生错误时触发。返回值void: 无示例function getPushInfo(){console.log(异步获取客户端推送标识信息);plus.push.getClientInfoAsync(function(info){console.log(Success);console.log(JSON.stringify(info));}, function(e){console.log(Failed);console.log(JSON.stringify(e));})}设置程序是否将消息显示在系统消息中心void plus.push.setAutoNotification( notify );说明默认情况下程序在接收到推送消息后将会在系统消息中心显示通过此方法可关闭默认行为接收到推送消息后不在系统消息中心显示通过addEventListener方法的“receive”事件监听处理接收到的消息。在这种模式下可通过createMessage方法创建在系统消息中心显示的消息。参数notify:(Boolean)必选是否自动提示推送消息可取值true或falsetrue表示自动显示推送消息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 );删除推送消息void plus.push.remove( message )说明删除系统消息中心指定的推送消息可通过getAllMessage方法获取所有的消息后进行操作。参数message:返回值void: 无平台支持Android- 2.2(支持)iOS- 4.3(不支持):无法对单条消息进行删除操作可调用clear()方法清空所有消息。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类型)第三方推送服务器的应用键值第三方推送服务器管理的应用键值通常需要在第三方推送服务器平台进行注册获取。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。JSON对象获客户端创建本地消息的参数属性appid: (String类型)要启动流应用的appid仅在流应用环境中有效默认值为当前流应用的appid。平台支持Android - ALL (不支持)iOS - ALL (不支持)cover: (Boolean类型)是否覆盖上一次提示的消息可取值true或falsetrue为覆盖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 (不支持):不支持设定消息的显示时间由系统自动管理消息的创建时间。客户端接收到推送消息的回调函数void onReceive( msg ) {// Recieved push message code.}参数msg:(String)必选接收到的推送信息msg返回值void: 无用户点击推送消息事件的回调函数void onClick( msg ) {// Clicked push message code.}参数msg:(String)必选用户点击的推送信息msg返回值void: 无异步获取客户端推送标识信息成功的回调函数void onSuccess( info ) {// getClientInfo success.}说明异步获取客户端推送标识信息成功时回调。参数info:返回值void: 无异步获取客户端推送标识信息失败的回调函数void onError(error){// Handle the errorvar code error.code; // 错误编码var message error.message; // 错误描述信息}说明异步获取推送标识信息失败时触发。参数error:(Exception)可选错误信息可通过error.code(Number类型)获取错误编码可通过error.message(String类型)获取错误描述信息。返回值void: 无
