JPush


极光推送模块,第三方推送插件.需要开发者到极光官网注册appkey,并填写到pluginConfigs.xml配置文件中. 引擎会自动根据配置文件生成极光推送需要的PushConfig.plist配置文件.无需开发者手动生成. pluginConfigs.xml内的字段与PushConfig.plist内的字段一一对应. 详细配置教程请参考:http://docs.jpush.io/guideline/ios_guide

如何创建应用

  1. 登录极光官网,点击注册按钮 如下图:
    image
  2. 填写注册信息。点击注册。
    image 3.回到首页。用刚才注册所得帐号登录
    image 4.点击创建应用按钮。创建应用。
    image 5.按照图片要求配置相应参数。
    image iOS证书申请请参照http://docs.jpush.io/client/ios_tutorials/
    Android创建应用注意事项:
    (1)在控制台打开证书页面,Android证书 一键创建证书 如图所示:
    image
    (2)点击一键创建证书
    image
    (3)获取包名(将在控制台获取的包名,填写到Jpush的应用包名位置)
    image 6.配置结果如图所示。
    image

方法:

对象:

  • UserInfo :JSON对象,推送消息对象,内部封装了极光推送相关参数以及推送消息内容.
  • APS :JSON对象,UserInfo子对象, 内部封装了消息内容等.

回调方法:

配置文件:

init


注册推送服务.

rd.JPush.init();    
说明:

调用此方法启动推送服务.建议在onload方法中与addCallBack方法同时调用.

参数:

返回值:

无返回值

示例:
    onLoad = function(){
        rd.JPush.init();
        rd.JPush.addCallBack(receiveMessage,errorInfo);
    }

addCallBack


注册消息回调方法.通过回调方法可以获取到推送消息.

rd.JPush.addCallBack(receiveMessageCallBack,errorCallBack);    
说明:

建议在onload方法中与init方法同时调用.

参数:
返回值:

无返回值.

示例:
    onLoad = function(){
        rd.JPush.init();
          rd.JPush.addCallBack(receiveMessageCallBack,errorCallBack);
    }

removeCallBack


移除消息回调函数.

rd.JPush.removeCallBack();    
说明:

调用此方法会移除当前页面的receiveMessageCallBackerrorCallBack回调函数.

参数:

返回值:

无返回值

示例:
rd.JPush.removeCallBack();    

setTags


设置tag.

rd.JPush.setTags(TAGS);    
说明:

当推送服务启动后,可以为用户设置tag(标签),用于区别推送.

参数:
  • TAGS: ( Array ) 必选 字符串数组,数组里的字符串用于设置tag,可以同时设置多个tag.
返回值:

无返回值

示例:
rd.JPush.setTags(['tag1','tag2','tag3']);

setAlias


设置别名

rd.JPush.setAlias(ALIAS);    
说明:

当推送服务启动后,可以为用户设置alias(别名),用于区别推送.

参数:
  • ALIAS: ( String ) 必选 别名,只能设置一个别名.
返回值:

无返回值

示例:
rd.JPush.setAlias('JACK');

setAliasAndTags


同时设置tag标签和别名,参数顺序不可变.

rd.JPush.setAliasAndTags(ALIAS, TAGS);    
说明:

如果只想设置其中一个,另一个设置为空字符串或者数组.

参数:
  • ALIAS: ( String ) 必选 别名,只能设置一个别名.
  • TAGS: ( Array ) 必选 字符串数组,数组里的字符串用于设置tag,可以同时设置多个tag.
返回值:

无返回值

示例:
rd.JPush.setAliasAndTags('JACK', ['tag1','tag2','tag3']);

getRegId


获取注册极光推送的唯一id

var id = rd.JPush.getRegId();    
说明:

获取注册极光推送的唯一id

参数:

无.

返回值:
  • id: ( String ) 极光推送的唯一id
示例:
var id = rd.JPush.getRegId();    

setPushTime


设置接收消息的时段

rd.JPush.setPushTime(START, END, WEEK);    
说明:

设置接收消息的时段,24小时格式.iOS平台不支持此方法,可以调用,但是无反应.

参数:
  • START: ( String ) 必选 开始推送时间, 数值为0~23(24小时制).
  • END: ( String ) 必选 结束推送时间, 数值为0~23(24小时制).
  • WEEK: ( String ) 必选 星期, 0表示星期天,1表示星期一,以此类推,多个用','号隔开
返回值:

无返回值

示例:
rd.JPush.setPushTime('9', '20', '1,2,3,6');

getJPushStatus


用来检查 Push Service 状态

var state = rd.JPush.getJPushStatus();    
说明:

用来检查 Push Service 状态, iOS平台不支持,可以调用,但是无反应.

参数:

返回值:
  • state : ( Boolean ) true:运行中,false:未运行
示例:
var state = rd.JPush.getJPushStatus();

stopPush


停止推送服务

rd.JPush.stopPush();    
说明:

停止推送服务,iOS平台不支持,可以调用,但是无反应.

参数:

返回值:

无返回值

示例:
rd.JPush.stopPush();    

resumePush


恢复推送服务

rd.JPush.resumePush();    
说明:

恢复推送服务,iOS平台不支持,可以调用,但是无反应.

参数:

返回值:

无返回值

示例:
rd.JPush.resumePush();

setLatesNotificationNumber


设置通知栏最多显示的通知数量

rd.JPush.setLatesNotificationNumber(COUNT);    
说明:

设置通知栏最多显示的通知数量,iOS平台不支持,可以调用,但是无反应.

参数:
  • COUNT: ( Number ) 必选 最多显示的通知数量
返回值:

无返回值

示例:
rd.JPush.setLatesNotificationNumber(3);

clearAllNotifies


清除所有通知

rd.JPush.clearAllNotifies();    
说明:

说明

参数:

返回值:

无返回值

示例:
rd.JPush.clearAllNotifies();

UserInfo


JSON对象 推送消息对象,内部封装了极光推送相关参数以及推送消息内容.

UserInfo 
{
    property Number _j_msgid,
    property APS aps
}
说明:

推送消息对象,内部封装了极光推送相关参数以及推送消息内容.UserInfo子对象.

属性:
  • _j_msgid : ( Number ) 极光消息ID.
  • aps : ( APS ) 消息内容.

APS


APS 
{
    property Number badeg,
    property String sound,
    property String alert,
    property String title,
    property String extras
}
说明:

JSON对象

属性:
  • badeg : ( Number ) 角标提示未读消息个数,Android平台不支持
  • sound : ( String ) 提示音,Android平台不支持
  • alert : ( String ) 消息内容
  • title : ( String ) 通知标题
  • extras : ( String ) 附加内容

receiveMessageCallBack


消息接收回调函数.

function receiveMessageCallBack (UserInfo) {
    var aps = UserInfo.aps;
    var title = aps.title;
    var alert = aps.alert;
    var extras = aps.extras;//格式 {key:value}
}
说明:

消息接收回调函数.通过此函数返回推送消息内容.需要注册.

参数:
  • UserInfo : ( UserInfo ) 推送消息对象,内部封装了极光推送相关参数以及推送消息内容.

errorCallBack


错误回调函数.

function errorCallBack (error) {

}
说明:

当插件出现错误时,通过此函数返回.需要注册.

参数:
  • error : ( String ) 错误描述.

pluginConfigs.xml


配置文件,内部包含极光推送的配置.

<configs>
     <config pluginName="JPush">
        <ios>
            <param key="JPUSH_CHANNEL" value="channel01"></param>
            <param key="JPUSH_APPKEY" value="2cd47e1bd502d989b525e02e"></param>
            <param key="APS_FOR_PRODUCTION" value="0"></param>
        </ios>
        <android>
            <param key="JPUSH_APPKEY_VALUE" value="f74048f0bf5200dde3ca89bd"></param>
            <param key="JPUSH_CHANNEL_VALUE" value="xiaomishichang"></param>
        </android>
    </config>
</configs>
说明:

填写此配置文件用来配置极光推送相关参数.

字段:
  • JPUSH_CHANNEL : ( String ) 可选 推送频道(iOS).
  • JPUSH_APPKEY : ( String ) 必选 由极光官网注册所得的appkey(iOS).
  • APS_FOR_PRODUCTION : ( String ) 必选 证书类型(iOS). 0 : 调试证书. 1 : 发布证书.
  • JPUSH_APPKEY_VALUE : ( String ) 必选 由极光官网注册所得的appkey(Android).
  • JPUSH_CHANNEL_VALUE : ( String ) 可选 推送频道(Android).