EMOptions options = new EMOptions();
...
EMPushConfig.Builder builder = new EMPushConfig.Builder(this);
// 设置支持哪家手机厂商推送。
builder.enableMiPush(String appId, String appKey)
//开发者需要调用该方法开启华为推送。
.enableHWPush();
// Sets pushconfig to ChatOptions.
options.setPushConfig(builder.build());
// Initializes IM SDK.
EMClient.getInstance().init(this, options);
==== 2. 混淆 ====
* 如果你在项目中开启了混淆，请把以下规则添加到你的混淆规则中：
-keep class com.hyphenate.** {*;}
-dontwarn com.hyphenate.**
* 第三方推送的混淆规则，需到各开发者推送平台查看。
==== 3. 手机厂商推送集成 ====
=== FCM 推送集成 ===
- Firebase 控制台创建项目
* 1.1 在 [[https://console.firebase.google.com/|Firebase console]] 创建项目，并注册 Android 应用。
* 1.2 按照提示去下载 google-services.json 文件到本地，并按照引导放置到项目的指定位置。
* 1.3 跳转到 ''%%Project settings%%'' 页面，选择 ''%%Cloud Messaging%%'' 标签，即可看到 ''%%Server ID%%'' 和 ''%%Server Key%%''。
dependencies {
// Google Firebase cloud messaging
classpath 'com.google.gms:google-services:4.3.8'
}
* 3.2 在项目的 module 的 gradle 文件中（通常为 /app/build.gradle ） 配置 FCM 库的依赖。
dependencies {
// ...
// FCM: Import the Firebase BoM
implementation platform('com.google.firebase:firebase-bom:28.4.1')
// FCM: Declare the dependencies for the Firebase Cloud Messaging
// When using the BoM, you don't specify versions in Firebase library dependencies
implementation 'com.google.firebase:firebase-messaging'
}
// Add the following line:
apply plugin: 'com.google.gms.google-services' // Google Services plugin
* 3.3 同步应用后，继承 ''%%FirebaseMessagingService%%'' 的服务，并将其在 ''%%AndroidManifest.xml%%'' 中注册。
* 3.4 在环信即时通讯 IM SDK 中启用 FCM。
EMOptions options = new EMOptions();
...
EMPushConfig.Builder builder = new EMPushConfig.Builder(this);
// Replace to Your FCM sender id
builder.enableFCM("Your FCM sender id");
// Set pushconfig to EMOptions
options.setPushConfig(builder.build());
// To initialize Easemob IM SDK
EMClient.getInstance().init(this, options);
// After the SDK is initialized
EMPushHelper.getInstance().setPushListener(new EMPushListener() {
@Override
public void onError(EMPushType pushType, long errorCode) {
EMLog.e("PushClient", "Push client occur a error: " + pushType + " - " + errorCode);
}
@Override
public boolean isSupportPush(EMPushType pushType, EMPushConfig pushConfig) {
// Set whether FCM is supported
if(pushType == EMPushType.FCM) {
return GoogleApiAvailabilityLight.getInstance().isGooglePlayServicesAvailable(MainActivity.this)
== ConnectionResult.SUCCESS;
}
return super.isSupportPush(pushType, pushConfig);
}
});
* 3.5 环信即时通讯 IM SDK 登录成功后，上传 FCM 的 device token。
// Check whether FCM is supported
if(GoogleApiAvailabilityLight.getInstance().isGooglePlayServicesAvailable(MainActivity.this) != ConnectionResult.SUCCESS) {
return;
}
FirebaseMessaging.getInstance().getToken().addOnCompleteListener(new OnCompleteListener() {
@Override
public void onComplete(@NonNull Task task) {
if (!task.isSuccessful()) {
EMLog.d("PushClient", "Fetching FCM registration token failed:"+task.getException());
return;
}
// Get new FCM registration token
String token = task.getResult();
EMClient.getInstance().sendFCMTokenToServer(token);
}
});
* 3.6 监控 device token 生成。
* 重写 ''%%FirebaseMessagingService%%'' 中的 ''%%onNewToken%%'' 方法，device token 更新后及时更新到环信即时通讯 IM SDK。
public class EMFCMMSGService extends FirebaseMessagingService {
private static final String TAG = "EMFCMMSGService";
@Override
public void onMessageReceived(RemoteMessage remoteMessage) {
super.onMessageReceived(remoteMessage);
if (remoteMessage.getData().size() > 0) {
String message = remoteMessage.getData().get("alert");
Log.d(TAG, "onMessageReceived: " + message);
}
}
@Override
public void onNewToken(@NonNull String token) {
Log.i("MessagingService", "onNewToken: " + token);
// If you want to send messages to this application instance or
// manage this apps subscriptions on the server side, send the
// FCM registration token to your app server.
if(EMClient.getInstance().isSdkInited()) {
EMClient.getInstance().sendFCMTokenToServer(token);
}
}
}
=== 华为 HMS 推送集成 ===
- 华为开发者后台创建应用
在华为开发者后台创建应用，并开启 push 服务，并上传对应的证书指纹，具体可以看下华为官方介绍： [[http://developer.huawei.com/consumer/cn/service/hms/catalog/huaweipush.html?page=hmssdk_huaweipush_devprepare|华为 HMS 消息推送服务集成]]。
* 3.3 [[https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/android-client-dev-0000001050042041|获取 Token 及 自动初始化]]。
* 3.4 在 SDK 初始化的时候，配置启用华为推送。
EMOptions options = new EMOptions();
...
EMPushConfig.Builder builder = new EMPushConfig.Builder(this);
builder.enableHWPush();
// Set pushconfig to ChatOptions
options.setPushConfig(builder.build());
// To initialize Agora Chat SDK
EMClient.getInstance().init(this, options);
* 3.5 [[https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/android-intelligent-classification-0000001050040120|华为通知消息智能分类]]。
=== 小米推送集成 ===
环信即时通讯 IM SDK 中已经集成了小米推送（基于 ''%%MiPush_SDK_Client_3_6_12.jar%%''）相关逻辑，你还需要完成以下步骤：
- 在小米开发者站创建应用
在 [[http://developer.xiaomi.com/|小米开发者站]] 创建应用，并开启 push 服务，具体可以看下小米官方介绍： [[https://dev.mi.com/console/doc/detail?pId=68|推送服务接入指南]]。
* 推送服务需要配置的 service 和 receiver：
* 3.3 自定义一个继承自环信即时通讯 IM SDK 中 **EMMiMsgReceiver** 类的 ''%%BroadcastReceiver%%''，并进行注册：
* 3.4 在 SDK 初始化的时候，配置启用小米推送。
EMOptions options = new EMOptions();
...
EMPushConfig.Builder builder = new EMPushConfig.Builder(this);
builder.enableMiPush(String appId, String appKey);
// Set pushconfig to ChatOptions
options.setPushConfig(builder.build());
// To initialize Agora Chat SDK
EMClient.getInstance().init(this, options);
=== OPPO 推送集成 ===
环信即时通讯 IM SDK 中已经集成了 OPPO 推送相关逻辑，你还需要完成以下步骤：
- 在 OPPO 开发者后台创建应用
* 在 OPPO 开发者后台创建应用，并开启 push 服务，并上传对应的证书指纹，具体可以看下 OPPO 官方介绍：[[https://open.oppomobile.com/wiki/doc#id=10195|OPPO 推送服务集成]]
* 推送服务需要的 service：
* 3.3 在 SDK 初始化的时候，配置启用 OPPO 推送
EMOptions options = new EMOptions();
...
EMPushConfig.Builder builder = new EMPushConfig.Builder(this);
builder.enableOppoPush(String appKey,String appSecret);
// Set pushconfig to ChatOptions
options.setPushConfig(builder.build());
// To initialize Agora Chat SDK
EMClient.getInstance().init(this, options);
* 3.4 调用 OPPO 推送的初始化
HeytapPushManager.init(context, true);
=== VIVO 推送集成 ===
环信即时通讯 IM SDK 中已经集成了 VIVO 推送（基于 ''%%vivo_push_v2.3.1.jar%%''）相关逻辑，你还需要完成以下步骤：
- 在 VIVO 开发者后台创建应用
* 在 VIVO 开发者后台创建应用，并开启 push 服务，并上传对应的证书指纹，具体可以看下 VIVO 官方介绍：[[https://dev.vivo.com.cn/documentCenter/doc/281|VIVO 推送服务集成]]
* 3.3 在 SDK 初始化的时候，配置启用 VIVO 推送
EMOptions options = new EMOptions();
...
EMPushConfig.Builder builder = new EMPushConfig.Builder(this);
builder.enableVivoPush();
// Set pushconfig to ChatOptions
options.setPushConfig(builder.build());
// To initialize Agora Chat SDK
EMClient.getInstance().init(this, options);
* 3.4 VIVO 设备安装应用后默认没有打开允许通知权限，测试前请先去设置中打开该应用的允许通知权限。
[[https://dev.vivo.com.cn/documentCenter/doc/158|VIVO 推送官方文档]]
=== 魅族推送集成 ===
- 在魅族开发者后台创建应用
* 在魅族开发者后台创建应用，并开启 push 服务，并上传对应的证书指纹，具体可以看下魅族官方介绍：[[http://open-wiki.flyme.cn/index.php?title=Flyme推送接入文档|flyme 推送服务集成]]
dependencies{
// 该 aar 托管在 jcenter 中，请确保当前项目已配置 jcenter 仓库。
implementation 'com.meizu.flyme.internet:push-internal:3.7.0@aar'
}
* 3.2 配置 ''%%AndroidManifest.xml%%''。
* 推送服务需要的权限列表：
* 推送服务需要的 receiver：
* 3.3 在 SDK 初始化的时候，配置启用魅族推送。
EMOptions options = new EMOptions();
...
EMPushConfig.Builder builder = new EMPushConfig.Builder(this);
builder.enableVivoPush();
// Set pushconfig to ChatOptions
options.enableMeiZuPush(String appId,String appKey);
// To initialize Agora Chat SDK
EMClient.getInstance().init(this, options);
==== 4. 设置离线推送 ====
环信 IM 3.9.2 及以上版本对离线消息推送进行了优化。你可以对 app 以及各类型的会话开启和关闭离线推送功能，关闭时可设置关闭时长。
环信 IM 支持你对离线推送功能进行如下配置：
* 设置推送通知，包含设置推送通知方式和免打扰模式。
* 配置推送翻译和推送模板。
=== 4.1 设置推送通知 ===
为优化用户在处理大量推送通知时的体验，环信 IM 在 app 和会话层面提供了推送通知和免打扰（DND）模式的细粒度选项，如下表所示：
| 模式 | 选项 | App | 会话 |
|---|---|---|---|
| 推送通知方式 | ALL：接收所有离线消息的推送通知。 | ✓ | ✓ |
| MENTION_ONLY：仅接收提及消息的推送通知。 | ✓ | ✓ | |
| NONE：不接收离线消息的推送通知。 | ✓ | ✓ | |
| 免打扰模式 | SILENT_MODE_DURATION：在指定的持续时间内不接收推送通知。 | ✓ | ✓ |
| SILENT_MODE_INTERVAL：在指定的时间范围内不接收推送通知。 | ✓ | ✗ |
//设置推送通知方式为 `MentionOnly`。
EMSilentModeParam param = new EMSilentModeParam(EMSilentModeParam.EMSilentModeParamType.REMIND_TYPE)
.setRemindType(EMPushManager.EMPushRemindType.MENTION_ONLY);
//设置离线推送免打扰时长为 15 分钟。
EMSilentModeParam param = new EMSilentModeParam(EMSilentModeParam.EMSilentModeParamType.SILENT_MODE_DURATION)
.setSilentModeDuration(15);
//设置离线推送的免打扰时间段为 8:30 到 15:00。
EMSilentModeParam param = new EMSilentModeParam(EMSilentModeParam.EMSilentModeParamType.SILENT_MODE_INTERVAL)
.setSilentModeInterval(new EMSilentModeTime(8, 30), new EMSilentModeTime(15, 0));
//设置 app 的离线推送免打扰模式。
EMClient.getInstance().pushManager().setSilentModeForAll(param, new EMValueCallBack(){});
== 4.1.2 获取 app 的推送通知设置 ==
你可以调用 ''%%getSilentModeForAll%%'' 获取 app 级别的推送通知设置，如以下代码示例所示：
EMClient.getInstance().pushManager().getSilentModeForAll(new EMValueCallBack(){
@Override
public void onSuccess(EMSilentModeResult result) {
//获取 app 的推送通知方式。
EMPushManager.EMPushRemindType remindType = result.getRemindType();
//获取 app 的离线推送免打扰过期的 Unix 时间戳。
long timestamp = result.getExpireTimestamp();
//获取 app 的离线推送免打扰时间段的开始时间。
EMSilentModeTime startTime = result.getSilentModeStartTime();
startTime.getHour();//免打扰时间段的开始时间中的小时数。
startTime.getMinute();//免打扰时间段的开始时间中的分钟数。
//获取 app 的离线推送免打扰时间段的结束时间。
EMSilentModeTime endTime = result.getSilentModeEndTime();
}
@Override
public void onError(int error, String errorMsg) {}
});
== 4.1.3 设置单个会话的推送通知 ==
你可以调用 ''%%setSilentModeForConversation%%'' 设置指定会话的推送通知，并通过指定 ''%%EMSilentModeParam%%'' 字段设置推送通知方式和免打扰模式，如以下代码示例所示：
//设置推送通知方式为 `MENTION_ONLY`。
EMSilentModeParam param = new EMSilentModeParam(EMSilentModeParam.EMSilentModeParamType.REMIND_TYPE)
.setRemindType(EMPushManager.EMPushRemindType.MENTION_ONLY);
//设置离线推送免打扰时长为 15 分钟。
EMSilentModeParam param = new EMSilentModeParam(EMSilentModeParam.EMSilentModeParamType.SILENT_MODE_DURATION)
.setSilentDuration(15);
//设置会话的离线推送免打扰模式。目前，暂不支持设置会话免打扰时间段。
EMClient.getInstance().pushManager().setSilentModeForConversation(conversationId, conversationType, param, new EMValueCallBack(){});
== 4.1.4 获取单个会话的推送通知设置 ==
你可以调用 ''%%getSilentModeForConversation%%'' 获取指定会话的推送通知设置，如以下代码示例所示：
EMClient.getInstance().pushManager().getSilentModeForConversation(conversationId, conversationType, new EMValueCallBack(){
@Override
public void onSuccess(EMSilentModeResult result) {
//获取会话是否设置了推送通知方式。
boolean enable = result.isConversationRemindTypeEnabled();
//检查会话是否设置了推送通知方式。
if(enable){
//获取会话的推送通知方式。
EMPushManager.EMPushRemindType remindType = result.getRemindType();
}
//获取会话的离线推送免打扰过期 Unix 时间戳。
long timestamp = result.getExpireTimestamp();
}
@Override
public void onError(int error, String errorMsg) {}
});
== 4.1.5 获取多个会话的推送通知设置 ==
- 你可以在每次调用中最多获取 20 个会话的设置。
- 如果会话继承了 app 设置或其推送通知设置已过期，则返回的字典不包含此会话。
你可以调用 ''%%getSilentModeForConversations%%'' 获取多个会话的推送通知设置，如以下代码示例所示：
EMClient.getInstance().pushManager().getSilentModeForConversations(conversationList, new EMValueCallBack>(){
@Override
public void onSuccess(Map value) {}
@Override
public void onError(int error, String errorMsg) {}
});
== 4.1.6 清除单个会话的推送通知方式的设置 ==
你可以调用 ''%%clearRemindTypeForConversation%%'' 清除指定会话的推送通知方式的设置。清除后，默认情况下，此会话会继承 app 的设置。
以下代码示例显示了如何清除会话的推送通知方式：
//清除指定会话的推送通知方式设置。清除后，该会话会采取 app 的设置。
EMClient.getInstance().pushManager().clearRemindTypeForConversation(conversationId, conversationType, new EMCallBack(){});
=== 4.2 设置显示属性 ===
== 4.2.1 设置推送通知的显示属性 ==
你可以调用 ''%%updatePushNickname%%'' 设置推送通知中显示的昵称，如以下代码示例所示：
//需要异步处理。
EMClient.getInstance().pushManager().updatePushNickname("pushNickname");
你也可以调用 ''%%updatePushDisplayStyle%%'' 设置推送通知的显示样式，如下代码示例所示：
//设置为简单样式。
EMPushManager.DisplayStyle displayStyle = EMPushManager.DisplayStyle.SimpleBanner;
//需要异步处理。
EMClient.getInstance().pushManager().updatePushDisplayStyle(displayStyle);
''%%DisplayStyle%%'' 是枚举类型。
^参数 ^描述 ^
|''%%SimpleBanner%%'' |显示 “你有一条新消息”。 |
|''%%MessageSummary%%'' |显示消息内容。 |
== 4.2.2 获取推送通知的显示属性 ==
你可以调用 ''%%getPushConfigsFromServer%%'' 获取推送通知中的显示属性，如以下代码示例所示：
EMPushConfigs pushConfigs = EMClient.getInstance().pushManager().getPushConfigsFromServer();
//获取推送显示昵称。
String nickname = pushConfigs.getDisplayNickname();
//获取推送通知的显示样式。
EMPushManager.DisplayStyle style = pushConfigs.getDisplayStyle();
=== 4.3 设置推送翻译 ===
如果用户启用 [[https://docs-im.easemob.com/ccim/android/translation#%E8%AE%BE%E7%BD%AE%E8%87%AA%E5%8A%A8%E7%BF%BB%E8%AF%91|自动翻译]] 功能并发送消息，SDK 会同时发送原始消息和翻译后的消息。
推送通知与翻译功能协同工作。作为接收方，你可以设置你在离线时希望接收的推送通知的首选语言。如果翻译消息的语言符合你的设置，则翻译消息显示在推送通知中；否则，将显示原始消息。
以下代码示例显示了如何设置和获取推送通知的首选语言：
//设置离线推送的首选语言。
EMClient.getInstance().pushManager().setPreferredNotificationLanguage("en", new EMCallBack(){});
//获取设置的离线推送的首选语言。
EMClient.getInstance().pushManager().getPreferredNotificationLanguage(new EMValueCallBack(){});
=== 4.4 设置推送模板 ===
环信 IM 支持自定义推送通知模板。使用前，你可参考以下步骤在环信即时通讯云管理后台上创建推送模板：
- 登录环信 IM Console，进入首页。
- 在 **应用列表** 区域中，点击对应 app 的 **操作** 一栏中的 **查看** 按钮。
- 在环信 IM 配置页面的左侧导航栏，选择 **即时通讯 > 功能配置 > 消息推送 > 模板管理**，进入推送模板管理页面。
{{:ccim:android:push_console_template_mgmt.png|}}
- 点击 **添加推送模板**。弹出以下页面，进行参数配置。
{{:ccim:android:push_android_ios_template_add.png|}}
在环信即时通讯云管理后台中完成模板创建后，用户可以在发送消息时选择此推送模板作为默认布局，如下代码示例所示：
//下面以文本消息为例，其他类型的消息设置方法相同。
EMMessage message = EMMessage.createSendMessage(EMMessage.Type.TXT);
EMTextMessageBody txtBody = new EMTextMessageBody("消息内容");
message.setTo("6006");
//设置推送模板。设置前需在环信即时通讯云管理后台上创建推送模板。
JSONObject pushObject = new JSONObject();
JSONArray titleArgs = new JSONArray();
JSONArray contentArgs = new JSONArray();
try {
//设置推送模板名称。
pushObject.put("name", "test7");
//设置填写模板标题的 value 数组。
titleArgs.put("value1");
//...
pushObject.put("title_args", titleArgs);
//设置填写模板内容的 value 数组。
contentArgs.put("value1");
//...
pushObject.put("content_args", contentArgs);
} catch (JSONException e) {
e.printStackTrace();
}
//将推送扩展设置到消息中。
message.setAttribute("em_push_template", pushObject);
//设置消息状态回调。
message.setMessageStatusCallback(new EMCallBack() {...});
//发送消息。
EMClient.getInstance().chatManager().sendMessage(message);
==== 5. 解析收到的推送字段 ====
=== 收到的推送字段解释 ===
^参数 ^描述 ^
|''%%t%%'' |接收者 ID。 |
|''%%f%%'' |发送者 ID。 |
|''%%m%%'' |消息 ID。 |
|''%%g%%'' |群组 ID，当消息是群组消息时，这个值会被赋值。 |
|''%%e%%'' |用户自定义扩展。 |
其中 ''%%e%%'' 为完全用户自定义扩展，而数据来源为 ''%%em_apns_ext%%'' 或者 ''%%em_apns_ext%%''.extern。
规则如下：
* 当 ''%%extern%%'' 不存在时，''%%e%%'' 内容为 ''%%em_apns_ext%%'' 下 push 服务未使用字段。具体为移除 ''%%em_push_title%%''，''%%em_push_content%%''，''%%em_push_name%%''，''%%em_push_channel_id%%''，''%%em_huawei_push_badge_class%%'' 字段后剩余所有。
* 当 ''%%extern%%'' 存在时，使用 ''%%extern%%'' 下字段。
=== 解析 FCM 推送字段 ===
重写 ''%%FirebaseMessagingService.onMessageReceived%%'' 方法可以在 ''%%RemoteMessage%%'' 对象中获取自定义扩展：
public class EMFCMMSGService extends FirebaseMessagingService {
@Override
public void onMessageReceived(RemoteMessage remoteMessage) {
super.onMessageReceived(remoteMessage);
if (remoteMessage.getData().size() > 0) {
String f = remoteMessage.getData().get("f");
String t = remoteMessage.getData().get("t");
String m = remoteMessage.getData().get("m");
String g = remoteMessage.getData().get("g");
Object e = remoteMessage.getData().get("e");
}
}
}
=== 解析华为推送字段 ===
华为推送字段默认在应用启动页的 ''%%onCreate%%'' 方法中可以获取到，如下：
public class SplashActivity extends BaseActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
Bundle extras = getIntent().getExtras();
if (extras != null) {
String t = extras.getString("t");
String f = extras.getString("f");
String m = extras.getString("m");
String g = extras.getString("g");
Object e = extras.get("e");
//handle
}
}
}
=== 解析小米推送字段 ===
重写 ''%%EMMiMsgReceiver.onNotificationMessageClicked%%'' 方法可以在 ''%%MiPushMessage%%'' 对象中获取自定义扩展：
public class MiMsgReceiver extends EMMiMsgReceiver {
@Override
public void onNotificationMessageClicked(Context context, MiPushMessage miPushMessage) {
String extStr = miPushMessage.getContent();
JSONObject extras = new JSONObject(extStr);
if (extras !=null ){
String t = extras.getString("t");
String f = extras.getString("f");
String m = extras.getString("m");
String g = extras.getString("g");
Object e = extras.get("e");
//handle
}
}
}
=== 解析 VIVO 推送字段 ===
重写 ''%%EMVivoMsgReceiver.onNotificationMessageClicked%%'' 方法可以在 ''%%UPSNotificationMessage%%'' 对象中获取自定义扩展：
public class MyVivoMsgReceiver extends EMVivoMsgReceiver {
@Override
public void onNotificationMessageClicked(Context context, UPSNotificationMessage upsNotificationMessage) {
Map map = upsNotificationMessage.getParams();
if(!map.isEmpty()) {
String t = map.get("t");
String f = map.get("f");
String m = map.get("m");
String g = map.get("g");
Object e = map.get("e");
}
}
}
=== 解析 OPPO 推送字段 ===
解析方式同华为
=== 解析魅族推送字段 ===
解析方式同华为
===== 更多功能 =====
==== 自定义字段 ====
向推送中添加你自己的业务字段以满足业务需求，比如通过这条推送跳转到某个活动页面（需要应用在前台时）。
// 下面以 TXT 消息为例，IMAGE FILE 等类型的消息设置方法相同。
EMMessage message = EMMessage.createSendMessage(EMMessage.Type.TXT);
EMTextMessageBody txtBody = new EMTextMessageBody("message content");
// 设置要发送的用户 ID。
message.setTo("toChatUsername");
// 设置自定义推送提示。
JSONObject extObject = new JSONObject();
try {
extObject.put("test1", "test 01");
} catch (JSONException e) {
e.printStackTrace();
}
// 将推送扩展设置到消息中。
message.setAttribute("em_apns_ext", extObject);
// 设置消息体。
message.addBody(txtBody);
// 设置消息回调。
message.setMessageStatusCallback(new CallBack() {...});
// 发送消息。
EMClient.getInstance().chatManager().sendMessage(message);
^参数 ^描述 ^
|''%%txtBody%%'' |消息体。 |
|''%%toChatUsername%%'' |消息接收方 ID。 |
|''%%em_apns_ext%%'' |消息扩展，使用扩展的方式向推送中添加自定义字段，该值为固定值，不可修改。 |
|''%%test1%%'' |自定义 key，用户自定义。 |
应用端解析自定义字段，参见 [[https://docs-im.easemob.com/ccim/android/push#解析收到的推送字段|解析收到的推送字段]]。
==== 自定义显示 ====
自定义显示内容时，你可以随意设置通知时显示的内容。
// 这里只是以 TXT 消息为例，IMAGE FILE 等类型的消息设置方法相同。
EMMessage message = EMMessage.createSendMessage(EMMessage.Type.TXT);
EMTextMessageBody txtBody = new EMTextMessageBody("message content");
// 设置要发送用户的用户 ID。
message.setTo("toChatUsername");
// 设置自定义推送提示。
JSONObject extObject = new JSONObject();
try {
extObject.put("em_push_title", "custom push title");
extObject.put("em_push_content", "custom push content");
} catch (JSONException e) {
e.printStackTrace();
}
// 将推送扩展设置到消息中。
message.setAttribute("em_apns_ext", extObject);
// 设置消息体。
message.addBody(txtBody);
// 设置消息回调。
message.setMessageStatusCallback(new CallBack() {...});
// 发送消息。
EMClient.getInstance().chatManager().sendMessage(message);
^参数 ^描述 ^
|''%%toChatUsername%%'' |消息接收方 ID。 |
|''%%em_apns_ext%%'' |消息扩展，使用扩展的方式向推送中添加自定义字段，该值为固定值，不可修改。 |
|''%%em_push_title%%'' |自定义字段 key，用于设置自定义的标题，该值为固定值，不可修改。 |
|''%%em_push_content%%'' |自定义字段 key，用于设置自定义的内容，该值为固定值，不可修改。 |
==== 强制推送 ====
使用该方式设置后，本条消息会忽略接收方的免打扰设置，不论是否处于免打扰时间段都会正常向对方推送通知；
// 下面以 TXT 消息为例，IMAGE FILE 等类型的消息设置方法相同。
EMMessage message = EMMessage.createSendMessage(EMMessage.Type.TXT);
EMTextMessageBody txtBody = new EMTextMessageBody("test");
// 设置要发送用户的用户 ID。
message.setTo("toChatUsername");
// 设置自定义扩展字段。
message.setAttribute("em_force_notification", true);
// 设置消息回调。
message.setMessageStatusCallback(new CallBack() {...});
// 发送消息。
EMClient.getInstance().chatManager().sendMessage(message);
^参数 ^描述 ^
|''%%txtBody%%'' |消息体。 |
|''%%toChatUsername%%'' |消息接收方用户 ID。 |
|''%%em_force_notification%%'' |标志是否为强制推送的关键字，不可修改。 |