关于android:MobPush-Android-SDK-API

69次阅读

共计 7893 个字符，预计需要花费 20 分钟才能阅读完成。

推送监听接口

增加推送监听

性能阐明

  • 增加推送监听，音讯下发到设施，可依据推送监听进行业务逻辑操作
  • 自定义音讯达到(透传音讯)、告诉音讯达到、告诉栏音讯点击、增删别名、增删标签事件。

参数阐明

参数

类型

形容

mobPushReceiver

MobPushReceiver

注册推送监听

示例代码

/**
 * import com.mob.pushsdk.MobPushReceiver;
 */
public static void addPushReceiver(MobPushReceiver mobPushReceiver)

MobPushReceiver mobPushReceiver = new MobPushReceiver() {

        @Override
        public void onCustomMessageReceive(Context context, MobPushCustomMessage message) {
            // 接管到自定义音讯（透传音讯）message.getMessageId();// 获取工作 ID
            message.getContent();// 获取推送内容
            ...
        }

        @Override
        public void onNotifyMessageReceive(Context context, MobPushNotifyMessage message) {
            // 告诉音讯达到
            message.getMobNotifyId();// 获取音讯 ID
            message.getMessageId();// 获取工作 ID
            message.getTitle();// 获取推送题目
            message.getContent();// 获取推送内容
            ...
        }

        @Override
        public void onNotifyMessageOpenedReceive(Context context, MobPushNotifyMessage message) {
            // 告诉被点击事件
            message.getMobNotifyId();// 获取音讯 ID
            message.getMessageId();// 获取工作 ID
            message.getTitle();// 获取推送题目
            message.getContent();// 获取推送内容
            ...
        }

        @Override
        public void onTagsCallback(Context context, String[] tags, int operation, int errorCode) {
            // 标签操作回调
            //tags    已增加的标签汇合
            //operation    0: 获取标签 1: 设置标签 2: 删除标签
            //errorCode    0: 操作胜利 其它: 操作失败
            ...
        }

        @Override
        public void onAliasCallback(Context context, String alias, int operation, int errorCode) {
            // 别名操作回调
            //alias    对应的别名
            //operation    0: 获取别名 1: 设置别名 2: 删除别名
            //errorCode    0: 操作胜利 其它: 操作失败
            ...
        }

    };
MobPush.addPushReceiver(mobPushReceiver);

登记推送监听

性能阐明

  • 登记推送监听，在利用销毁时调用登记函数，登记已增加过的推送监听。

参数阐明

参数

类型

形容

mobPushReceiver

MobPushReceiver

登记推送监听

示例代码

/**
 * import com.mob.pushsdk.MobPushReceiver;
 */
public static void removePushReceiver(MobPushReceiver mobPushReceiver)

MobPush.removePushReceiver(mobPushReceiver);

推送服务接口

获取 RegistrationId

性能阐明

  • RegistrationId 是 MobPush SDK 初始化胜利后，MobPush 给每个设施调配的惟一标识（同一个手机不同 App 的 RegistrationId 不同），开发者能够通过指定 RegistrationId 给繁多设施发送推送。

参数阐明

参数

类型

形容

callback

MobPushCallback

获取惟一标识 RegistrationId

示例代码

/**
 * com.mob.pushsdk.MobPushCallback
 */
public static void getRegistrationId(MobPushCallback  callback)

MobPush.getRegistrationId(new MobPushCallback<String>() {
      @Override
      public void onCallback(String registrationId) {...}
});

获取 TCP 状态

性能阐明

  • 获取 TCP 状态 , 判断 TCP 状态是否失常。

参数阐明

参数

类型

形容

callback

MobPushCallback

获取 TCP 连贯状态：true 在线；false 不在线

示例代码

/**
 * com.mob.pushsdk.MobPushCallback
 */
public static void checkTcpStatus(MobPushCallback callback)

MobPush.checkTcpStatus(new MobPushCallback<Boolean>() {
      @Override
      public void onCallback(Boolean aBoolean) {...}
 });

推送服务状态

性能阐明

  • 查看推送服务是否停止使用。

参数阐明

参数

类型

形容

callback

MobPushCallback

获取推送服务状态：true 是已进行；false 是未进行

示例代码

/**
 * com.mob.pushsdk.MobPushCallback
 */
public static void isPushStopped(MobPushCallback callback)

MobPush.isPushStopped(new MobPushCallback<Boolean>() {
      @Override
      public void onCallback(Boolean isStopped) {...}
 });

进行推送服务

性能阐明

  • 进行推送服务，调用后设施不能够接管推送音讯。

示例代码

/**
 * com.mob.pushsdk.MobPush
 */
public static void stopPush()

MobPush.stopPush();

重启推送服务

性能阐明

  • 推送服务是进行状态，能够应用重启接口复原推送服务，能够失常接管推送音讯。

示例代码

/**
 * com.mob.pushsdk.MobPush
 */
public static void restartPush()

MobPush.restartPush();

别名接口

设置别名 API

性能阐明

  • 设置别名；别名是惟一的，与 RegistrationId 为一对一关系。如屡次调用，会以最初一次设置为准，进行笼罩；可在推送监听 API 中的 onAliasCallback 回调函数查看状态是否设置胜利。
  • 别名反对：字母（辨别大小写）、数字、下划线、汉字、特殊字符 @!#$&*+=.|。

参数阐明

参数

类型

形容

alias

String

须要设置的别名

示例代码

/**
 * com.mob.pushsdk.MobPush
 */
public static void setAlias(String alias)

MobPush.setAlias("别名");

获取别名

性能阐明

  • 获取别名；调用该函数后，可在推送监听 API 中的 onAliasCallback 回调函数中查看 RegistrationId 对应的别名。

示例代码

/**
 * com.mob.pushsdk.MobPush
 */
public static void getAlias()

MobPush.getAlias();

删除别名

性能阐明

  • 删除别名；调用该函数后，可在推送监听 API 中的 onAliasCallback 回调函数查看状态是否设置删除别名胜利。

示例代码

/**
 * com.mob.pushsdk.MobPush
 */
public static void deleteAlias()

MobPush.deleteAlias();

标签接口

增加标签

性能阐明

  • 增加标签；标签能够增加多个，每次调用都会在原来的根底上进行追加。可在推送监听 API 中的 onTagsCallback 回调函数查看状态是否增加胜利。
  • 标签反对：字母（辨别大小写）、数字、下划线、汉字、特殊字符 @!#$&*+=.|。

参数阐明

参数

类型

形容

tags

String[]

须要增加的标签

示例代码

/**
 * com.mob.pushsdk.MobPush
 */
public static void addTags(String[] tags)

MobPush.addTags(new String[]{"标签 1", "标签 2"});

获取标签

性能阐明

  • 获取标签；调用该函数后，可在推送监听 API 中的 onTagsCallback 回调函数中查看 RegistrationId 对应的所有标签。

示例代码

/**
 * com.mob.pushsdk.MobPush
 */
public static void getTags()

MobPush.getTags();

删除标签

性能阐明

  • 删除标签；调用该函数后，可在推送监听 API 中的 onTagsCallback 回调函数查看状态是否删除标签胜利。

参数阐明

参数

类型

形容

tags

String[]

须要删除的标签

  • String[] tags 标签数组

示例代码

/**
 * com.mob.pushsdk.MobPush
 */
public static void deleteTags(String[] tags)

MobPush.deleteTags(new String[]{"删除标签 1", "删除标签 2"});

清空标签

性能阐明

  • 清空标签；调用该函数后，可在推送监听 API 中的 onTagsCallback 回调函数查看状态是否清空标签胜利。

示例代码

/**
 * com.mob.pushsdk.MobPush
 */
public static void cleanTags()

MobPush.cleanTags();

本地告诉接口

发送本地告诉

性能阐明

  • 发送本地告诉。不通过服务器推送，客户端被动发送告诉。

参数阐明

参数

类型

形容

localNotification

MobPushLocalNotification

本地告诉对象

callback

MobPushCallback

本地告诉回调

示例代码

/**
 * com.mob.pushsdk.MobPush
 */
public static boolean addLocalNotification(MobPushLocalNotification localNotification, MobPushCallback callback)

MobPushLocalNotification localNotification = new MobPushLocalNotification();
localNotification.setTitle("本地告诉题目");
localNotification.setContent("本地告诉内容");
localNotification.setNotificationId(123);
...
MobPush.addLocalNotification(localNotification, new MobPushCallback<Boolean>() {
      @Override
      public void onCallback(Boolean aBoolean) {
      //true 胜利;false 失败
      ...
      }
  });

移除本地告诉

性能阐明

  • 针对曾经发送的本地告诉音讯进行移除。

参数阐明

参数

类型

形容

lnotificationId

MobPushLocalNotification

本地告诉对象

callback

MobPushCallback

本地告诉回调

示例代码

/**
 * com.mob.pushsdk.MobPush
 */
public static boolean removeLocalNotification(int lnotificationId, MobPushCallback callback)

MobPushLocalNotification localNotification = new MobPushLocalNotification();
localNotification.setNotificationId(123);
...
int lnotificationId = localNotification.getNotificationId();
MobPush.removeLocalNotification(lnotificationId, new MobPushCallback<Boolean>() {
        @Override
        public void onCallback(Boolean aBoolean) {
        //true 胜利;false 失败
        ...
        }
    });

清空本地告诉

性能阐明

  • 清空本地告诉。

参数阐明

参数

类型

形容

callback

MobPushCallback

本地告诉回调

示例代码

/**
 * com.mob.pushsdk.MobPush.class
 */
 public static boolean clearLocalNotifications(MobPushCallback callback)

MobPush.clearLocalNotifications(new MobPushCallback<Boolean>() {
        @Override
        public void onCallback(Boolean aBoolean) {
        //true 胜利;false 失败
        ...
        }
    });

角标接口

设置是否显示角标

性能阐明

  • 设置是否显示角标，用于接管告诉时显示角标数量。

参数阐明

参数

类型

形容

isShowBadge

Boolean

状态：true 显示；false 不显示；默认：true

示例代码

/**
 * com.mob.pushsdk.MobPush.class
 */
public static void setShowBadge(Boolean isShowBadge)

MobPush.setShowBadge(true);

设置显示角标数

性能阐明

  • 设置显示的角标数，用户可依据本人的逻辑进行设置。反对角标性能可参考：Android 常见问题文档

参数阐明

参数

类型

形容

counts

int

角标数

/**
 * com.mob.pushsdk.MobPush.class
 */
public static void setBadgeCounts(int counts)

示例代码

MobPush.setBadgeCounts(0);

告诉栏接口

设置显示告诉的最大条数

性能阐明

  • 针对告诉栏显示的告诉最大条数进行设置，设置值须要大于 0，默认最大是 5 条。

参数阐明

参数

类型

形容

count

int

告诉栏最大显示告诉条数

示例代码

/**
 * com.mob.pushsdk.MobPush.class
 */
public static void setNotificationMaxCount(int count)

MobPush.setNotificationMaxCount(count)

获取显示告诉的最大条数

性能阐明

  • 获取告诉栏显示的告诉最大条数，默认最大是 5 条。

参数阐明

参数

类型

形容

callback

MobPushCallback

告诉栏最大显示告诉条数回调

示例代码

/**
 * com.mob.pushsdk.MobPush.class
 */
public static int getNotificationMaxCount(MobPushCallback callback)

MobPush.getNotificationMaxCount(new MobPushCallback<Integer>() {
                    @Override
                    public void onCallback(Integer integer) {
                    // 显示告诉最大条数
                    ...
                    }
                });

告诉权限接口

关上告诉轮询开关

性能阐明

  • MobPush 只会在初始化的时候更新记录的告诉权限状态。如须要实时更新，可调用该办法。

示例代码

/**
 * com.mob.pushsdk.MobPush.class
 */
public static void startNotificationMonitor()

MobPush.startNotificationMonitor();

敞开告诉轮询开关

性能阐明

  • 敞开告诉权限轮询开关。

示例代码

/**
 * com.mob.pushsdk.MobPush.class
 */
public static void stopNotificationMonitor()

MobPush.stopNotificationMonitor();

其它接口

统计厂商点击数(重要)

性能阐明

  • 统计厂商通道下发告诉的点击数，如不设置，无奈精确统计到厂商通道下发告诉的点击数，倡议加上。不设置仅影响厂商通道的点击数，不影响 MobPush 通道点击数统计。

参数阐明

参数

类型

形容

intent

Intent

取得启动以后流动时的 Intent 内容

示例代码

/**
 * com.mob.pushsdk.MobPush.class
 */
public static void notificationClickAck(Intent intent)

MobPush.notificationClickAck(getIntent());

设置区域

反对版本

  • 反对 3.x 版本

性能阐明

  • 客户端默认是国内版，如有需要可设置海内区域域名。

参数阐明

参数

类型

形容

domainAbroad

int

国内区域：0，海内区域：1

示例代码

/**
 * com.mob.pushsdk.MobPush.class
 */
public static void setDomainAbroad(int  domainAbroad)

MobPush.setDomainAbroad(1);

点击告诉是否启动主页

性能阐明

  • 设置点击告诉是否启动主页。默认为启动。

参数阐明

参数

类型

形容

isLaunch

Boolean

状态：true 是启动；false 是不启动

示例代码

/**
 * com.mob.pushsdk.MobPush.class
 */
public static void setClickNotificationToLaunchMainActivity(Boolean isLaunch)

MobPush.setClickNotificationToLaunchMainActivity(true);

设置告诉勿扰静音

性能阐明

  • 设置静音时段。几点几分开始到几点几分完结，这段时间属于静音时间段，接管到推送时，揭示类型属于静音状态。

参数阐明

参数

类型

形容

startHour

int

开始静音工夫(时)

startMinute

int

开始静音工夫(分)

endHour

int

完结静音工夫(时)

endMinute

int

完结静音工夫(分)

示例代码

/**
 * com.mob.pushsdk.MobPush.class
 */
public static void setSilenceTime(int startHour, int startMinute, int endHour, int  endMinute)

MobPush.setSilenceTime(20, 0, 0, 0);// 设置静音时间段早晨 20:00 到 00:00

性能自定义和扩大

具体可参考上面文档：

MobPush 指定页面跳转最佳实现

安卓推送音讯数据解析举荐实现

备注：官网下载 Demo

正文完
android
发表至： android
2023-04-18
 0
关于android:应用架构指南全新发布
关于android:HDC2022的无障碍参会体验手语服务是如何做到的
关于android:Android基于轻量级Messenger的进程通信
Android-开发技术周报-Issue287