极光推送开发第二弹——极光推送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<String> 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<String> 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<String> 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<Integer> 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广播接收器
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,324评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,303评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,192评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,555评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,569评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,566评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,927评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,583评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,827评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,590评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,669评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,365评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,941评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,928评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,159评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,880评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,399评论 2 342

推荐阅读更多精彩内容