概述

vivo推送是vivo公司向开发者提供的消息推送服务，通过在云端与客户端之间建立一条稳定、可靠的长连接，为开发者提供向客户端应用实时推送消息的服务，支持百亿级的通知/消息推送，秒级触达移动用户。

使用前说明

• 在使用vivoPush之前需要到 vivo 开放平台后台创建应用并获取 appkey & appSecret & appId

使用此模块之前需先配置 config.xml 文件，如下

  <meta-data
            name="com.vivo.push.api_key"
            value="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" />

    <meta-data
            name="com.vivo.push.app_id"
            value="xxxxx" />

• 字段描述:

  com.vivo.push.api_key：（必须配置）vivo开放平台 生成

  com.vivo.push.app_id：（必须配置）vivo开放平台 生成

接口

turnOnPush

开启推送

turnOnPush(callback(ret))

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:true       //布尔类型；是否正常开启
    state:,             //数字类型；开启状态  0为成功
}

示例代码

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

可用性

Android系统

可提供的1.0.0及更高版本

turnOffPush

关闭推送

turnOffPush(callback(ret))

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:true       //布尔类型；是否正常关闭
    state:,             //数字类型；  0为成功
}

示例代码

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

可用性

Android系统

可提供的1.0.0及更高版本

bindAlias

设置别名

bindAlias(callback(ret))

param

alias

• 类型：字符串类型
• 描述：要添加的别名

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:true       //布尔类型；是否正常返回
    state:,             //数字类型；  0为成功
}

示例代码

var vivoPush = api.require('vivoPush');        
vivoPush.bindAlias({
alias:'',
}, function(ret) {
        alert(JSON.stringify(ret));
});

可用性

Android系统

可提供的1.0.0及更高版本

unBindAlias

解除别名

unBindAlias(callback(ret))

param

alias

• 类型：字符串类型
• 描述：要添加的别名

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:true       //布尔类型；是否正常返回
    state:,             //数字类型；  0为成功
}

示例代码

var vivoPush = api.require('vivoPush');        
vivoPush.unBindAlias({
alias:'',
},
     function(ret) {
        alert(JSON.stringify(ret));
});

可用性

Android系统

可提供的1.0.0及更高版本

setTopic

设置标签

setTopic(callback(ret))

param

topic

• 类型：字符串类型
• 描述：要设置的标签

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:true       //布尔类型；是否正常返回
    state:,             //数字类型；  0为成功
}

示例代码

var vivoPush = api.require('vivoPush');        
vivoPush.setTopic({
topic:'',
}, function(ret) {
        alert(JSON.stringify(ret));
});

可用性

Android系统

可提供的1.0.0及更高版本

delTopic

删除标签

delTopic(callback(ret))

param

topic

• 类型：字符串类型
• 描述：要设置的标签

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:true       //布尔类型；是否正常返回
    state:,             //数字类型；  0为成功
}

示例代码

var vivoPush = api.require('vivoPush');        
vivoPush.delTopic({
topic:'',
}, function(ret) {
        alert(JSON.stringify(ret));
});

可用性

Android系统

可提供的1.0.0及更高版本

getTopics

获取已设置标签

getTopics(callback(ret))

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:true       //布尔类型；是否正常返回
    topics:[],             //数组类型；  已设置的标签
}

示例代码

var vivoPush = api.require('vivoPush');        
vivoPush.getTopics({
}, function(ret) {
        alert(JSON.stringify(ret));
});

可用性

Android系统

可提供的1.0.0及更高版本

getAlias

获取已设置的别名

getAlias(callback(ret))

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:true       //布尔类型；是否正常返回
    alias:‘’,             //字符串类型；已设置的别名
}

示例代码

var vivoPush = api.require('vivoPush');        
vivoPush.getAlias({
}, function(ret) {
        alert(JSON.stringify(ret));
});

可用性

Android系统

可提供的1.0.0及更高版本

getAlias

获取已设置的别名

getAlias(callback(ret))

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:true       //布尔类型；是否正常返回
    alias:‘’,             //字符串类型；已设置的别名
}

示例代码

var vivoPush = api.require('vivoPush');        
vivoPush.getAlias({
}, function(ret) {
        alert(JSON.stringify(ret));
});

可用性

Android系统

可提供的1.0.0及更高版本

getRegId

获取注册id

getRegId(callback(ret))

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:true       //布尔类型；是否正常返回
    regId:‘’,             //字符串类型；注册id
}

示例代码

var vivoPush = api.require('vivoPush');        
vivoPush.getRegId({
}, function(ret) {
        alert(JSON.stringify(ret));
});

可用性

Android系统

可提供的1.0.0及更高版本

setRegIdListener

设置regId变化监听

setRegIdListener(callback(ret))

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:true       //布尔类型；是否正常返回
    regId:‘’,             //字符串类型；注册id
}

示例代码

var vivoPush = api.require('vivoPush');        
vivoPush.getRegId({
}, function(ret) {
        alert(JSON.stringify(ret));
});

可用性

Android系统

可提供的1.0.0及更高版本

notificationClickListener

消息点击监听

notificationClickListener(callback(ret))

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:true       //布尔类型；是否正常返回
    message:{         //Json对象类型；点击的消息内容
        title:'',             //字符串类型；消息标题
        content:'',        / /字符串类型；内容
        msgId:,             //数字类型；消息id
        msgSt:'',          //字符串类型；消息所有信息，以上字段不满足需求可从此字段自行解析
    },            
}

示例代码

var vivoPush = api.require('vivoPush');        
vivoPush.notificationClickListener({
}, function(ret) {
        alert(JSON.stringify(ret));
});

可用性

Android系统

可提供的1.0.0及更高版本