离线推送流程
实现离线消息推送的过程如下:
- 开发者到厂商的平台注册账号,并通过开发者认证后,申请开通推送服务。
- 创建推送服务,并绑定应用信息,获取推送证书、密码、密钥等信息。
- 登录 即时通信 IM 控制台 填写推送证书及相关信息,即时通信 IM 服务端会为每个证书生成不同的证书 ID。
- 将厂商提供的推送 SDK 集成到开发者的项目工程中,并按各厂商的要求进行配置。
- 集成即时通信 IM SDK 到项目后,将证书 ID、设备信息等上报至即时通信 IM 服务端。
- 当客户端 App 在即时通信 IM 没有退出登录的情况下,被系统或者用户 kill 时,即时通信 IM 服务端将通过消息推送进行提醒。
配置离线推送
Flyme 为深度定制 Android 系统,对于第三方 App 自启动权限管理很严格,默认情况下第三方 App 都不会在系统的自启动白名单内,App 在后台时容易被系统 kill,因此推荐在魅族设备上集成魅族推送,魅族推送是 Flyme 的系统级服务,推送到达率较高。目前,即时通信 IM 仅支持魅族推送的通知栏消息。
注意:
- 此指引文档是直接参考魅族官方文档所写,若魅族推送有变动,请以魅族推送官网文档为准。
- 此指引是根据 Flyme 推送接入指南所写,仅针对 Flyme 系统,并非魅族统一推送平台(各个厂家的整合)。
- 如果不需要对魅族设备做专门的离线推送适配,可以忽略此章节。
步骤1:申请魅族推送证书
- 打开 魅族开放平台官网 进行注册并通过开发者认证。
>?认证过程大约需要3天左右,请务必提前阅读魅族推送服务启用指南,以免影响您的接入进度。 - 登录魅族开放平台的管理控制台,选择【服务】>【集成推送服务】>【推送后台】,创建魅族推送服务应用。
魅族推送服务应用创建完成后,在应用详情中,您可以查看详细的应用信息。 - 记录
应用包名
、App ID
、App Secret
信息。
步骤2:托管证书信息到即时通信 IM
- 登录腾讯云 即时通信 IM 控制台,单击目标应用卡片,进入应用的基础配置页面。
- 单击【Android平台推送设置】区域的【添加证书】。
>?如果您原来已有证书只需变更信息,可以单击【Android平台推送设置】区域的【编辑】进行修改更新。
> - 根据 步骤1 中获取的信息设置以下参数:
- 推送平台:选择魅族
- 应用包名称:填写魅族推送服务应用的应用包名
- AppID:填写魅族推送服务应用的 App ID
- AppSecret:填写魅族推送服务应用的 App Secret
- 点击通知后:选择点击通知栏消息后的响应操作, 支持打开应用、打开网页和打开应用内指定界面,更多详情请参见 配置点击通知栏消息事件
当设置为【打开应用】或【打开应用内指定界面】操作时,支持 透传自定义内容。
- 单击【确认】保存信息,证书信息保存后10分钟内生效。
- 待推送证书信息生成后,记录证书的
ID
。
步骤3:集成推送 SDK
说明:
- 即时通信 IM 默认推送的通知标题为
a new message
。- 阅读此小节前,请确保您已经正常集成并使用即时通信 IM SDK。
- 您可以在我们的 demo 里找到魅族推送的实现示例,请注意:魅族推送版本更新时有可能会有功能调整,若您发现本节内容存在差异,烦请您及时查阅 魅族推送官网文档,并将文档信息差异反馈给我们,我们会及时跟进修改。
步骤3.1:下载魅族推送 SDK 并添加引用
访问 魅族推送运营平台 下载魅族 Flyme 推送 SDK aar 包或者使用 jcenter 集成。
dependencies {
// MEIZU push sdk
compile 'com.meizu.flyme.internet:push-internal:3.6.+@aar'
}
步骤3.2:配置 AndroidManifest.xml 文件
添加魅族推送必须的权限:
<!-- ********魅族推送权限设置 start******** -->
<!-- 兼容 flyme5.0 以下版本,魅族内部集成 pushSDK 必填,不然无法收到消息-->
<uses-permission android:name="com.meizu.flyme.push.permission.RECEIVE"></uses-permission>
<permission
android:name="com.tencent.qcloud.tim.tuikit.push.permission.MESSAGE"
android:protectionLevel="signature"/>
<uses-permission android:name="com.tencent.qcloud.tim.tuikit.push.permission.MESSAGE"></uses-permission>
<!-- 兼容 flyme3.0 配置权限-->
<uses-permission android:name="com.meizu.c2dm.permission.RECEIVE" />
<permission
android:name="com.tencent.qcloud.tim.tuikit.permission.C2D_MESSAGE"
android:protectionLevel="signature"></permission>
<uses-permission android:name="com.tencent.qcloud.tim.tuikit.permission.C2D_MESSAGE"/>
<!-- ********魅族推送权限设置 end******** -->
<!--这里的 com.tencent.qcloud.tim.tuikit 改成您的 App 的包名-->
步骤3.3:自定义一个 BroadcastReceiver 类
为了接收消息,您需要自定义一个继承自MzPushMessageReceiver
类的 BroadcastReceiver,并实现其中的onRegisterStatus
方法,然后将此 receiver 注册到 AndroidManifest.xml 中。
以下为 Demo 中的示例代码:
public class MEIZUPushReceiver extends MzPushMessageReceiver {
private static final String TAG = "MEIZUPushReceiver";
@Override
public void onRegisterStatus(Context context, RegisterStatus registerStatus) {
QLog.i(TAG, "onRegisterStatus token = " + registerStatus.getPushId());
ThirdPushTokenMgr.getInstance().setThirdPushToken(registerStatus.getPushId());
ThirdPushTokenMgr.getInstance().setPushTokenToTIM();
}
}
将自定义的 BroadcastReceiver 注册到 AndroidManifest.xml:
<!--这里的 com.tencent.qcloud.tim.demo.thirdpush.MEIZUPushReceiver 修改成您 App 中的完整类名-->
<!-- ********魅族推送设置 start******** -->
<receiver android:name="com.tencent.qcloud.tim.demo.thirdpush.MEIZUPushReceiver">
<intent-filter>
<!-- 接收 push 消息 -->
<action android:name="com.meizu.flyme.push.intent.MESSAGE" />
<!-- 接收 register 消息 -->
<action android:name="com.meizu.flyme.push.intent.REGISTER.FEEDBACK" />
<!-- 接收 unregister 消息-->
<action android:name="com.meizu.flyme.push.intent.UNREGISTER.FEEDBACK"/>
<!-- 兼容低版本 Flyme3 推送服务配置 -->
<action android:name="com.meizu.c2dm.intent.REGISTRATION" />
<action android:name="com.meizu.c2dm.intent.RECEIVE" />
<category android:name="com.tencent.qcloud.tim.demo.thirdpush"></category>
</intent-filter>
</receiver>
<!-- ********魅族推送设置 end******** -->
步骤3.4:在 App 中注册魅族推送服务
如果您选择启用魅族离线推送,需要向魅族服务器注册推送服务,通过调用PushManager.register
来对魅族推送服务进行初始化。PushManager.register
可在任意地方调用,为了提高注册成功率,魅族官方建议在 Application 的onCreate
中调用。
注册成功后,您将在 步骤3.3 自定义的 BroadcastReceiver 的onRegisterStatus
中收到注册结果。其中registerStatus.getPushId()
为当前设备上当前 App 的唯一标识,请记录PushId
信息。
以下为 Demo 中的示例代码:
public class DemoApplication extends Application {
private static PojoApplication instance;
@Override
public void onCreate() {
super.onCreate();
// 判断是否是在主线程
if (SessionWrapper.isMainProcess(getApplicationContext())) {
/**
* TUIKit 的初始化函数
*
* @param context 应用的上下文,一般为对应应用的 ApplicationContext
* @param sdkAppID 您在腾讯云注册应用时分配的 SDKAppID
* @param configs TUIKit 的相关配置项,一般使用默认即可,需特殊配置参考 API 文档
*/
long current = System.currentTimeMillis();
TUIKit.init(this, Constants.SDKAPPID, BaseUIKitConfigs.getDefaultConfigs());
System.out.println(">>>>>>>>>>>>>>>>>>"+(System.currentTimeMillis()-current));
// 添加自定初始化配置
customConfig();
System.out.println(">>>>>>>>>>>>>>>>>>"+(System.currentTimeMillis()-current));
if(IMFunc.isBrandXiaoMi()){
// 小米离线推送
MiPushClient.registerPush(this, Constants.XM_PUSH_APPID, Constants.XM_PUSH_APPKEY);
}
if(IMFunc.isBrandHuawei()){
// 华为离线推送
HMSAgent.init(this);
}
if(MzSystemUtils.isBrandMeizu(this)){
// 魅族离线推送
PushManager.register(this, Constants.MZ_PUSH_APPID, Constants.MZ_PUSH_APPKEY);
}
if(IMFunc.isBrandVivo()){
// vivo 离线推送
PushClient.getInstance(getApplicationContext()).initialize();
}
}
instance = this;
}
}
步骤4:上报推送信息至即时通信 IM 服务端
若您需要通过魅族推送进行即时通信 IM 消息的推送通知,必须在用户登录成功后通过TIMManager
中的setOfflinePushToken
方法将您托管到即时通信 IM 控制台生成的 证书 ID 及魅族推送服务端生成的 PushId 上报到即时通信 IM 服务端。
注意:正确上报 PushId 与证书 ID 后,即时通信 IM 服务才能将用户与对应的设备信息绑定,从而使用魅族推送服务进行推送通知。
以下为 Demo 中的示例代码:
- 定义证书 ID 常量:
/** * 我们先定义一些常量信息在 Constants.java */ /****** 魅族离线推送参数 start ******/ // 使用您在即时通信 IM 控制台上魅族推送证书信息里的证书 ID public static final long MZ_PUSH_BUZID = 6666; // 魅族开放平台分配的应用 APPID 及 APPKEY public static final String MZ_PUSH_APPID = "1234512345123451234"; public static final String MZ_PUSH_APPKEY = "1234512345123"; /****** 魅族离线推送参数 end ******/
- 上报推送的证书 ID 及 PushId:
/** * 在 ThirdPushTokenMgr.java 中对推送的证书 ID 及设备信息进行上报操作 */ public class ThirdPushTokenMgr { private static final String TAG = "ThirdPushTokenMgr"; private String mThirdPushToken; public static ThirdPushTokenMgr getInstance () { return ThirdPushTokenHolder.instance; } private static class ThirdPushTokenHolder { private static final ThirdPushTokenMgr instance = new ThirdPushTokenMgr(); } public void setThirdPushToken(String mThirdPushToken) { this.mThirdPushToken = mThirdPushToken; // PushId 在此处传值,结合上文自定义 BroadcastReciever 类文档说明 } public void setPushTokenToTIM(){ if(mIsTokenSet){ QLog.i(TAG, "setPushTokenToTIM mIsTokenSet true, ignore"); return; } String token = ThirdPushTokenMgr.getInstance().getThirdPushToken(); if(TextUtils.isEmpty(token)){ QLog.i(TAG, "setPushTokenToTIM third token is empty"); mIsTokenSet = false; return; } if( !mIsLogin ){ QLog.i(TAG, "setPushTokenToTIM not login, ignore"); return; } TIMOfflinePushToken param = null; if(IMFunc.isBrandXiaoMi()){ // 判断厂商品牌,根据不同厂商选择不同的推送服务 param = new TIMOfflinePushToken(Constants.XM_PUSH_BUZID, token); }else if(IMFunc.isBrandHuawei()){ param = new TIMOfflinePushToken(Constants.HW_PUSH_BUZID, token); }else if(IMFunc.isBrandMeizu()){ param = new TIMOfflinePushToken(Constants.MZ_PUSH_BUZID, token); }else if(IMFunc.isBrandOppo()){ param = new TIMOfflinePushToken(Constants.OPPO_PUSH_BUZID, token); }else if(IMFunc.isBrandVivo()){ param = new TIMOfflinePushToken(Constants.VIVO_PUSH_BUZID, token); }else{ return; } TIMManager.getInstance().setOfflinePushToken(param, new TIMCallBack() { @Override public void onError(int code, String desc) { Log.d(TAG, "setOfflinePushToken err code = " + code); } @Override public void onSuccess() { Log.d(TAG, "setOfflinePushToken success"); mIsTokenSet = true; } }); } }
步骤5:离线推送
成功上报证书 ID 及 PushId 后,即时通信 IM 服务端会在该设备上的即时通信 IM 用户 logout 之前、APP 被 kill 之后,将消息通过魅族推送通知到用户端。
说明:
- 魅族推送并非100%必达。
- 魅族推送可能会有一定延时,通常与 App 被 kill 的时机有关,部分情况下与魅族推送服务有关。
- 若即时通信 IM 用户已经 logout 或被即时通信 IM 服务端主动下线(例如在其他端登录被踢等情况),则该设备上不会再收到消息推送。
配置点击通知栏消息事件
您可以选择点击通知栏消息后打开应用、打开网页或打开应用内指定界面。
打开应用
默认为点击通知栏消息打开应用。
打开网页
您需要在 添加证书 时选择【打开网页】并输入以http://
或https://
开头的网址,例如https://cloud.tencent.com/document/product/269
。
打开应用内指定界面
您需要在 添加证书 时选择【打开应用内指定界面】并输入需要打开的 Activity 的完整类名,例如com.tencent.qcloud.tim.demo.chat.ChatActivity
。
透传自定义内容
添加证书 时设置【点击通知后】为【打开应用】或【打开应用内指定界面】操作才支持透传自定义内容。
步骤1:发送端设置自定义内容
在发消息前设置每条消息的通知栏自定义内容。
Android 端示例如下:
String extContent = "ext content"; TIMMessageOfflinePushSettings settings = new TIMMessageOfflinePushSettings(); settings.setExt(extContent.getBytes()); timMessage.setOfflinePushSettings(settings); mConversation.sendMessage(false, timMessage, callback);
服务端示例请参见 OfflinePushInfo 的格式示例。
步骤2:接收端获取自定义内容
点击通知栏的消息时,会触发魅族推送 SDK 的 onNotificationClicked(Context context, MzPushMessage mzPushMessage)
回调 ,自定义内容可以从 mzPushMessage
中获取。
String extContent = mzPushMessage.getSelfDefineContentString();
另外,客户端也可以在打开的 Activity
中获取自定义内容。 Bundle bundle = getIntent().getExtras();
String extContent = bundle.getString("ext");
常见问题
如果应用使用了混淆,如何防止魅族离线推送功能异常?
如果您的应用使用了混淆,为了防止魅族离线推送功能异常,您需要 keep 自定义的 BroadcastReceiver,参考添加以下混淆规则:
说明:以下代码为魅族官方示例,请根据实际情况修改后再使用。
# 请将 com.tencent.qcloud.tim.demo.thirdpush.MEIZUPushReceiver 改成您 App 中定义的完整类名
-keep com.tencent.qcloud.tim.demo.thirdpush.MEIZUPushReceiver {*;}
能否自定义配置推送提示音?
目前魅族推送不支持自定义的提示音。
收不到推送时,如何排查问题?
- 任何推送都不是100%必达,厂商推送也不例外。因此,若在快速、连续的推送过程中偶现一两条推送未通知提醒,通常是由厂商推送频控的限制引起。
- 按照推送的流程,确认魅族推送证书信息是否正确配置在 即时通信 IM 控制台中。
- 确认您的项目 集成魅族推送 SDK 的配置正确,并正常获取到了 PushId。
- 确认您已将正确的 推送信息上报 至即时通信 IM 服务端。
- 在设备中手动 kill App,发送若干条消息,确认是否能在一分钟内接收到通知。