推送MobPush-API说明

简介:
  1. 消息监听接口
    MobPushReceiver: 消息监听接口(包含接收自定义消息、通知消息、通知栏点击事件、别名和标签变更操作等)

MobPush.addPushReceiver(MobPushReceiver receiver): 设置消息监听
MobPush.removePushReceiver(MobPushReceiver receiver): 移除消息监听

  1. 推送开关控制接口
    MobPush.stopPush(): 停止推送(停止后将不会收到推送消息,仅可通过restartPush重新打开)

MobPush.restartPush(): 重新打开推送服务
MobPush.isPushStopped(): 判断推送服务是否已经停止

  1. 推送选项接口
    MobPush.setSilenceTime(int startHour, int startMinute, int endHour, int endMinute): 设置通知静音时段(开始时间小时和分钟、结束时间小时和分钟)

MobPush.setCustomNotification(MobPushCustomNotification customNotification): 设置自定义通知样式

  1. 业务接口
    MobPush.getRegistrationId(MobPushCallback callback):获取注册id(可与用户id绑定,实现向指定用户推送消息)

别名操作:(同时只能设置一个别名,可用来标识一个用户)
MobPush.setAlias(String alias):设置别名
MobPush.getAlias():获取当前设置的别名
MobPush.deleteAlias():删除别名
标签操作:(同时可设置多个标签,可用于多用户订阅标签的方式,批量推送消息)
MobPush.addTags(String[] tags):添加标签
MobPush.getTags():获取所有已添加的标签
MobPush.deleteTags(String[] tags):删除标签
MobPush.cleanTags():清除所有已添加的标签
MobPushCustomeMessage: 自定义消息实体类
MobPushNotifyMessage: 通知消息实体类

  1. 本地通知
    MobPush.addLocalNotification(MobPushLocalNotification notification):添加本地通知

MobPush.removeLocalNotification(int notificationId):移除本地通知
MobPush.clearLocalNotifications():清空本地通知
MobPushLocalNotification:本地通知消息实体类,继承MobPushNotifyMessage

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

-1 网络请求失败
-2 请求错误

功能自定义和扩展
前言:此功能仅仅是针对push的一些使用场景而进行自定义设定。比如,通知被点击的时候:
方式一、通过界面uri进行link跳转
首先现在Manifest文件中进行目标Activity的uri设置,如下:

activity
    android:name=".LinkActivity">
    <intent-filter>
        <action android:name="android.intent.action.VIEW" />
        <category android:name="android.intent.category.DEFAULT" />
        <data
            android:host="com.mob.mobpush.link"
            android:scheme="mlink" />
    </intent-filter>
</activity>

在Mob后台进行推送时,通过scheme://host的格式,例如mlink://com.mob.mobpush.link,如下位置填入:
1
配置好之后,推送就App就可以接收到推送直接打开指定的Activity界面了。
方式二、当app显示在前台的时候,会触发MobPushReceiver的onNotifyMessageOpenedReceive方法,MobPushNotifyMessage参数则是回调的通知详情,可以根据回调参数进行处理(不建议使用,当进程被杀掉的情况下,启动应用后可能无法执行到回调方法,因为此时可能还执行到未添加监听的代码);
方式三、不管app进程是否被杀掉,当点击通知后拉起应用的启动页面,会触发启动Activity的OnCreate或OnNewIntent方法,通过getIntent方法拿到回传的Intent,遍历getExtras,可以拿到通知详情(建议使用);
根据方式二,MobPush以两个场景为例子:
场景一、通过扩展参数实现页面的自定义跳转:

//自定义扩展字段的key,下发通知的时候,在扩展字段使用这个key
private final static String MOB_PUSH_DEMO_INTENT = "intent";
 
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    dealPushResponse(getIntent());
}
 
protected void onNewIntent(Intent intent) {
    dealPushResponse(intent);
    //需要调用setIntent方法,不然后面获取到的getIntent都是上一次传的数据
    setIntent(intent);
}
 
 
//OnCreate和OnNewIntent方法都要同时处理这个逻辑
private void dealPushResponse(Intent intent) {
   Bundle bundle = null;
   if (intent != null) {
      bundle = intent.getExtras();
      if (bundle != null) {
         Set<String> keySet = bundle.keySet();
         for (String key : keySet) {
            if (key.equals("msg")) {
               MobPushNotifyMessage notifyMessage = (MobPushNotifyMessage) bundle.get(key);
               HashMap<String, String> params = notifyMessage.getExtrasMap();
               if(params != null && params.containsKey(MOB_PUSH_DEMO_INTENT)){
                  //此处跳转到指定页面
                  openPage(params);
               }
            }
         }
      }
   }
}
 
private void openPage(HashMap<String, String> params){
    Intent intent = new Intent(this, JumpActivity.class);
    intent.putExtra("key1", "value1");
    intent.putExtra("key2", "value2");
    intent.putExtra("key3", "value3");
    //如上Intent,在intent.toURI();之后得到的String,如下所示,可利用这个方法识别Intent传的参数,
    //下发的参数可以按照下面的格式传,客户端接收后再转成Intent,若添加action等其他参数,可自行打印看Srting结构体;
    //#Intent;component=com.mob.demo.mobpush/.JumpActivity;S.key1=value1;S.key2=value2;S.key3=value3;end
 
    String uri;
    if(!TextUtils.isEmpty(params.get(MOB_PUSH_DEMO_INTENT))) {
        uri = params.get(MOB_PUSH_DEMO_INTENT);
        try {
            startActivity(Intent.parseUri(uri, 0));
        } catch (Throwable t){
            t.printStackTrace();
        }
    }
}

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

private final static String MOB_PUSH_DEMO_URL = "url";
 
//OnCreate和OnNewIntent方法都要同时处理这个逻辑
private void dealPushResponse(Intent intent) {
   Bundle bundle = null;
   if (intent != null) {
      bundle = intent.getExtras();
      if (bundle != null) {
         Set<String> keySet = bundle.keySet();
         for (String key : keySet) {
            if (key.equals("msg")) {
               MobPushNotifyMessage notifyMessage = (MobPushNotifyMessage) bundle.get(key);
               HashMap<String, String> params = notifyMessage.getExtrasMap();
               if(params != null && params.containsKey(MOB_PUSH_DEMO_URL)){
                  //此处跳转到webview页面
                  openUrl(params);
               }
            }
         }
      }
   }
}
 
private void openUrl(HashMap<String, String> params){
   String url;
   if(!TextUtils.isEmpty(params.get(MOB_PUSH_DEMO_URL))) {
      url = params.get(MOB_PUSH_DEMO_URL);
   } else {
      url = "http://m.mob.com";
   }
   if(!url.startsWith("http://") && !url.startsWith("https://")){
      url = "http://" + url;
   }
   System.out.println("url:" + url);
   //以下代码为开发者自定义跳转webview页面,粘贴使用会找不到相关类
   WebViewPage webViewPage = new WebViewPage();
   webViewPage.setJumpUrl(url);
   webViewPage.show(this, null);
}

上面两个场景的使用示例代码,可以参考官方demo
https://github.com/MobClub/MobPush-for-Android

目录
相关文章
|
存储 前端开发 安全
webhook是什么 与API的区别在哪里
webhooks是一个api概念,是微服务api的使用范式之一,也被成为反向api,即:前端不主动发送请求,完全由后端推送。 举个常用例子,比如你的好友发了一条朋友圈,后端将这条消息推送给所有其他好友的客户端,就是 Webhooks 的典型场景。
webhook是什么 与API的区别在哪里
|
6月前
|
安全 API 开发工具
获取仓库列表接口可以通过SDK或者REST API两种方式调用
获取仓库列表接口可以通过SDK或者REST API两种方式调用
50 2
|
5月前
|
安全 测试技术 API
API对接中需要注意的问题
随着数字化时代的到来,应用程序接口(API)已经成为软件开发和数据交互的重要工具。无论是企业还是个人开发者,都依赖于API来实现应用间的互通性。然而,在API对接过程中,需要注意一系列问题,以确保有效且安全的集成。本文将探讨在API对接时需要关注的关键问题。
|
5月前
|
前端开发 API 开发者
关于API对接中需要注意到的问题
在数字化时代,应用程序接口(API)已经成为不同软件应用程序之间进行数据交互和信息交流的重要桥梁。通过API,开发者可以方便地访问和集成不同平台、系统的数据和功能,以实现更高效、更灵活的业务流程和功能扩展。然而,在进行API对接时,需要注意一系列问题,以确保对接的顺利进行和稳定运行。本文将就API对接中需要注意到的问题进行深入探讨。
|
10月前
|
XML JSON 安全
关于API数据接口的使用说明
关于API数据接口的使用说明
|
10月前
|
XML JSON 网络协议
API与API管理,需要注意什么?
API全称为应用程序编程接口,通俗来讲就是不需要访问程序的源代码,也不需要理解程序实现的方式,只需要通过访问相应接口的URL并填写需要获得的数据的参数名,来获取需要的参数信息。 一个接口可以是一个简单的应用程序,例如电商平台、快递查询、手机归属地查询等等,这些都可以是接口,并且可以直接填写参数取值。
|
关系型数据库 OLAP API
发布 API|学习笔记
快速学习发布 API
122 0
发布 API|学习笔记
|
弹性计算 API
我爱API【3】离线API-DescribeZones
在上次介绍了通过查询地域的接口,本地模拟服务器获取阿里云支持的所有地域列表,相信大家都ECS地域的接口操作已经较为熟悉; 这次介绍一下地域下一级的概念,ZONEID,中文就是可用区的概念。可以理解为
79 0
我爱API【3】离线API-DescribeZones
|
弹性计算 API
我爱API【6】离线API-StopInstance
本次介绍一下暂停ECS服务器的接口操作,便于服务器的维护和保养,暂停操作还是比较有意义的。 暂停操作的接口名称叫做StopInstance, 需要指定一个服务器的实例ID号,方便系统知道对哪一台服务器进行暂停操作。 同样本次测试,也暂时不需
82 0
我爱API【6】离线API-StopInstance
|
弹性计算 API
我爱API【4】离线API-DescribeInstanceStatus
在上次介绍了通过查询可用区的接口后,本地模拟服务器获取阿里云制定地
66 0
我爱API【4】离线API-DescribeInstanceStatus