push

Push模块管理推送消息功能，可以实现在线、离线的消息推送，通过plus.push可获取推送消息管理对象。

方法：

• addEventListener: 添加推送消息事件监听器
• clear: 清空所有推送消息
• createMessage: 创建本地消息
• getAllMessage: 获取所有推送消息
• getClientInfo: 获取客户端推送标识信息
• setAutoNotification: 设置客户端是否显示离线推送消息
• remove: 删除推送消息

对象：

• ClientInfo: JSON对象，获取的客户端标识信息
• PushMessage: JSON对象，推送消息对象
• MessageOption: JSON对象，获客户端创建本地消息的参数

回调方法：

• PushReceiveCallback: 客户端接收到推动消息的回调函数
• PushClickCallback: 用户点击推送消息事件的回调函数

权限：

permissions

"Push": {
	"description": "访问推送插件"
}
			

• cover: 设定显示推送消息的模式
  

  可取值true或false，true表示推送消息覆盖模式显示，即仅显示最后接收到的推送消息；false表示多条推送消息独立显示，将在消息中心中显示多条消息内容。默认值为ture。

  平台支持

  • Android2.2+ (支持)
  • iOS4.3+ (不支持): 不支持消息显示模式的设置，每条信息都在消息中心显示，忽略cover属性值。
  • WP7.5+ (不支持)

ClientInfo

JSON对象，获取的客户端标识信息

属性：

• token: (DOMString 类型 )设备令牌（iOS设备唯一标识），用于APNS服务推送中标识设备的身份
  
• clientid: (DOMString 类型 )推送服务令牌（设备唯一标识），用于标识推送信息接收者身份
  

  第三方推送服务器管理的设备唯一标识，在iOS平台此值通常与token不同；在其它平台此值通常与token值一致。

• appid: (DOMString 类型 )第三方推送服务的应用标识
  

  第三方推送服务器管理的应用标识，通常需要在第三方推送服务器平台进行注册获取。

• appkey: (DOMString 类型 )第三方推送服务器的应用键值
  

  第三方推送服务器管理的应用键值，通常需要在第三方推送服务器平台进行注册获取。

PushMessage

JSON对象，推送消息对象

属性：

• title: (DOMString 类型 )推送消息显示的标题
  
• content: (DOMString 类型 )推送消息显示的内容
  
• payload: (JSON 类型 )推送消息承载的数据
  

  如果推送消息中传输的数据不符合JSON格式，则作为String类型数据保存。

• aps: (JSON 类型 )Apple APNS推送协议数据
  

MessageOption

JSON对象，获客户端创建本地消息的参数

属性：

• title: (DOMString 类型 )推送消息的标题
  

  在系统消息中心显示，默认值为程序的名称。若不支持此属性，在系统通知中心显示的标题固定为程序的名称

• cover: (Boolean 类型 )是否覆盖上一次提示的消息
  

  可取值true或false，true为覆盖，false不覆盖，默认为permission中设置的cover值。

• when: (Date 类型 )消息上显示的提示时间
  

  默认为当前时间，如果使用的延迟显示则默认使用延时后的时间。

• delay: (Number 类型 )提示消息延迟显示的时间
  

  当设备接收到推送消息后，可不立即显示，而是延迟一段时间显示，延迟时间单位为s，默认为0s，立即显示。

PushReceiveCallback

客户端接收到推动消息的回调函数

void onReceive( msg ) {
	// Recieved push message code.
}
				

参数：

• msg: ( DOMString ) 必选 接收到的推送信息msg
  

返回值：

PushClickCallback

用户点击推送消息事件的回调函数

void onClick( msg ) {
	// Clicked push message code. 
}
				

参数：

• msg: ( DOMString ) 必选 用户点击的推送信息msg
  

返回值：