XGPush


信鸽是一个能够提供Push服务的开发平台,提供给开发者简便、易用的API接口,方便快速接入。需要开发者到信鸽平台注册accessKey,accessID等参数.

如何创建应用

1、登录信鸽官网,点击登录按钮(使用QQ帐号登录) 如下图:
image

2、点击接入推送应用按钮创建应用, 如下图:
image

3、根据提示配置应用参数。然后点击接入应用按钮 如下图:
image

4、到应用列表页面,信鸽推送会针对安卓和iOS分开推送。这里先讲解如何配置iOS应用的证书 如下图:
image

5、点击证书设置指南,按照教程制作证书 如下图:
image

6、将配置好的pem证书上传到信鸽服务器。如图所示,点击上传按钮,注意区分开发证书和生产证书,否则信鸽会提示证书验证失败 如下图:
image

7、安卓不需要配置证书。复制ACCESS ID 和 ACCESS KEY 留作保存,给插件使用。iOS同理。如下图:
image

方法:

对象:

  • AppInfo :JSON对象,信鸽推送初始化参数.

回调方法:

registe


注册推送服务.

rd.XGPush.registe(AppInfo,successCallBack,failCallBack);    
说明:

调用此方法启动推送服务.与unregister方法对应.

参数:
  • AppInfo : ( AppInfo ) 必选, 信鸽推送初始化参数.
  • successCallBack : ( successCallBack ) 必选, 成功回调函数.
  • failCallBack : ( failCallBack ) 必选, 失败回调.
返回值:

无返回值

示例:
    function successCallBack(){
        alert('success');
    }

    function failCallBack(){
        alert('fail');
    }

    var  appinfo = {
            accessID : 'ID2200132336',
            accessKey : 'KEYIA361ZJF66JH',
            account : 'Jack'
    }
    rd.XGPush.registe(appinfo,successCallBack,failCallBack);

unregister


注销推送服务.

rd.XGPush.unregister(successCallBack,failCallBack);    
说明:

注销推送服务.注销后不再接收推送消息.与registe方法对应.如果需要恢复接收推送消息,需要再次调用registe方法.

参数:
返回值:

无返回值

示例:
    function successCallBack(){
        alert('success');
    }

    function failCallBack(){
        alert('fail');
    }
    rd.XGPush.unregister(successCallBack,failCallBack);

addCallBack


添加消息回调函数.当app收到远程推送消息时,将调用被添加的回调函数,开发者可以通过回调函数获取到推送消息的详细信息.

rd.XGPush.addCallBack(receiveMessage,errorInfo);    
说明:

只有调用这个方法的页面才能接收到推送消息.

参数:
返回值:

无返回值

示例:
function receiveMessage(UserInfo){
   alert(UserInfo);
}

function errorInfo(err){
   alert(err);
}

rd.XGPush.addCallBack(receiveMessage,errorInfo);

removeCallBack


移除消息回调函数.

rd.XGPush.removeCallBack();    
说明:

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

参数:

返回值:

无返回值

示例:
rd.XGPush.removeCallBack();    

setTag


设置标签,以达到区别推送的目的.

rd.XGPush.setTag( TAG,successCallBack,failCallBack);    
说明:

与设置账户(account)功能类似.设置标签方法可以在程序的任意时间设置,设置账户需要在注册服务时一起设置.

参数:
  • TAG: ( String ) 必选 要设置的标签字符串.
  • successCallBack: ( successCallBack ) 必选 成功回调.
  • failCallBack: ( failCallBack ) 必选 失败回调.
返回值:

无返回值

示例:
function successCallBack(){
        alert('success');
    }

function failCallBack(){
        alert('fail');
    }

rd.XGPush.setTag('certern',successCallBack,failCallBack);

deleteTag


删除标签.根据标签名称删除.

rd.XGPush.deleteTag(TAG,successCallBack,failCallBack);    
说明:

删除标签.根据标签名称删除.

参数:
  • TAG: ( String ) 必选 要删除的标签.
  • successCallBack: ( successCallBack ) 必选 成功回调函数.
  • failCallBack: ( failCallBack ) 必选 失败回调函数.
返回值:

无返回值

示例:
rd.XGPush.deleteTag('JACK',successCallBack,failCallBack);

isUnregistered


判断当前是否是已注销状态

rd.XGPush.isUnregistered();    
说明:

判断当前是否是已注销状态

参数:

返回值:
  • state : ( Boolean ) false:未注销. true: 已注销.
示例:
var  state =rd.XGPush.isUnregistered();

setBadge


设置通知角标数量.app图标右上角红色未处理提醒数字.

 rd.XGPush.setBadge(badge);    
说明:

设置通知角标数量.app图标右上角红色未处理提醒数字.

参数:
  • badge: ( Number ) 必选 要设置的个数 0 ~ 99
返回值:

无返回值

示例:
 rd.XGPush.setBadge(9);

AppInfo


JSON对象,信鸽推送初始化参数.

AppInfo 
{
    property String accessID,
    property String accessKey,
    property String account
}
说明:

JSON对象 信鸽推送初始化参数.需要从信鸽官网注册.

属性:
  • accessID : ( String ) 必选 注册所得应用ID.
  • accessKey : ( String ) 必选 注册所得应用Key.
  • account : ( String ) 可选 设备的帐号名称,自定义.(长度为2个字符以上,不要使用"test","123456"这种过于简单的字符串).

receiveMessage


被注册为回调方法后,当收到远程推送通知时,调用该方法

function receiveMessage(UserInfo){

}
说明:

被注册为回调方法后,当收到远程推送通知时,调用该方法.

参数:
  • UserInfo : ( String )推送消息内容.

errorInfo


被注册为回调方法后,当收到远程推送通知但是出现错误时,调用该方法.

         function errorInfo(err){
             alert(err);
         }
说明:

被注册为回调方法后,当收到远程推送通知但是出现错误时,调用该方法.

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

successCallBack


操作成功回调.

function successCallBack(){


 }
说明:

操作成功回调.

参数:

failCallBack


操作失败回调.

function failCallBack(){

}
说明:

操作失败回调.

参数: