oppoPush

立即使用

概述

oppoPush 封装 OPPO PUSH SDK

OPPO Push是OPPO公司向开发者提供的消息推送服务,通过服务端与OS端建立的一条稳定、可靠的长连接通道,向OPPO手机系统(ColorOS)上的APP应用客户端实时推送消息的服务。

通过消息推送服务,可有效的提升开发者应用的活跃和留存,改善产品体验。

服务支持

  • 支持平台

目前仅支持OPPO手机系统(ColorOS) Android APP应用。

  • 通知消息类型

OPPO推送暂时只支持通知栏消息的推送。消息下发到OS系统模块并由系统通知模块展示,在用户点击通知前,不启动应用。整个过程环保省电。

  • 系统版本

OPPO推送服务SDK支持的最低安卓版本为Android 4.0系统。

使用前说明

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

isSupportPush

判断是否手机平台是否支持PUSH

isSupportPush(callback(ret))

callback(ret)

ret:

  • 类型:JSON 对象

内部字段:

{
    isSupport:true       //布尔类型;手机平台是否支持 oppo push
}

示例代码

var oppoPush = api.require('oppoPush');        
oppoPush.isSupportPush(function(ret) {
        alert("支持push:"+JSON.stringify(ret));

});

可用性

Android系统

可提供的1.0.0及更高版本

register

注册

register({params},callback(ret))

Params

appKey:

  • 类型:字符串
  • 描述:appKey(需到oppo开放平台申请)

appSecret:

  • 类型:字符串
  • 描述:app秘钥(需到oppo开放平台申请)

callback(ret)

ret:

  • 类型:JSON 对象

内部字段:

{
    eventType: 'OnRegister',  // 字符串类型;事件类型
    responseCode:0,           // 数字类型;响应码
    regId:'',                 // 字符串类型;注册ID (该参数仅在eventType为onRegister时返回)
    pushState:'start'         // 字符串类型;推送状态(该参数仅在eventType为onPushState时返回)
}

其中eventType取值如下:

  • onRegister 注册事件
  • onUnRegister 注销事件
  • onPushState 推送状态

其中pushState取值如下:

  • start 开始推送
  • pause 暂停推送
  • stop 停止推送

示例代码

var oppoPush = api.require('oppoPush');        
oppoPush.register({
    appKey:'your key',
    appSecret:'your secret'
},function(ret) {
    if (ret){
        alert(JSON.stringify(ret));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

unRegister

解注册OPush推送服务

unRegister()

示例代码

var oppoPush = api.require('oppoPush');        
oppoPush.unRegister();

可用性

Android系统

可提供的1.0.0及更高版本

getRegisterID

获取注册OPush推送服务的注册ID

getRegisterID(callback(ret))

callback(ret)

ret:

  • 类型:JSON 对象

内部字段:

{
    regId: '',  // 字符串类型;注册ID
}

示例代码

var oppoPush = api.require('oppoPush');        
oppoPush.getRegisterID(function(ret){
    alert(ret.regId);
});

可用性

Android系统

可提供的1.0.0及更高版本

pausePush

暂停推送服务

pausePush()

示例代码

var oppoPush = api.require('oppoPush');        
oppoPush.pausePush();

可用性

Android系统

可提供的1.0.0及更高版本

resumePush

恢复推送服务

resumePush()

示例代码

var oppoPush = api.require('oppoPush');        
oppoPush.resumePush();

可用性

Android系统

可提供的1.0.0及更高版本

getPushState

获取推送状态 (在register方法中回调)

getPushState()

示例代码

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

可用性

Android系统

可提供的1.0.0及更高版本

getSDKVersion

获取OPush推送服务MCS版本

getSDKVersion(callback(ret))

callback(ret)

ret:

  • 类型:JSON 对象

内部字段:

{
    version: '',  // 字符串类型;MCS版本
}

示例代码

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

可用性

Android系统

可提供的1.0.0及更高版本

setPushTime

设置允许推送时间

setPushTime({params})

Params

weekDays:

  • 类型:JSON数组
  • 描述:允许一周内哪几天可以接受推送消息,周日为0,周一为1,以此类推
  • 示例: [1, 2, 3] => 周一,周二,周三

startHour:

  • 类型:数字类型
  • 描述:开始时间(小时)24小时制

endHour:

  • 类型:数字类型
  • 描述:结束时间(小时)24小时制

startMin:

  • 类型:数字类型
  • 描述:开始时间(分钟)

endMin:

  • 类型:数字类型
  • 描述:结束时间(分钟)

示例代码

var oppoPush = api.require('oppoPush');        
oppoPush.setPushTime({
    weekDays:[1, 2, 3],
    startHour:8,
    endHour:23,
});

可用性

Android系统

可提供的1.0.0及更高版本