Emas Push Plus

/ Title: emasPushPlus Description: 阿里厂商推送 /

来自于:770104707@qq.com立即使用

概述

阿里厂商推送简介

移动推送是提供给移动开发者的移动端消息推送服务,通过在App中集成推送功能,进行高效、精准、实时的App消息推送,从而使业务及时触达用户,提高用户粘性。

emasPushPlus 模块概述

本模块封装了阿里厂商推送的原生 SDK,集成了App推送相关功能;

模块使用攻略

使用之前须从阿里厂商推送平台申请开发者账号并创建应用,开通广告服务。

阿里厂商推送申请地址阿里厂商推送

--android 辅助通道地址:

方式一:com.tools.emaspushplus.EmasPushPlusPopupActivity

方式二:com.tools.emaspushplus.EmasPushPlusCustomActivity

模块依赖

  • 注意:

1.使用本模块需要上传【hmsCore】扩展模块包,配合使用(【自定义模块教程】)

2.使用本模块需要上传【emasPushPlusAppendix】扩展模块包,配合使用(【自定义模块教程】)

3.如遇见其他问题请联系QQ:770104707

使用此模块之前建议先配置 config.xml 文件,配置完毕,需通过云端编译生效,配置方法如下:

  • 名称:emasPushPlus
  • 配置示例:
    <!-- 华为 -->
    <meta-data name="com.huawei.hms.client.appid" value="appid=10***********1"/>

    <!-- vivo -->
    <meta-data name="com.vivo.push.app_id" value="1040***********9"/>
    <meta-data name="com.vivo.push.api_key" value="0307d2e71***********404cd"/>


    <feature name="emasPushPlus">

        <!-- 阿里推送 android-->
        <param name="android_appKey" value="33***********6783" />
        <param name="android_appSecret" value="e0276c79***********5d96a6734877" />
        <!-- 小米 -->
        <param name="XM_appId" value="28823***********18525806" />
        <param name="XM_appKey" value="579***********16806" />
        <!-- OPPO -->
        <param name="OPPO_appId" value="303***********018" />
        <param name="OPPO_appKey" value="00c3ebb0a8***********7641d988042" />
        <!-- 魅族 -->
        <param name="MZ_appId" value="14***********42" />
        <param name="MZ_appKey" value="d7d2de***********e715f2af946679" />

        <!-- 阿里推送 ios-->
        <param name="ios_appKey" value="3334***********89" />
        <param name="ios_appSecret" value="6d1db63328***********471d9" />
    </feature>

模块接口

register

SDK注册

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

params

channelId

  • 类型:字符串
  • 描述:(android 必填)渠道ID

channelTitle

  • 类型:字符串
  • 描述:(android 必填)渠道标题

channelDesc

  • 类型:字符串
  • 描述:(android 必填)渠道描述

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true, //初始化状态
    code: 0, //状态码
    eventType: 'onSuccess', //事件类型  onSuccess onFailed
    msg: "onSuccess",//描述
    result:{ //其他结果数据

    }
}

示例代码

var emasPushPlus = api.require('emasPushPlus');
emasPushPlus.register({
    <!--andorid 兼容android8 以上版本 start-->
    channelId:"",
    channelTitle:"",
    channelDesc:"",
    <!--andorid 兼容android8 以上版本 end-->
},function(ret, err) {
    if (ret.status) {
        alert("注册成功");
    } else {
        alert('注册失败');
    }
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

turnOnPush

开启推送

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

params

callback(ret, err)

示例代码

var emasPushPlus = api.require('emasPushPlus');
emasPushPlus.turnOnPush({

}, function(ret, err) {

});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

turnOffPush

关闭推送

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

params

callback(ret, err)

示例代码

var emasPushPlus = api.require('emasPushPlus');
emasPushPlus.turnOffPush({

}, function(ret, err) {

});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

getPushStatus

获取推送状态

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

params

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true, //初始化状态
    code: 0, //状态码
    eventType: 'onSuccess', //事件类型  onSuccess onFailed
    msg: "onSuccess",//描述
    result:{ //其他结果数据

    }
}

示例代码

var emasPushPlus = api.require('emasPushPlus');
emasPushPlus.getPushStatus({

},function(ret, err) {
    if (ret.status) {

    }
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

getDeviceId

获取设备标识

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

params

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true, //初始化状态
    code: 0, //状态码
    eventType: 'onSuccess', //事件类型  onSuccess onFailed
    msg: "onSuccess",//描述
    result:{ //其他结果数据

    }
}

示例代码

var emasPushPlus = api.require('emasPushPlus');
emasPushPlus.getDeviceId({

},function(ret, err) {
    if (ret.status) {
       var result = ret.result;
       var deviceId = result.deviceId;
    }
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

setEventListener

事件监听

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

params

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true, //初始化状态
    code: 0, //状态码
    eventType: 'setEventListener', //事件类型 
    msg: "setEventListener",//描述
    result:{ //其他结果数据

    }
}

示例代码

var emasPushPlus = api.require('emasPushPlus');
emasPushPlus.setEventListener({

}, function(ret, err) {
    if(ret.status){
        var result = ret.result;

        if(ret.eventType == "onReceiveMessage"){
            //接收透传消息

        }

        if(ret.eventType == "onReceiveNotification"){
            //通知展示结果

        }

        if(ret.eventType == "onOpenedNotification"){
            //打开通知

        }

        if(ret.eventType == "onRemovedNotification"){
            //移除通知

        }

    }
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

bindAccount

绑定账号

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

params

account

  • 类型:字符串
  • 描述:(必填)账号

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true, //初始化状态
    code: 0, //状态码
    eventType: 'onSuccess', //事件类型  onSuccess onFailed
    msg: "onSuccess",//描述
    result:{ //其他结果数据

    }
}

示例代码

var emasPushPlus = api.require('emasPushPlus');
emasPushPlus.bindAccount({
    account:""
},function(ret, err) {
    if (ret.status) {
       var result = ret.result;
    }
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

unbindAccount

解绑账号

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

params

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true, //初始化状态
    code: 0, //状态码
    eventType: 'onSuccess', //事件类型  onSuccess onFailed
    msg: "onSuccess",//描述
    result:{ //其他结果数据

    }
}

示例代码

var emasPushPlus = api.require('emasPushPlus');
emasPushPlus.unbindAccount({

},function(ret, err) {
    if (ret.status) {
       var result = ret.result;
    }
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

bindTags

绑定标签

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

params

tags

  • 类型:数组
  • 描述:(必填)标签数组
      [
          "tag1","tag2","tag3"
      ]
    

callback(ret, err)

示例代码

var emasPushPlus = api.require('emasPushPlus');
emasPushPlus.bindTags({
    tags:["tag1","tag2","tag3"]
}, function(ret, err) {

});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

listTags

查询标签

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

params

callback(ret, err)

{
    status: true, //初始化状态
    code: 0, //状态码
    eventType: 'onSuccess', //事件类型  onSuccess onFailed
    msg: "onSuccess",//描述
    result:{ //其他结果数据

    }
}

示例代码

var emasPushPlus = api.require('emasPushPlus');
emasPushPlus.listTags({

}, function(ret, err) {

});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

unbindTags

解绑标签

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

params

tags

  • 类型:数组
  • 描述:(必填)标签数组
      [
          "tag1","tag2","tag3"
      ]
    

callback(ret, err)

示例代码

var emasPushPlus = api.require('emasPushPlus');
emasPushPlus.unbindTags({
    tags:["tag1","tag2","tag3"]
}, function(ret, err) {

});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

addAlias

添加别名

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

params

alias

  • 类型:字符串
  • 描述:(必填)别名

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true, //初始化状态
    code: 0, //状态码
    eventType: 'onSuccess', //事件类型  onSuccess onFailed
    msg: "onSuccess",//描述
    result:{ //其他结果数据

    }
}

示例代码

var emasPushPlus = api.require('emasPushPlus');
emasPushPlus.addAlias({
    alias:""
},function(ret, err) {
    if (ret.status) {
       var result = ret.result;
    }
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

listAlias

查询别名

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

params

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true, //初始化状态
    code: 0, //状态码
    eventType: 'onSuccess', //事件类型  onSuccess onFailed
    msg: "onSuccess",//描述
    result:{ //其他结果数据

    }
}

示例代码

var emasPushPlus = api.require('emasPushPlus');
emasPushPlus.listAlias({

},function(ret, err) {
    if (ret.status) {
       var result = ret.result;
    }
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

removeAlias

移除别名

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

params

alias

  • 类型:字符串
  • 描述:(必填)别名

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true, //初始化状态
    code: 0, //状态码
    eventType: 'onSuccess', //事件类型  onSuccess onFailed
    msg: "onSuccess",//描述
    result:{ //其他结果数据

    }
}

示例代码

var emasPushPlus = api.require('emasPushPlus');
emasPushPlus.removeAlias({
    alias:""
},function(ret, err) {
    if (ret.status) {
       var result = ret.result;
    }
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

bindPhoneNumber

绑定手机号

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

params

phoneNumber

  • 类型:字符串
  • 描述:(必填)手机号码

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true, //初始化状态
    code: 0, //状态码
    eventType: 'onSuccess', //事件类型  onSuccess onFailed
    msg: "onSuccess",//描述
    result:{ //其他结果数据

    }
}

示例代码

var emasPushPlus = api.require('emasPushPlus');
emasPushPlus.bindAccount({
    phoneNumber:""
},function(ret, err) {
    if (ret.status) {
       var result = ret.result;
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

unbindPhoneNumber

解绑手机号

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

params

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true, //初始化状态
    code: 0, //状态码
    eventType: 'onSuccess', //事件类型  onSuccess onFailed
    msg: "onSuccess",//描述
    result:{ //其他结果数据

    }
}

示例代码

var emasPushPlus = api.require('emasPushPlus');
emasPushPlus.unbindPhoneNumber({

},function(ret, err) {
    if (ret.status) {
       var result = ret.result;
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

setBadge

设置角标

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

params

badgeNumber

  • 类型:整型
  • 描述:(必填)角标数【最终显示的数值】

callback(ret, err)

{
    status: true, //初始化状态
    code: 0, //状态码
    eventType: 'onSuccess', //事件类型  onSuccess onFailed
    msg: "onSuccess",//描述
    result:{ //其他结果数据

    }
}

示例代码

var emasPushPlus = api.require('emasPushPlus');
emasPushPlus.setBadge({
    badgeNumber:1,
}, function(ret, err) {

});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

addLocalNotification

添加本地通知

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

params

title

  • 类型:字符串
  • 描述:(选填)标题

body

  • 类型:字符串
  • 描述:(必填)内容

params

  • 类型:对象
  • 描述:(必填)参数
      {
          key1:"value1",
          key2:"value2"
      }
    

callback(ret, err)

示例代码

var emasPushPlus = api.require('emasPushPlus');
emasPushPlus.addLocalNotification({
    title:"Test title",
    body:"Test body",
    params:{
        key1:"value1",
        key2:"value2"
    }
}, function(ret, err) {

});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

clearLocalNotifications

清除本地通知

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

params

callback(ret, err)

示例代码

var emasPushPlus = api.require('emasPushPlus');
emasPushPlus.clearLocalNotifications({

}, function(ret, err) {

});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

cancelAllNotifiaction

清除所有通知

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

params

callback(ret, err)

示例代码

var emasPushPlus = api.require('emasPushPlus');
emasPushPlus.cancelAllNotifiaction({

}, function(ret, err) {

});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本