Tpush

来自于:官方

概述

tpush推送方式说明 tpush有3种推送方法:别名推送,标签推送,广播

a) 别名推送:每台设备都可以设置唯一的别名,调用API时将别名发送过去,tpush就会针对别名下的设备进行推送

b) 标签推送:tpush可以给一批设备设置标签,比如男和女,tpush可以根据标签进行推送,比如只发给男的或者只发给女的

c) 广播:发送给APP下的所有设备

使用tpush推送基本流程说明:

1.由天畅信息后台申请的对应的应用id,获取APP_KEY

2.在config.xml中配置tpush feature,填写app_key参数

3.前端调用tPush模块方法

使用此模块之前需先配置config文件的Feature,方法如下

名称:tpush 参数:ios_api_key, m_url, m_port, m_iDevelopeType, outTime 描述:配置tPush推送应用信息

 <feature name="tpush">
        <param name="ios_api_key" value="123456789" />
        <param name="android_api_key" value="123456789" />
        <param name="m_url" value="192.168.30.146" />
        <param name="m_port" value="8080" />
    <param name="xmppPort" value="5222">
        <param name="m_iDevelopeType" value="DevelopeType_Distribution" />
        <param name="outTime" value="20.0" />
    </feature>

字段描述:

1. app_key:由天畅信息后台申请的对应的应用id
2. m_url:联网地址--ip 
3. m_port:端口
4. xmppPort xmpp端口
5. m_iDevelopeType:设置开发证书(DevelopeType_Developement)还是发布证书(DevelopeType_Distribution)
6. outTime:联网超时时间 

注意

Android 配置还需要使用tpushConfig模块,用于配置appKey,需要将 tpushConfig->res_tpushConfig->res->raw下的appkey.properties文件中的 appkey替换成自己的appKey,点击此处下载tpushConfig模块

模块概述

tpush模块封装了TPushSDK,可设置标签和别名

模块接口

init

初始化(仅Android有效)

init(callback)

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    msg: '',  // 字符串类型 通知消息
    code: ''  // 字符串类型 返回code
}

示例代码

var tpush = api.require('tpush');
tpush.init(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android系统

可提供的1.0.0及更高版本

setListener

接收消息

setListener(callback)

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    msg: '',  // 字符串类型 通知消息
}

示例代码

var tpush = api.require('tpush');
tpush.setListener(function(ret){
    alert(JSON.stringify(ret));
});

可用性

iOS系统

可提供的1.0.0及更高版本

setTag

给应用设置标签

setTag(params)

params

tagValue

  • 类型:字符串
  • 描述:给应用添加标签,推送时候选择标签 1对多

示例代码

var tpush = api.require('tpush');
tpush.setTag({
   tagValue:'xingxing',
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

setAlias

给应用设置别名

setAlias(params)

params

alias

  • 类型:字符串
  • 描述:(可选项)给应用设置别名 1对1

    示例代码

var tpush = api.require('tpush');
tpush.setAlias({
   alias:'loginName', 
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本