设置推送通知方式和免打扰模式

大约 9 分钟

设置推送通知方式和免打扰模式

为优化用户在处理大量推送通知时的体验，SDK 在全局和会话层面提供了推送通知方式和免打扰模式的细粒度配置功能。你可以基于推送通知方式、指定免打扰时长或每日时间段，对离线推送进行统一控制。

开通功能

推送通知方式和免打扰模式是推送的高级功能。使用前，你需要在环信控制台open in new window 免费开通。激活后，如需关闭推送高级功能，必须联系商务，因为该操作会删除高级功能相关的所有配置。

登录环信控制台open in new window。
选择页面上方的 应用管理。在弹出的应用列表页面，单击你的测试版或正式版应用的 App Key。
选择 增值服务 > 消息推送 > 离线推送。
点击 免费开通。

推送通知方式

推送通知方式 pushRemindType 包含三种类型，如下表所示。该设置适用于 App 全局以及单聊和群聊具体会话。会话级别的推送通知方式设置优先于全局级别设置，未设置推送通知方式的会话默认继承全局设置。

例如，假设全局推送方式设置为 MENTION_ONLY，而指定会话的推送方式设置为 ALL。你会收到来自该会话的所有推送通知，而对于其他会话来说，你只会收到提及你的消息的推送通知。

推送通知方式	描述
`ALL`	接收所有离线消息的推送通知。
`MENTION_ONLY`	仅接收提及当前用户的消息推送通知。该参数通常更适合群聊场景。若消息需要提及一个或多个用户，可在发消息时通过消息扩展字段 ext 字段传 "em_at_list":["user1", "user2" ...]；若提及所有人，对该字段传 "em_at_list":"all"。
`NONE`	不接收离线消息的推送通知。

获取所有会话的推送通知方式设置

你可以调用 EMPushManager#syncSilentModeConversationsFromServer 方法从服务器同步所有会话的推送通知方式设置。同步后成功后的结果会存储到本地数据库，然后你可以通过 EMConversation#pushRemindType 查询当前会话的推送通知方式。

//同步会话的推送通知方式
EMClient.getInstance().pushManager().syncSilentModeConversationsFromServer(new EMCallBack() {
    @Override
    public void onSuccess() {
        EMLog.i(TAG, "syncNoDisturb onSuccess");
    }

    @Override
    public void onError(int code, String error) {
        EMLog.i(TAG, "syncNoDisturb onError code:" + code + " error:" + error);
    }
});

//查询会话的推送通知方式
String conversationId = "pu";
EMConversation conversation = EMClient.getInstance().chatManager().getConversation(conversationId);
if(conversation!=null) {
    EMPushManager.EMPushRemindType emPushRemindType = conversation.pushRemindType();
    EMLog.i(TAG, "conversationRemindType emPushRemindType:" + emPushRemindType);
}

设置指定会话的推送通知方式

在本机上调用 EMPushManager#setSilentModeForConversation 设置会话的推送通知方式，在多设备事件 EMMultiDeviceListener#onConversationEvent 里会回调当前操作，此时参数 event 的值为 EMMultiDeviceListener#CONVERSATION_MUTE_INFO_CHANGED。

//对会话设置推送通知方式
String conversationId = "pu";
EMSilentModeParam emSilentModeParam = new EMSilentModeParam(EMSilentModeParam.EMSilentModeParamType.REMIND_TYPE);
emSilentModeParam.setRemindType(EMPushManager.EMPushRemindType.NONE);
EMClient.getInstance().pushManager().setSilentModeForConversation(conversationId, EMConversation.EMConversationType.Chat, emSilentModeParam, new EMValueCallBack<EMSilentModeResult>() {
    @Override
    public void onSuccess(EMSilentModeResult value) {
        EMLog.i(TAG, "conversationRemindType onSuccess value:" + value);
    }

    @Override
    public void onError(int error, String errorMsg) {
        EMLog.i(TAG, "conversationRemindType onError error:" + error + " errorMsg:" + errorMsg);
    }
});


//多设备事件
EMClient.getInstance().addMultiDeviceListener(new EMMultiDeviceListener() {
    ……

    @Override
    public void onConversationEvent(int event, String conversationId, EMConversation.EMConversationType type) {
        EMLog.i(TAG, "onConversationEvent event:" + event + " conversationId:" + conversationId + " type:" + type);
    }
});

清除指定会话的推送通知方式设置

你可以调用 clearRemindTypeForConversation 方法清除指定会话的推送通知方式的设置。清除后，默认情况下，此会话会继承 app 的设置。

EMClient.getInstance().pushManager().clearRemindTypeForConversation(conversationId, conversationType, new EMCallBack(){});

免打扰模式

完成 SDK 初始化并成功登录后，你可以为 App 全局或指定单聊、群聊会话设置免打扰模式。免打扰模式生效期间，环信 IM 不会向对应范围内的离线用户发送推送通知。

Android SDK 通过 EMSilentModeParam 配置免打扰规则，支持以下两种模式：

SILENT_MODE_DURATION（一次性免打扰）：设置后立即生效，到期后自动恢复，适用于临时不希望被打扰的场景。
SILENT_MODE_INTERVAL（每日循环免打扰）：设置一个每日循环生效的时间段，例如从 23:00 到次日 07:00，适用于固定的休息时间。

免打扰时间参数的说明如下表所示：

规则模式	配置方法	类型	描述	生效范围
`SILENT_MODE_INTERVAL`	`setSilentModeInterval(startTime, endTime)`	`EMSilentModeTime`	每日循环生效的免打扰时段，采用 24 小时制，精确到分钟。`startTime` 和 `endTime` 的小时取值范围为 `0`–`23`，分钟取值范围为 `0`–`59`。 - 每日定时触发：设置后，每天在指定时段自动进入免打扰模式。 - 跨天支持：若结束时间早于开始时间，则时段跨天生效。例如，设置为 `10:00`–`08:00`，表示当日 `10:00` 至次日 `08:00` 免打扰。 - 全天与关闭：开始和结束时间相同时，视为全天免打扰；设置为 `00:00`–`00:00` 时，关闭免打扰模式。 - 单时段限制：每天仅支持设置一个免打扰时段；新配置会覆盖旧配置。 - 生效时机：设置后立即生效。例如，当日 `11:00` 设置 `08:00`–`12:00`，则当天从 `11:00` 起生效至 `12:00`，此后每天按 `08:00`–`12:00` 执行。	仅 App 全局。
`SILENT_MODE_DURATION`	`setSilentModeDuration(duration)`	`Int`	一次性生效的免打扰持续时长，单位为分钟，取值范围为 `0`–`10080`（0 至 7 天）。其中，`0` 表示该参数无效。 - 一次有效：该模式设置后立即开始计时，不会按天重复触发。 - 生效示例：上午 `08:00` 设置 `duration = 240`，则当天 `08:00`–`12:00` 处于免打扰模式。	App 全局或指定单聊、群聊会话。

SILENT_MODE_INTERVAL 和 SILENT_MODE_DURATION 同时设置时的叠加规则

当天两者 叠加生效，重叠时段不重复计时。
自次日起，只有每日循环免打扰时段继续生效；一次性免打扰时长不会重复触发。

示例：上午 08:00 设置每日免打扰时段为 08:00–10:00，同时设置 duration = 240（4 小时）：

当日：08:00–12:00 免打扰。
次日起：每天 08:00–10:00 免打扰。

推送通知方式与免打扰模式的关系

免打扰模式的优先级高于推送通知方式。例如，某个会话的推送通知方式设置为 ALL，但该会话当前命中免打扰时长，或 App 全局当前命中免打扰时段，则免打扰生效期间不会收到该会话的离线推送通知。

如果仅为某个会话设置一次性免打扰，而 App 全局未设置免打扰，则只有该会话在免打扰生效期间不发送离线推送通知；其他会话仍按照各自的推送通知方式或继承的全局设置发送推送通知。

提示

若需在免打扰生效期间仍向指定用户发送离线推送通知，可设置强制推送。

设置全局推送接收规则

你可以调用 setSilentModeForAll 方法设置 app 级别的推送通知，并通过指定 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)
                                .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<EMSilentModeResult>(){});

获取全局推送接收规则

你可以调用 getSilentModeForAll 方法获取 app 级别的推送通知设置，如以下代码示例所示：

EMClient.getInstance().pushManager().getSilentModeForAll(new EMValueCallBack<EMSilentModeResult>(){
    @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) {}
});

设置指定会话的推送接收规则

你可以调用 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)
                                .setSilentModeDuration(15);
// 设置会话的离线推送免打扰模式。目前暂不支持设置会话免打扰时间段。
EMClient.getInstance().pushManager().setSilentModeForConversation(conversationId, conversationType, param, new EMValueCallBack<EMSilentModeResult>(){});

获取指定会话的推送接收规则

你可以调用 getSilentModeForConversation 方法获取指定会话的推送通知设置，如以下代码示例所示：

EMClient.getInstance().pushManager().getSilentModeForConversation(conversationId, conversationType, new EMValueCallBack<EMSilentModeResult>(){
    @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) {}
});

批量获取会话的推送接收规则

你可以在每次调用中最多获取 20 个会话的设置。
如果会话继承了 app 设置或其推送通知设置已过期，则返回的字典不包含此会话。

你可以调用 getSilentModeForConversations 方法获取多个会话的推送通知设置，如以下代码示例所示：

EMClient.getInstance().pushManager().getSilentModeForConversations(conversationList, new EMValueCallBack<Map<String, EMSilentModeResult>>(){
    @Override
    public void onSuccess(Map<String, EMSilentModeResult> value) {}

    @Override
    public void onError(int error, String errorMsg) {}
});

接口列表

API 名称	所属模块/类	说明
`syncSilentModeConversationsFromServer`	`EMPushManager`	异步同步服务端保存的会话推送通知方式。
`setSilentModeForConversation`	`EMPushManager`	设置指定会话的推送通知方式。
`getSilentModeForConversation`	`EMPushManager`	获取指定会话的推送接收规则。
`setSilentModeForAll`	`EMPushManager`	设置全局推送接收规则。
`getSilentModeForAll`	`EMPushManager`	获取全局推送接收规则。
`getSilentModeForConversations`	`EMPushManager`	批量获取会话的推送接收规则。
`clearRemindTypeForConversation`	`EMPushManager`	清除指定会话的推送通知方式设置。

设置推送通知方式和免打扰模式

# 设置推送通知方式和免打扰模式

# 开通功能

# 推送通知方式

# 获取所有会话的推送通知方式设置

# 设置指定会话的推送通知方式

# 清除指定会话的推送通知方式设置

# 免打扰模式

# 设置全局推送接收规则

# 获取全局推送接收规则

# 设置指定会话的推送接收规则

# 获取指定会话的推送接收规则

# 批量获取会话的推送接收规则

# 接口列表

设置推送通知方式和免打扰模式

开通功能

推送通知方式

获取所有会话的推送通知方式设置

设置指定会话的推送通知方式

清除指定会话的推送通知方式设置

免打扰模式

设置全局推送接收规则

获取全局推送接收规则

设置指定会话的推送接收规则

获取指定会话的推送接收规则

批量获取会话的推送接收规则

接口列表