上一篇文章中我们已经成功的集成了极光推送并能够推送消息,但是在企业级别开发中只是能推送消息是不能满足需求的,以为一般企业开发中我们并不在极光平台推送消息,此时企业后台也将接入PC版的极光推送功能,这就涉及到了我们应该和PC进行推送交互,要了解这些我们首先要了解别名,标签,Registration ID的含义
别名与标签 API
功能说明
温馨提示,设置标签别名请注意处理call back结果。只有call back 返回值为 0 才设置成功,
才可以向目标推送。否则服务器 API 会返回1011错误。
别名 alias
为安装了应用程序的用户,取个别名来标识。以后给该用户 Push 消息时,就可以用此别名来指定。
每个用户只能指定一个别名。
同一个应用程序内,对不同的用户,建议取不同的别名。这样,尽可能根据别名来唯一确定用户。
系统不限定一个别名只能指定一个用户。如果一个别名被指定到了多个用户,当给指定这个别名发消息时,服务器端API会同时给这多个用户发送消息。
举例:在一个用户要登录的游戏中,可能设置别名为 userid。游戏运营时,发现该用户 3 天没有玩游戏了,则根据 userid 调用服务器端API发通知到客户端提醒用户。
标签 tag
为安装了应用程序的用户,打上标签。其目的主要是方便开发者根据标签,来批量下发 Push 消息。
可为每个用户打多个标签。
举例: game, old_page, women
Method - setAliasAndTags (with Callback)
调用此 API 来同时设置别名与标签。
需要理解的是,这个接口是覆盖逻辑,而不是增量逻辑。即新的调用会覆盖之前的设置。
在之前调用过后,如果需要再次改变别名与标签,只需要重新调用此 API 即可。
支持的版本
开始支持的版本:1.5.0.
接口定义
public static void setAliasAndTags(Context context,
String alias,
Set<String> tags,
TagAliasCallback callback)
参数定义
-
alias
- null 此次调用不设置此值。(注:不是指的字符串"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为成功,其他返回码请参考错误码定义。
Method - setAlias
调用此 API 来设置别名。
需要理解的是,这个接口是覆盖逻辑,而不是增量逻辑。即新的调用会覆盖之前的设置。
支持的版本
开始支持的版本:1.5.0.
接口定义
public static void setAlias(Context context, String alias, TagAliasCallback callback)
参数定义
-
alias
- "" (空字符串)表示取消之前的设置。
- 每次调用设置有效的别名,覆盖之前的设置。
- 有效的别名组成:字母(区分大小写)、数字、下划线、汉字、特殊字符(v2.1.6支持)@!#$&*+=.|¥。
- 限制:alias 命名长度限制为 40 字节。(判断长度需采用UTF-8编码)
-
callback
- 在TagAliasCallback 的 gotResult 方法,返回对应的参数 alias, tags。并返回对应的状态码:0为成功,其他返回码请参考错误码定义。
Method - setTags
调用此 API 来设置标签。
需要理解的是,这个接口是覆盖逻辑,而不是增量逻辑。即新的调用会覆盖之前的设置。
使用建议
如果待设置的 alias / tags 是动态的,有可能在调用 setAliasAndTags 时因为 alias / tags 无效而整调用失败。
调用此方法只设置 tags,可以排除可能无效的 alias 对本次调用的影响。
支持的版本
开始支持的版本:1.5.0.
接口定义
public static void setTags(Context context, Set<String> tags, TagAliasCallback callback)
参数定义
-
tags
- 空数组或列表表示取消之前的设置。
- 每次调用至少设置一个 tag,覆盖之前的设置,不是新增。
- 有效的标签组成:字母(区分大小写)、数字、下划线、汉字、特殊字符(v2.1.6支持)@!#$&*+=.|¥。
- 限制:每个 tag 命名长度限制为 40 字节,最多支持设置 1000 个 tag,但总长度不得超过7K字节。(判断长度需采用UTF-8编码)
- 单个设备最多支持设置 1000 个 tag。App 全局 tag 数量无限制。
-
callback
- 在 TagAliasCallback 的 gotResult 方法,返回对应的参数 alias, tags。并返回对应的状态码:0为成功,其他返回码请参考错误码定义。
Method - filterValidTag
使用建议
设置 tags 时,如果其中一个 tag 无效,则整个设置过程失败。
如果 App 的 tags 会在运行过程中动态设置,并且存在对 JPush SDK tag 规定的无效字符,
则有可能一个 tag 无效导致这次调用里所有的 tags 更新失败。
这时你可以调用本方法 filterValidTags 来过滤掉无效的 tags,得到有效的 tags,
再调用 JPush SDK 的 set tags / alias 方法。
支持的版本
1.5.0
接口的定义
public static Set<String> filterValidTags(Set<String> tags)
接口返回
有效的 tag 集合。
Class - TagAliasCallback
设置别名与标签方法的回调类,可在 gotResult 方法上得到回调的结果。回调 responseCode = 0,则确认设置成功。
支持的版本
1.5.0
接口定义
public void gotResult(int responseCode, String alias, Set<String> tags);
参数定义
- responseCode
- 0 表示调用成功。
- 其他返回码请参考错误码定义。
- alias
- 原设置的别名
- tags
- 原设置的标签
错误码定义
Code | 描述 | 详细解释 |
---|---|---|
6001 | 无效的设置,tag/alias 不应参数都为 null | |
6002 | 设置超时 | 建议重试 |
6003 | alias 字符串不合法 | 有效的别名、标签组成:字母(区分大小写)、数字、下划线、汉字、特殊字符(v2.1.6支持)@!#$&*+=.|¥ |
6004 | alias超长。最多 40个字节 | 中文 UTF-8 是 3 个字节 |
6005 | 某一个 tag 字符串不合法 | 有效的别名、标签组成:字母(区分大小写)、数字、下划线、汉字、特殊字符(v2.1.6支持)@!#$&*+=.|¥ |
6006 | 某一个 tag 超长。一个 tag 最多 40个字节 | 中文 UTF-8 是 3 个字节 |
6007 | tags 数量超出限制。最多 1000个 | 这是一台设备的限制。一个应用全局的标签数量无限制。 |
6008 | tag 超出总长度限制 | 总长度最多 7K 字节 |
6009 | 未知错误 | 由于权限问题,导致的PushService启动异常。 |
6011 | 10s内设置tag或alias大于10次 | 短时间内操作过于频繁 |
相关文档
- Android别名与标签使用教程
- 标签与别名 API (iOS)
获取 RegistrationID API
支持的版本
r1.6.0 开始支持。
功能说明
RegistrationID 定义
集成了 JPush SDK 的应用程序在第一次成功注册到 JPush 服务器时,JPush 服务器会给客户端返回一个唯一的该设备的标识 - RegistrationID。JPush SDK 会以广播的形式发送 RegistrationID 到应用程序。
应用程序可以把此 RegistrationID 保存以自己的应用服务器上,然后就可以根据 RegistrationID 来向设备推送消息或者通知。
API - getRegistrationID
调用此 API 来取得应用程序对应的 RegistrationID。 只有当应用程序成功注册到 JPush 的服务器时才返回对应的值,否则返回空字符串。
支持的版本
开始支持的版本:1.6.0。
接口定义
//SDK 初次注册成功后,开发者通过在自定义的 Receiver 里监听 Action - cn.jpush.android.intent.REGISTRATION 来获取对应的 RegistrationID。注册成功后,也可以通过此函数获取
public static String getRegistrationID(Context context)
附加说明
通过 RegistrationID 进行点对点推送
可以通过 RegistrationID 来推送消息和通知, 参考文档 Push API v2, 当 receiver_type = 5 并且设置 receiver_value 为 RegistrationID 时候即可根据 RegistrationID 推送。
注:要使用此功能,客户端 App 一定要集成有 r1.6.0 及以上版本的 JPush Android SDK。
通过以上文字的描述相信大家已经对别名,标签 Registration ID 这三个的名词有了很深的理解,下面我们将讲解在企业中如何真正的使用极光推送此文章是在上一篇文章的基础上进行讲解,上一篇文章我们已经完成了对极光SDK的集成,本文我们将描述我们APP开发在极光推送中需要和PC后台做什么
1.初始化推送:
-
init 只需要在应用程序启动时调用一次该 API 即可。
-
以下代码定制一个本应用程序 Application 类。需要在 AndoridManifest.xml 里配置。请参考上面 AndroidManifest.xml 片断,或者 example 项目。
public class ExampleApplication extends Application { @Override public void onCreate() { super.onCreate(); JPushInterface.setDebugMode(true); JPushInterface.init(this); } }
可能一:后台给你在登录成功后返回一个别名,标签,这时你需要调用极光的API将此标示提交到极光推送平台
可能二:APP登录成功后需要调用后台接口提交Registration ID给后台保存在数据
以我们公司为例,在登录成功后我们需要得到Registration ID,并且把Registration ID当做别名上传到极光服务器,并且同时也将Registration ID上传PC服务器
第一:把Registration ID当做别名上传到极光服务器
final String regId = JPushInterface.getRegistrationID(getApplicationContext()); JPushInterface.setAlias(LoginActivity.this, regId, new TagAliasCallback() { @Override public void gotResult(int arg0, String arg1, Set<String> arg2) { Log.e("JP", "setAlias " + arg0); if (arg0 == 0) { } } });第二: 将Registration ID上传PC服务器
private void setPushStatus(String regId) { final Map<String, Object> request = new HashMap<String, Object>(); request.put("token", BaseApplication.getInstance().token); request.put("regId", regId); String url = new StringBuilder().append(EFunConfig.getServer()) .append(InterfacePath.UPDATE_USER_PUSH) .toString(); HttpAsyncUtils.postFormData(this, url, request, new HttpCallBack() { @Override public void onCallback(JsonResult result) { if (null != result) { } } }); }3.在退出APP时可能要做的是需要向PC服务器发送请求通知告之推送登录(公司不同,需求不同,这步不一定要做,此时需要和PC后台开发人员进行沟通)
经过上面的步骤就把APP和极光推送平台,PC服务器连在了一起。