flymePush
概述
- 使用此模块之前需先配置 config.xml 文件，如下
- 接口
register
unRegister
subScribeTags
unSubScribeTags
unSubScribeAllTags
checkSubScribeTags
subScribeAlias
unSubScribeAlias
checkSubScribeAlias
getPushId
clearNotification
clearByNotifyId
clearByNotifyId
setMsgArrivedListener
setMsgArrivedListener
setNotifyClickListener

flymePush

Method

register unRegister subScribeTags unSubScribeTags unSubScribeAllTags checkSubScribeTags subScribeAlias unSubScribeAlias checkSubScribeAlias getPushId clearNotification clearByNotifyId setMsgArrivedListener setNotifyClickListener

概述

魅族推送服务是由魅族公司为开发者提供的消息推送服务，开发者可以向集成了flymePush的客户端实时地推送通知或者消息，与用户保持互动，提高活跃率。

使用前说明

在使用flymePush之前需要到魅族开放平台后台创建应用并获取 appkey & appSecret & appId

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


  <feature name="flymePush">
        <param name="appId" value="*****" />
        <param name="appKey" value="*****" />
    </feature>

字段描述:

appId：（必须配置）魅族开放平台获取的Flyme推送appId

appKey：（必须配置）魅族开放平台获取的Flyme推送appKey

接口

register

callback(ret)

ret：

类型：JSON 对象
内部字段：

{
    status:true       //布尔类型；是否正常开启
    pushId:,             //数字类型；注册id
}

err：

类型：JSON 对象
内部字段：

{
    msg:'',            //数字类型；错误信息 ret.status 为false时返回
}

示例代码

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

可用性

Android系统

可提供的1.0.0及更高版本

unRegister

取消订阅

unRegister(callback(ret))

callback(ret)

ret：

类型：JSON 对象
内部字段：

{
    status:true       //布尔类型；取消订阅是否成功
}

err：

类型：JSON 对象
内部字段：

{
    msg:'',            //数字类型；错误信息 ret.status 为false时返回
}

示例代码

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

可用性

Android系统

可提供的1.0.0及更高版本

subScribeTags

标签订阅

subScribeTags(callback(ret))

param

pushId

类型：字符串类型
描述：成功订阅的pushId

callback(ret)

ret：

类型：JSON 对象
内部字段：

{
    status:true       //布尔类型；是否正常返回
    tags:[                 //Json数组类型；标签列表
    {
        tagId:,            //数字类型；标签id
        tagName:'',   //字符串类型；标签名称
    }
    ]
}

err：

类型：JSON 对象
内部字段：

{
    msg:'',            //数字类型；错误信息 ret.status 为false时返回
}

示例代码

var flymePush = api.require('flymePush');        
flymePush.subScribeTags({
pushId:'',
tags:''
},   function(ret) {
        alert(JSON.stringify(ret));
});

可用性

Android系统

可提供的1.0.0及更高版本

unSubScribeTags

取消标签订阅

unSubScribeTags(callback(ret))

param

pushId

类型：字符串类型
描述：成功订阅的pushId

callback(ret)

ret：

类型：JSON 对象
内部字段：

{
    status:true       //布尔类型；是否正常返回
    tags:[                 //Json数组类型；标签列表
    {
        tagId:,            //数字类型；标签id
        tagName:'',   //字符串类型；标签名称
    }
    ]
}

err：

类型：JSON 对象
内部字段：

{
    msg:'',            //数字类型；错误信息 ret.status 为false时返回
}

示例代码

var flymePush = api.require('flymePush');        
flymePush.unSubScribeTags({
pushId:'',
tags:''
},   function(ret) {
        alert(JSON.stringify(ret));
});

可用性

Android系统

可提供的1.0.0及更高版本

unSubScribeAllTags

取消所有标签订阅

unSubScribeAllTags(callback(ret))

param

pushId

类型：字符串类型
描述：成功订阅的pushId

callback(ret)

ret：

类型：JSON 对象
内部字段：

{
    status:true       //布尔类型；是否正常返回
    tags:[                 //Json数组类型；标签列表
    {
        tagId:,            //数字类型；标签id
        tagName:'',   //字符串类型；标签名称
    }
    ]
}

err：

类型：JSON 对象
内部字段：

{
    msg:'',            //数字类型；错误信息 ret.status 为false时返回
}

示例代码

var flymePush = api.require('flymePush');        
flymePush.unSubScribeAllTags({
pushId:'',
}, function(ret) {
        alert(JSON.stringify(ret));
});

可用性

Android系统

可提供的1.0.0及更高版本

checkSubScribeTags

获取所有标签

checkSubScribeTags(callback(ret))

param

pushId

类型：字符串类型
描述：成功订阅的pushId

callback(ret)

ret：

类型：JSON 对象
内部字段：

{
    status:true       //布尔类型；是否正常返回
    tags:[                 //Json数组类型；标签列表
    {
        tagId:,            //数字类型；标签id
        tagName:'',   //字符串类型；标签名称
    }
    ]
}

err：

类型：JSON 对象
内部字段：

{
    msg:'',            //数字类型；错误信息 ret.status 为false时返回
}

示例代码

var flymePush = api.require('flymePush');        
flymePush.checkSubScribeTags({
pushId:'',
}, function(ret) {
        alert(JSON.stringify(ret));
});

可用性

Android系统

可提供的1.0.0及更高版本

subScribeAlias

别名订阅

subScribeAlias(callback(ret))

param

pushId

类型：字符串类型
描述：成功订阅的pushId

alias

类型：字符串类型
描述：别名

callback(ret)

ret：

类型：JSON 对象
内部字段：

{
    status:true       //布尔类型；是否正常返回
    alias:‘’              //字符串类型；别名列表
}

err：

类型：JSON 对象
内部字段：

{
    msg:'',            //数字类型；错误信息 ret.status 为false时返回
}

示例代码

var flymePush = api.require('flymePush');        
flymePush.subScribeAlias({
pushId:'',
alias:'',
}, function(ret) {
        alert(JSON.stringify(ret));
});

可用性

Android系统

可提供的1.0.0及更高版本

unSubScribeAlias

取消别名订阅

unSubScribeAlias(callback(ret))

param

pushId

类型：字符串类型
描述：成功订阅的pushId

alias

类型：字符串类型
描述：别名

callback(ret)

ret：

类型：JSON 对象
内部字段：

{
    status:true       //布尔类型；是否正常返回
    alias:‘’              //字符串类型；别名列表
}

err：

类型：JSON 对象
内部字段：

{
    msg:'',            //数字类型；错误信息 ret.status 为false时返回
}

示例代码

var flymePush = api.require('flymePush');        
flymePush.unSubScribeAlias({
pushId:'',
alias:'',
}, function(ret) {
        alert(JSON.stringify(ret));
});

可用性

Android系统

可提供的1.0.0及更高版本

checkSubScribeAlias

获取别名

checkSubScribeAlias(callback(ret))

param

pushId

类型：字符串类型
描述：成功订阅的pushId

callback(ret)

ret：

类型：JSON 对象
内部字段：

{
    status:true       //布尔类型；是否正常返回
    alias:‘’              //字符串类型；别名列表
}

err：

类型：JSON 对象
内部字段：

{
    msg:'',            //数字类型；错误信息 ret.status 为false时返回
}

示例代码

var flymePush = api.require('flymePush');        
flymePush.checkSubScribeAlias({
pushId:'',
}, function(ret) {
        alert(JSON.stringify(ret));
});

可用性

Android系统

可提供的1.0.0及更高版本

getPushId

获取已订阅pushId

getPushId(callback(ret))

callback(ret)

ret：

类型：JSON 对象
内部字段：

{
    status:true       //布尔类型；是否正常返回
    pushId:‘’              //字符串类型；已订阅pushId
}

err：

类型：JSON 对象
内部字段：

{
    msg:'',            //数字类型；错误信息 ret.status 为false时返回
}

示例代码

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

可用性

Android系统

可提供的1.0.0及更高版本

clearNotification

清除所有通知栏消息

clearNotification(callback(ret))

callback(ret)

ret：

类型：JSON 对象
内部字段：

{
    status:true       //布尔类型；是否正常返回
}

err：

类型：JSON 对象
内部字段：

{
    msg:'',            //数字类型；错误信息 ret.status 为false时返回
}

示例代码

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

可用性

Android系统

可提供的1.0.0及更高版本

clearByNotifyId

清除所有通知栏消息

clearByNotifyId(callback(ret))

param

notifyId

类型：数字类型
描述：通知栏展示通知id

callback(ret)

ret：

类型：JSON 对象
内部字段：

{
    status:true       //布尔类型；是否正常返回
}

err：

类型：JSON 对象
内部字段：

{
    msg:'',            //数字类型；错误信息 ret.status 为false时返回
}

示例代码

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

可用性

Android系统

可提供的1.0.0及更高版本

clearByNotifyId

清除所有通知栏消息

clearByNotifyId(callback(ret))

param

notifyId

类型：数字类型
描述：通知栏展示通知id

callback(ret)

ret：

类型：JSON 对象
内部字段：

{
    status:true       //布尔类型；是否正常返回
}

err：

类型：JSON 对象
内部字段：

{
    msg:'',            //数字类型；错误信息 ret.status 为false时返回
}

示例代码

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

可用性

Android系统

可提供的1.0.0及更高版本

setMsgArrivedListener

清除所有通知栏消息

setMsgArrivedListener(callback(ret))

callback(ret)

ret：

类型：JSON 对象
内部字段：

{
    status:true       //布尔类型；是否正常返回
    message:{         //Json对象类型；收到消息
        content:'',     //字符串类型；消息内容
        notifyId:,      //数字类型；消息接收
        title:'',          //字符串类型；消息title
        pushType:,    //数字类型；消息类型
        taskId:,''         //字符串类型；taskId
        selfDefineContentString:'',          //字符串类型；
    }
}

err：

类型：JSON 对象
内部字段：

{
    msg:'',            //数字类型；错误信息 ret.status 为false时返回
}

示例代码

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

可用性

Android系统

可提供的1.0.0及更高版本

setMsgArrivedListener

设置消息接收监听

setMsgArrivedListener(callback(ret))

callback(ret)

ret：

类型：JSON 对象
内部字段：

{
    status:true       //布尔类型；是否正常返回
    message:{         //Json对象类型；收到消息
        content:'',     //字符串类型；消息内容
        notifyId:,      //数字类型；消息接收
        title:'',          //字符串类型；消息title
        pushType:,    //数字类型；消息类型，0：通知栏消息 1：透传消息。
        taskId:,''         //字符串类型；taskId
        selfDefineContentString:'',          //字符串类型；
    }
}

err：

类型：JSON 对象
内部字段：

{
    msg:'',            //数字类型；错误信息 ret.status 为false时返回
}

示例代码

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

可用性

Android系统

可提供的1.0.0及更高版本

setNotifyClickListener

设置通知栏消息点击监听

setNotifyClickListener(callback(ret))

callback(ret)

ret：

类型：JSON 对象
内部字段：

{
    status:true       //布尔类型；是否正常返回
    message:{         //Json对象类型；收到消息
        content:'',     //字符串类型；消息内容
        notifyId:,      //数字类型；消息接收
        title:'',          //字符串类型；消息title
        pushType:,    //数字类型；消息类型，0：通知栏消息 1：透传消息。
        taskId:,''         //字符串类型；taskId
        selfDefineContentString:'',          //字符串类型；
    }
}

err：

类型：JSON 对象
内部字段：

{
    msg:'',            //数字类型；错误信息 ret.status 为false时返回
}

示例代码

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

可用性

Android系统

可提供的1.0.0及更高版本