帮助与文档

> >

API说明

API接口一览

接口 参数 说明 最低版本
addPushReceiver MobPushReceiver 推送监听接口
removePushReceiver MobPushReceiver 移除推送监听接口
getRegistrationId MobPushCallback<String> 获取注册id,在参数MobPushCallback的onCallback(String)中回调注册id
setAlias String 字符串 设置别名
deleteAlias 删除别名
getAlias 获取别名,获取的结果会在推送监听MobPushReceiver的onAliasCallback()回调返回
addTags String[] 添加标签
deleteTags String[] 删除标签
cleanTags 清空标签
getTags 获取标签,获取的结果会在推送监听MobPushReceiver的onTagsCallback()回调返回
setSilenceTime int startHour;

int startMinute;

int endHour;

int endMinute

设置通知静音时段
setCustomNotification MobPushCustomNotification 设置自定义通知  
addLocalNotification MobPushLocalNotification 添加本地推送通知
removeLocalNotification Int notificationId 移除本地通知
clearLocalNotifications 清空本地通知
isPushStopped 判断推送服务是否以及停止
restartPush 重新打开推送服务
stopPush 停止推送,停止后将不会接收到推送,仅可通过restartPush重新打开
setClickNotificationToLaunchMainActivity boolean enable 设置点击通知是否启动主页
setNotifyIcon Int resId 设置通知图标,默认使用应用图标 1.5.0
setAppForegroundHiddenNotification boolean hidden 设置应用运行在前台时推送不显示通知 1.6.0
setTailorNotification Class<T> tailorNotification 设置自定义通知,T要继承自MobPushTailorNotification 1.6.1
removeTailorNotification 移除自定义通知 1.6.1
bindPhoneNum String phoneNum,MobPushCallback 绑定手机号,用于短信补量发送短信到手机号 1.7.0

 

addPushReceiver()

描述:添加推送监听,可监听接收到的自定义消息(透传消息)、通知消息、通知栏点击事件、别名和标签变更操作。

用法:

removePushReceiver()

描述:移除通知监听,与addPushReceiver()对应,添加推送监听后,在关闭界面时调用进行移除,移除之前添加过的推送监听。

用法:

getRegistrationId()

描述:获取注册id,同一台设备,同个appkey对应一个注册id。

用法:

setAlias()

描述:设置别名,别名是唯一的,多次调用,以最后一次设置为准,会进行覆盖;与注册Id是一一对应的。是否设置成功,会在addPushReceiver()->MobPushReceiver-> onAliasCallback(Context context, String alias, int operation, int errorCode)中进行回调返回。当operation为0时,表示获取别名操作;当operation为1时,表示设置别名操作;当operation为2时,表示删除别名操作。当errorCode为0时,表示操作成功;当errorCode非0时,表示操作失败。

用法:

deleteAlias()

描述:

删除别名。

是否删除成功,会在addPushReceiver()->MobPushReceiver-> onAliasCallback(Context context, String alias, int operation, int errorCode)中进行回调返回。当operation为0时,表示获取别名操作;当operation为1时,表示设置别名操作;当operation为2时,表示删除别名操作。当errorCode为0时,表示操作成功;当errorCode非0时,表示操作失败。

用法:

getAlias()

描述:

获取别名。

是否获取成功,会在addPushReceiver()->MobPushReceiver-> onAliasCallback(Context context, String alias, int operation, int errorCode)中进行回调返回。当operation为0时,表示获取别名操作;当operation为1时,表示设置别名操作;当operation为2时,表示删除别名操作。当errorCode为0时,表示操作成功;当errorCode非0时,表示操作失败。

用法:

addTags()

描述:

添加标签。标签可以添加多个,每次调用都会在原来的基础上进行追加。

是否获取成功,会在addPushReceiver()->MobPushReceiver-> onTagsCallback(Context context, String[] tags, int operation, int errorCode)中进行回调返回。当operation为0时,表示获取标签操作;当operation为1时,表示设置标签操作;当operation为2时,表示删除标签操作。当errorCode为0时,表示操作成功;当errorCode非0时,表示操作失败。

用法:

deleteTags()

描述:

删除标签。

是否获取成功,会在addPushReceiver()->MobPushReceiver-> onTagsCallback(Context context, String[] tags, int operation, int errorCode)中进行回调返回。当operation为0时,表示获取标签操作;当operation为1时,表示设置标签操作;当operation为2时,表示删除标签操作。当errorCode为0时,表示操作成功;当errorCode非0时,表示操作失败。

用法:

getTags()

描述:

获取标签。

是否获取成功,会在addPushReceiver()->MobPushReceiver-> onTagsCallback(Context context, String[] tags, int operation, int errorCode)中进行回调返回。当operation为0时,表示获取标签操作;当operation为1时,表示设置标签操作;当operation为2时,表示删除标签操作。当errorCode为0时,表示操作成功;当errorCode非0时,表示操作失败。

用法:

cleanTags()

描述:

清空标签。

是否获取成功,会在addPushReceiver()->MobPushReceiver-> onTagsCallback(Context context, String[] tags, int operation, int errorCode)中进行回调返回。当operation为0时,表示获取标签操作;当operation为1时,表示设置标签操作;当operation为2时,表示删除标签操作。当errorCode为0时,表示操作成功;当errorCode非0时,表示操作失败。

用法:

setSilenceTime()

描述:

设置静音时间。设置静音时间段,几点几分开始到几点几分结束,这段时间属于静音时间段,接收到推送时,提醒类型属于静音状态。

用法:

addLocalNotification()

描述:

添加本地通知。不通过服务器推送,客户端主动发送通知。

用法:

removeLocalNotification()

描述:

添加本地通知。不通过服务器推送,客户端主动发送通知。

用法:

 

clearLocalNotifications()

描述:

清除本地通知。

用法:

isPushStopped()

描述:

判断是否停止推送。

用法:

restartPush()

描述:

推送服务停止后,重新启动推送服务,继续接收推送。

用法:

stopPush()

描述:

停止推送服务,不继续接收推送。

用法:

setClickNotificationToLaunchMainActivity()

描述:

设置点击通知是否启动默认页。默认为启动。

用法:

setNotifyIcon()

描述:

设置通知图标。通知默认使用应用图标,调用此方法来修改通知图标。

用法:

setAppForegroundHiddenNotification()

描述:

设置应用在前台时接收到推送不显示通知。默认是应用在前台是接收到推送则显示通知。true表示应用在前台时接收到推送不显示通知;false表示应用在前台时接收到推送显示通知。

用法:

setTailorNotification ()

描述:

MobPush1.6.1新加入接口,设置自定义通知,根据需要需要定制通知如何显示。通过定义一个继承自MobPushTailorNotification来定制自己需要的通知。

用法:

removeTailorNotification ()

描述:

MobPush1.6.1新加入接口,移除自定义通知。

用法:

setTailorNotification ()

描述:

新版自定义通知接口

用法:

bindPhoneNum()

描述:

MobPush1.7.0新加入接口,绑定手机号,用于短信补量时发送短信。

用法:


 

API错误码

API返回的错误码说明如下:(详见MobPushErrorCode.java说明)

-1  网络请求失败

-2  请求错误

 

功能自定义和扩展

前言:此功能仅仅是针对push的一些使用场景而进行自定义设定。比如,通知被点击的时候:

方式一、通过界面uri进行link跳转

首先现在Manifest文件中进行目标Activity的uri设置,如下:

在Mob后台进行推送时,通过scheme://host的格式,例如mlink://com.mob.mobpush.link,如下位置填入:

配置好之后,推送就App就可以接收到推送直接打开指定的Activity界面了。

方式二、当app显示在前台的时候,会触发MobPushReceiver的onNotifyMessageOpenedReceive方法,MobPushNotifyMessage参数则是回调的通知详情,可以根据回调参数进行处理(不建议使用,当进程被杀掉的情况下,启动应用后可能无法执行到回调方法,因为此时可能还执行到未添加监听的代码);

方式三、不管app进程是否被杀掉,当点击通知后拉起应用的启动页面,会触发启动Activity的OnCreate或OnNewIntent方法,通过getIntent方法拿到回传的Intent,遍历getExtras,可以拿到通知详情(建议使用);

根据方式三,MobPush以两个场景为例子:

场景一、通过扩展参数实现页面的自定义跳转:

场景二、通过扩展参数实现web界面的跳转:
代码同场景一一样,跳转页面的方法改成跳转webview页面就可以,通过参数识别,拿到需要跳转的Url链接

上面两个场景的使用示例代码,可以参考官方demo

https://github.com/MobClub/MobPush-for-Android

 

相关文档