极光推送开发第二弹——极光推送API

极光推送API篇

API传送门

设置调试模式 API

JPushInterface.setDebugMode(true);  // 设置调试模式
// true则会打印debug级别的日志，false则只会打印warning级别以上的日志

初始化推送服务 API

JPushInterface.init(this);
// context 应用的 ApplicationContext

停止与恢复推送服务 API

JPushInterface.stopPush(context);
// 停止推送

JPushInterface.resumePush(context);
// 恢复推送

boolean isStop = JPushInterface.isPushStopped(context);
判断是否停止了推送

别名与标签 API

• 别名 alias：相当于用户名，最好不要有重复，因为推送的时候可能推送给所有叫这个别名的人
• 标签 tag：可为一个用户打上多个标签

// 接口定义：覆盖逻辑
public static void setAliasAndTags(Context context, 
                                   String alias, 
                                   Set tags, 
                                   TagAliasCallback callback)
参数定义：
alias：
 - null 此次调用不设置此值
 - "" （空字符串）表示取消之前的设置
 - 每次调用设置有效的别名，覆盖之前的设置
 - 有效的别名组成：字母（区分大小写）、数字、下划线、汉字、特殊字符(v2.1.6支持)@!#$&*+=.|
 - 限制：alias 命名长度限制为 40 字节。（判断长度需采用UTF-8编码）

tags：
 - null 此次调用不设置此值。（注：不是指的字符串"null"）
 - 空数组或列表表示取消之前的设置
 - 每次调用至少设置一个 tag，覆盖之前的设置，不是新增
 - 有效的标签组成：字母（区分大小写）、数字、下划线、汉字、特殊字符(v2.1.6支持)@!#$&*+=.|
 - 限制：每个 tag 命名长度限制为 40 字节，最多支持设置 1000 个 tag，但总长度不得超过7K字节。（判断长度需采用UTF-8编码）

callback：
 - 在 TagAliasCallback 的 gotResult 方法，返回对应的参数 alias, tags。并返回对应的状态码：0为成功，其他返回码请参考错误码定义

// 接口定义：覆盖逻辑
public static void setAlias(Context context, String alias, TagAliasCallback callback)
参数定义：
alias：
 - null 此次调用不设置此值
 - "" （空字符串）表示取消之前的设置
 - 每次调用设置有效的别名，覆盖之前的设置
 - 有效的别名组成：字母（区分大小写）、数字、下划线、汉字、特殊字符(v2.1.6支持)@!#$&*+=.|
 - 限制：alias 命名长度限制为 40 字节。（判断长度需采用UTF-8编码）

callback：
 - 在 TagAliasCallback 的 gotResult 方法，返回对应的参数 alias, tags。并返回对应的状态码：0为成功，其他返回码请参考错误码定义

// 接口定义：覆盖逻辑
public static void setTags(Context context, Set tags, TagAliasCallback callback)

参数定义：
tags：
null 此次调用不设置此值。（注：不是指的字符串”null”）
空数组或列表表示取消之前的设置
每次调用至少设置一个 tag，覆盖之前的设置，不是新增
有效的标签组成：字母（区分大小写）、数字、下划线、汉字、特殊字符(v2.1.6支持)@!#$&*+=.|
限制：每个 tag 命名长度限制为 40 字节，最多支持设置 1000 个 tag，但总长度不得超过7K字节。（判断长度需采用UTF-8编码）
callback：
在 TagAliasCallback 的 gotResult 方法，返回对应的参数 alias, tags。并返回对应的状态码：0为成功，其他返回码请参考错误码定义

// 接口定义：
public static Set<String> filterValidTags(Set<String> tags)

接口返回：
有效的 tag 集合。

接口定义：
public void gotResult(int responseCode, String alias, Set tags);

参数定义：
● responseCode
○ 0 表示调用成功。
○ 其他返回码请参考错误码定义。
● alias
○ 原设置的别名
● tags
○ 原设置的标签
这里记得对responseCode进行判断一下，有可能因为网络问题没有设置好tags和alias
这里的错误码记得区分一下

http://docs.jiguang.cn/jpush/client/Android/android_api/#client_error_code

获取 RegistrationID API

//RegistrationID 定义：只有当应用程序成功注册到 JPush 的服务器时才返回对应的值，否则返回空字符串。在SDK初次注册时，在Receiver里面也能接收到这个Id，可以通过这个Id向用户推送消息
接口：
public static String getRegistrationID(Context context)

统计分析 API

// 用于“用户使用时长”，“活跃用户”，“用户打开次数”的统计，并上报到服务器，在 Portal 上展示给开发者
public static void onResume(final Activity activity)
public static void onPause(final Activity activity)
// 在所有的 Activity 的 onResume / onPause 方法里调用

// 用于上报用户的通知栏被打开，或者用于上报用户自定义消息被展示等客户端需要统计的事件
public static void reportNotificationOpened(Context context, String msgId)

// 这个在Receiver里面调用
JPushInterface.reportNotificationOpened(context,bundle.getString(JPushInterface.EXTRA_MSG_ID));

清除通知 API

// 清除所有 JPush 展现的通知
public static void clearAllNotifications(Context context);
// 清除指定Id的的通知，这个Id在Receiver里面可以看到
public static void clearNotificationById(Context context, int notificationId);

设置允许推送时间 API

public static void setPushTime(Context context, Set weekDays, int startHour, int endHour)
// Context context 应用的ApplicationContext
// Set days 0表示星期天，1表示星期一，以此类推
// Sdk1.2.9 – 新功能:set的值为null,则任何时间都可以收到消息和通知，set的size为0，则表示任何时间都收不到消息和通知
// int startHour 允许推送的开始时间 （24小时制：startHour的范围为0到23）
// int endHour 允许推送的结束时间 （24小时制：endHour的范围为0到23）

设置通知静默时间 API

public static void setSilenceTime(Context context, int startHour, int startMinute, int endHour, int endMinute)
// Context context 应用的ApplicationContext
// int startHour 静音时段的开始时间 - 小时 （24小时制，范围：0~23 ）
// int startMinute 静音时段的开始时间 - 分钟（范围：0~59 ）
// int endHour 静音时段的结束时间 - 小时 （24小时制，范围：0~23 ）
// int endMinute 静音时段的结束时间 - 分钟（范围：0~59 ）

JPushInterface.setSilenceTime(getApplicationContext(), 22, 30, 8, 30);
// 此代码表示晚上10：30点到第二天早上8：30点为静音时段

申请权限接口（Android 6.0 及以上）

public static void requestPermission(Context context);

通知栏样式定制 API

自定义通知栏的教程：
http://docs.jiguang.cn/jpush/client/Android/android_senior/#_8

设置保留最近通知条数 API（这个可以调用多次，覆盖）

public static void setLatestNotificationNumber(Context context, int maxNum)

CrashLog收集并上报API

// 开启收集错误日志
public static void initCrashHandler(Context context);
// 关闭收集错误日志
public static void stopCrashHandler(Context context);

获取推送连接状态（可以在Receiver监听）

public static boolean getConnectionState(Context context);

本地通知API

// 添加一个本地通知
public static void addLocalNotification(Context context, JPushLocalNotification notification)
// 移除本地通知
public static void removeLocalNotification(Context context, long notificationId)
// 移除所有本地通知
public static void clearLocalNotifications(Context context)

github项目地址

写一篇博客，让自己熟悉一下极光推送的API，下一篇将介绍下自定义JPush广播接收器