txPush

论坛示例

为帮助用户更好更快的使用插件，论坛维护了一个示例，示例中包含示例代码供您参考。

TPNS移动推送

移动推送 TPNS （Tencent Push Notification Service）为您提供稳定、快速、高抵达的 App 推送服务。其接入方便快捷，拥有业内领先的技术实力，稳定可靠的消息推送通道，特有的智能推送通道策略，能有效提升消息抵达率；系统每分钟可容纳1800万推送消息，消息能秒级到达（支撑王者荣耀等腾讯内应用推送工具）；此外，其具备精准用户标签能力，有效助力 App 的精细化运营。

插件使用攻略

1、config.xml配置信息如下：

<meta-data name="com.huawei.hms.client.appid" value="appid=" />
<meta-data name="com.vivo.push.api_key" value="" />
<meta-data name="com.vivo.push.app_id" value="" />
<meta-data name="com.hihonor.push.app_id" value="" />
<feature name="txPush">
    <param name="AccessId_Android" value="1500005758"/>
    <param name="AccessKey_Android" value="ASDX2TBIOG5G"/>
    <param name="AccessId_iOS" value="1600005759"/>
    <param name="AccessKey_iOS" value="IKDH5JF7DTKE"/>
    <param name="debugMode" value="true"/>
    <param name="XMAppid" value=""/>
    <param name="XMAppkey" value=""/>
    <param name="MZAppid" value=""/>
    <param name="MZAppkey" value=""/>
    <param name="OppoAppkey" value=""/>
    <param name="OppoAppSecret" value=""/>
    <param name="enablePullUpOtherApp" value="true"/>
    <param name="enableOtherPush" value="false"/>
</feature>

2、第三方厂商接入需要配套自定义插件第三方厂商配套插件下载。

插件接口

addNotifaction

添加通知监听

addNotifaction(callback(ret, err))

callback(ret, err)

ret：

类型：JSON对象
内部字段：

{
    evenType:'',   //Android事件：消息透传处理事件 onTextMessage
               //通知展示事件 onNotificationShowedResult
               //注册回调事件 onRegisterResult
               //反注册回调事件 onUnregisterResult
               //设置标签回调事件 onSetTagResult
               //删除标签的回调事件 onDeleteTagResult
               //设置账号回调事件 onSetAccountResult
               //删除账号回调事件 onDeleteAccountResult
               //查询标签回调事件 onQueryTagsResult
               //通知点击回调事件 onNotificationClickedResult
               //处理信鸽通知事件 onNotifactionResult
               //iOS事件：统一接收消息的回调事件 xgPushDidReceiveRemoteNotification
               //统一点击回调事件 xgPushDidReceiveNotificationResponse
               //角标设置成功回调事件 xgPushDidSetBadgeSucc
               //角标设置失败回调事件 xgPushDidSetBadgeFail
               //通知授权弹框的回调事件 xgPushDidRequestNotificationPermission
               //TPNS网络连接成功事件 xgPushNetworkConnected
               //TPNS网络连接断开事件 xgPushNetworkDisconnected
    pushChannel : '',
    notifyId : '',
    title : '',
    content : '',
    customContent : '',
    msgId : '',
    notificationActionType : '',
    activity : '',
    errorCode : '',
    errorMsg : '',
    token : '',
    accessId : '',
    account : '',
    otherPushToken : '',
    ticket : '',
    ticketType : '',
    tagName : '',
    tags : '',
    operateName : '',
    activityName : '',
    message : {},
}

示例代码

var demo = api.require('txPush');
demo.addNotifaction(function(ret, err) {
    api.alert({msg: JSON.stringify(ret)});
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

removeNotifaction

移除通知监听

removeNotifaction(callback(ret, err))

callback(ret, err)

ret：

类型：JSON对象
内部字段：

{
    status: true   //布尔型；true||false
}

示例代码

var demo = api.require('txPush');
demo.removeNotifaction(function(ret, err) {
    api.alert({msg: JSON.stringify(ret)});
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

registerPush

注册推送(不配置config.xml时使用)

registerPush({params}, callback(ret, err))

params

AccessId_iOS：

类型：字符串型
描述：（可选项）AccessId_iOS。

AccessKey_iOS：

类型：字符串型
描述：（可选项）AccessKey_iOS。

AccessId_Android：

类型：字符串型
描述：（可选项）AccessId_Android。

AccessKey_Android：

类型：字符串型
描述：（可选项）AccessKey_Android。

enablePullUpOtherApp：

类型：布尔型
描述：（可选项）设置是否开启联合保活(仅Android有效)。
默认值：true

enableOtherPush：

类型：布尔型
描述：（可选项）设置是否开启第三方推送(仅Android有效)。
默认值：false

debugMode：

类型：布尔型
描述：（可选项）设置是否打印TPNS SDK的日志信息。
默认值：false

callback(ret, err)

ret：

类型：JSON对象
内部字段：

{
    status: true,   //布尔型；true||false
    token : '',
    flag : '',
}

err：

类型：JSON对象
内部字段：

{
    code: "",
    msg:""
}

示例代码

var obj = api.require('txPush');
obj.registerPush({
    ......
},function(ret, err) {
    api.alert({msg: JSON.stringify(ret)});
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

isRegisterPush

是否注册推送成功

isRegisterPush(callback(ret, err))

callback(ret, err)

ret：

类型：JSON对象
内部字段：

{
    status: true,   //布尔型；true||false
    token : '',
    flag : '',
}

err：

类型：JSON对象
内部字段：

{
    code: "",
    msg:""
}

示例代码

var obj = api.require('txPush');
obj.isRegisterPush(function(ret, err) {
    api.alert({msg: JSON.stringify(ret)});
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

unregisterPush

反注册推送

unregisterPush(callback(ret, err))

callback(ret, err)

ret：

类型：JSON对象
内部字段：

{
    status: true,   //布尔型；true||false
}

err：

类型：JSON对象
内部字段：

{
    code: '',
    msg : ''
}

示例代码

var demo = api.require('txPush');
demo.unregisterPush(function(ret, err) {
    api.alert({msg: JSON.stringify(ret)});
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

upsertAccounts

绑定账号

upsertAccounts({params}, callback(ret, err))

params

dataList：

类型：数组型
描述：（必填项）需要绑定账号列表。

{
    accountType : 0,//1:CUSTOM 1000:IMEI 1002:PHONE_NUMBER 1003:WX_OPEN_ID 1004:QQ_OPEN_ID 1005:EMAIL 1006:SINA_WEIBO 1007:ALIPAY 1008:TAOBAO 1009:DOUBAN 1010:FACEBOOK 1011:TWITTER 1012:GOOGLE 1013:BAIDU 1014:JINGDONG 1015:LINKEDIN
    account : '',
}

callback(ret, err)

ret：

类型：JSON对象
内部字段：

{
    status: true,   //布尔型；true||false
}

err：

类型：JSON对象
内部字段：

{
    code: "",
    msg:""
}

示例代码

var obj = api.require('txPush');
obj.upsertAccounts({
    ......
},function(ret, err) {
    api.alert({msg: JSON.stringify(ret)});
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

delAccounts

账号解绑

delAccounts({params}, callback(ret, err))

params

dataList：

类型：数组型
描述：（必填项）需要绑定账号列表。

{
    accountType : 0,//1:CUSTOM 1000:IMEI 1002:PHONE_NUMBER 1003:WX_OPEN_ID 1004:QQ_OPEN_ID 1005:EMAIL 1006:SINA_WEIBO 1007:ALIPAY 1008:TAOBAO 1009:DOUBAN 1010:FACEBOOK 1011:TWITTER 1012:GOOGLE 1013:BAIDU 1014:JINGDONG 1015:LINKEDIN
}

callback(ret, err)

ret：

类型：JSON对象
内部字段：

{
    status: true,   //布尔型；true||false
}

err：

类型：JSON对象
内部字段：

{
    code: "",
    msg:""
}

示例代码

var obj = api.require('txPush');
obj.delAccounts({
    ......
},function(ret, err) {
    api.alert({msg: JSON.stringify(ret)});
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

clearAccounts

清空所有账号

clearAccounts(callback(ret, err))

callback(ret, err)

ret：

类型：JSON对象
内部字段：

{
    status: true,   //布尔型；true||false
}

err：

类型：JSON对象
内部字段：

{
    code: '',
    msg : ''
}

示例代码

var demo = api.require('txPush');
demo.clearAccounts(function(ret, err) {
    api.alert({msg: JSON.stringify(ret)});
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

clearAndAppendTags

覆盖多个标签

clearAndAppendTags({params}, callback(ret, err))

params

operateName：

类型：字符串
描述：（必填项）操作标记。

tagList：

类型：数组型
描述：（必填项）标签列表。

callback(ret, err)

ret：

类型：JSON对象
内部字段：

{
    status: true,   //布尔型；true||false
}

err：

类型：JSON对象
内部字段：

{
    code: "",
    msg:""
}

示例代码

var obj = api.require('txPush');
obj.clearAndAppendTags({
    ......
},function(ret, err) {
    api.alert({msg: JSON.stringify(ret)});
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

appendTags

新增多个标签

appendTags({params}, callback(ret, err))

params

operateName：

类型：字符串
描述：（必填项）操作标记。

tagList：

类型：数组型
描述：（必填项）标签列表。

callback(ret, err)

ret：

类型：JSON对象
内部字段：

{
    status: true,   //布尔型；true||false
}

err：

类型：JSON对象
内部字段：

{
    code: "",
    msg:""
}

示例代码

var obj = api.require('txPush');
obj.appendTags({
    ......
},function(ret, err) {
    api.alert({msg: JSON.stringify(ret)});
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

delTags

删除多个标签

delTags({params}, callback(ret, err))

params

operateName：

类型：字符串
描述：（必填项）操作标记。

tagList：

类型：数组型
描述：（必填项）标签列表。

callback(ret, err)

ret：

类型：JSON对象
内部字段：

{
    status: true,   //布尔型；true||false
}

err：

类型：JSON对象
内部字段：

{
    code: "",
    msg:""
}

示例代码

var obj = api.require('txPush');
obj.delTags({
    ......
},function(ret, err) {
    api.alert({msg: JSON.stringify(ret)});
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

clearTags

清除所有标签

clearTags({params}, callback(ret, err))

params

operateName：

类型：字符串
描述：（必填项）操作标记。

callback(ret, err)

ret：

类型：JSON对象
内部字段：

{
    status: true,   //布尔型；true||false
}

err：

类型：JSON对象
内部字段：

{
    code: "",
    msg:""
}

示例代码

var obj = api.require('txPush');
obj.clearTags({
    ......
},function(ret, err) {
    api.alert({msg: JSON.stringify(ret)});
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

upsertAttributes

新增用户属性

upsertAttributes({params}, callback(ret, err))

params

operateName：

类型：字符串
描述：（必填项）操作标记。

attributeList：

类型：JSON串型
描述：（必填项）用户属性列表。

callback(ret, err)

ret：

类型：JSON对象
内部字段：

{
    status: true,   //布尔型；true||false
}

err：

类型：JSON对象
内部字段：

{
    code: "",
    msg:""
}

示例代码

var obj = api.require('txPush');
obj.upsertAttributes({
    ......
},function(ret, err) {
    api.alert({msg: JSON.stringify(ret)});
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

clearAndAppendAttributes

更新用户属性

clearAndAppendAttributes({params}, callback(ret, err))

params

operateName：

类型：字符串
描述：（必填项）操作标记。

attributeList：

类型：JSON串型
描述：（必填项）用户属性列表。

callback(ret, err)

ret：

类型：JSON对象
内部字段：

{
    status: true,   //布尔型；true||false
}

err：

类型：JSON对象
内部字段：

{
    code: "",
    msg:""
}

示例代码

var obj = api.require('txPush');
obj.clearAndAppendAttributes({
    ......
},function(ret, err) {
    api.alert({msg: JSON.stringify(ret)});
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

delAttributes

删除用户属性

delAttributes({params}, callback(ret, err))

params

operateName：

类型：字符串
描述：（必填项）操作标记。

attributeKeys：

类型：数组型
描述：（必填项）用户key列表。

callback(ret, err)

ret：

类型：JSON对象
内部字段：

{
    status: true,   //布尔型；true||false
}

err：

类型：JSON对象
内部字段：

{
    code: "",
    msg:""
}

示例代码

var obj = api.require('txPush');
obj.delAttributes({
    ......
},function(ret, err) {
    api.alert({msg: JSON.stringify(ret)});
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

clearAttributes

清空已有用户属性

clearAttributes({params}, callback(ret, err))

params

operateName：

类型：字符串
描述：（必填项）操作标记。

callback(ret, err)

ret：

类型：JSON对象
内部字段：

{
    status: true,   //布尔型；true||false
}

err：

类型：JSON对象
内部字段：

{
    code: "",
    msg:""
}

示例代码

var obj = api.require('txPush');
obj.clearAttributes({
    ......
},function(ret, err) {
    api.alert({msg: JSON.stringify(ret)});
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

enablePullUpOtherApp

是否开启联合保活能力

enablePullUpOtherApp({params})

params

enable：

类型：布尔型
描述：（必填项）是否开启联合保活功能。

##ret：

类型：JSON对象
内部字段：

{
    status: true,   //布尔型；true||false
}

示例代码

var obj = api.require('txPush');
var ret = obj.enablePullUpOtherApp({
    enable : true
});
api.alert({msg: JSON.stringify(ret)});

可用性

Android系统

可提供的1.0.0及更高版本

enableDebug

是否开启Debug 模式

enableDebug({params})

params

debugMode：

类型：布尔型
描述：（必填项）是否开启Debug 模式。
默认值：false

##ret：

类型：JSON对象
内部字段：

{
    status: true,   //布尔型；true||false
}

示例代码

var obj = api.require('txPush');
var ret = obj.enableDebug({
    debugMode : true
});
api.alert({msg: JSON.stringify(ret)});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

getToken

获取token

getToken()

##ret：

类型：JSON对象
内部字段：

{
    status: true,   //布尔型；true||false
    token : '',
}

示例代码

var obj = api.require('txPush');
var ret = obj.getToken();
api.alert({msg: JSON.stringify(ret)});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

getOtherPushToken

获取第三方厂商 Token

getOtherPushToken()

##ret：

类型：JSON对象
内部字段：

{
    status: true,   //布尔型；true||false
    token : '',
}

示例代码

var obj = api.require('txPush');
var ret = obj.getOtherPushToken();
api.alert({msg: JSON.stringify(ret)});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

setBadgeNum

直接设置角标数值

setBadgeNum({params})

params

setNum：

类型：布尔型
描述：（必填项）角标数。
默认值：0

##ret：

类型：JSON对象
内部字段：

{
    status: true,   //布尔型；true||false
}

示例代码

var obj = api.require('txPush');
var ret = obj.setBadgeNum({
    setNum : 1
});
api.alert({msg: JSON.stringify(ret)});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

resetBadgeNum

清除角标数值

resetBadgeNum()

##ret：

类型：JSON对象
内部字段：

{
    status: true,   //布尔型；true||false
}

示例代码

var obj = api.require('txPush');
var ret = obj.resetBadgeNum();
api.alert({msg: JSON.stringify(ret)});

可用性

Android系统

可提供的1.0.0及更高版本

uploadBadge

上报当前App角标数到TPNS服务器

uploadBadge({params})

params

badgeNumber：

类型：布尔型
描述：（必填项）角标数。

##ret：

类型：JSON对象
内部字段：

{
    status: true,   //布尔型；true||false
}

示例代码

var obj = api.require('txPush');
var ret = obj.uploadBadge();
api.alert({msg: JSON.stringify(ret)});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

是否仍需要帮助？请保持联络！

最后更新于 2024/04/24