按频道设置免打扰

本文描述如何为超级群业务设置免打扰级别。

提示

即时通讯客户端 SDK 支持多维度、多级别的免打扰设置。

• App 开发者可实现从 App Key、指定细分业务（仅超级群）、用户级别多个维度的免打扰功能配置。在融云服务端决定是否触发推送通知时，不同维度的优先级如下：用户级别设置 > 指定超级群频道的默认配置（仅超级群支持） > 指定超级群会话的默认配置（仅超级群支持） > App Key 级设置。
• 用户级别设置下包含多个细分维度。在融云服务端决定是否触发推送通知时，如存在用户级别配置，不同细分维度的优先级如下：全局免打扰 > 按频道设置的免打扰 > 按会话设置的免打扰 > 按会话类型设置的免打扰。

在免打扰设置生效时，客户端收到新消息时行为如下：

• 客户端在后台运行：会话中有新消息时，将不会进行通知提醒，但可以收到消息内容。
• 客户端为离线状态：会话中有新消息时，不会收到远程通知提醒，再次上线时可收取消息内容。

支持的免打扰级别

免打扰级别提供了针对不同 @ 消息的免打扰控制。指定频道的免打扰配置支持以下级别：

枚举值	说明
ALL_MESSAGE	所有消息均可进行通知。
NONE	未设置。未设置时均为此初始状态。 注意：在此状态下，如果超级群与群频道均为未设置，则认为超级群与频道的默认免打扰级别为全部消息都通知。
MENTION	仅针对 @ 消息进行通知，包括 @指定用户 和 @所有人
MENTION_USERS	仅针对 @ 指定用户消息进行通知，且仅针对被 @ 的指定的用户进行通知。 如：@张三，则张三可以收到推送； @所有人不会触发推送通知。
MENTION_ALL	仅针对 @群全员进行通知，即只接收 @所有人的推送信息。
BLOCKED	不接收通知，即使为 @ 消息也不推送通知。

管理超级群的免打扰设置

SDK 不提供一次性设置所有超级群频道免打扰的方法，需要开发者根据所有频道来遍历调用 [设置指定频道免打扰级别] 的方法，达到整个超级群免打扰的效果。

管理频道的免打扰设置

超级群（UltraGroup）支持在超级群的会话下创建独立的频道（channel），对消息数据（会话、消息、未读数）和群组成员分频道进行聚合。SDK 支持在超级群业务中的用户（userId）设置指定群频道（channelId）的免打扰级别。

设置指定频道免打扰级别

为当前用户设置超级群频道中的消息的免打扰级别。

方法

int changeConversationNotificationLevel(
  RCIMConversationType type,
  string targetId,
  string channelId,
  RCIMPushNotificationLevel level
)

参数说明

参数名	类型	描述
type	RCIMConversationType	会话类型
targetId	string	会话 ID
channelId	string	所属会话的业务标识，长度限制 20 字符
level	RCIMPushNotificationLevel	通知级别

返回值

返回值	描述
int	当次接口操作状态码，并不代表最终操作结果，状态码详细信息

代码示例

int code = engine.changeConversationNotificationLevel(
  type,
  targetId,
  channelId,
  level,
);

回调方法

• onUltraGroupUnreadMentionedCountLoaded

delegate void OnUltraGroupUnreadMentionedCountLoadedDelegate(int code,
  string targetId,
  int count);

OnUltraGroupUnreadMentionedCountLoadedDelegate onUltraGroupUnreadMentionedCountLoaded;

参数说明

参数	类型	说明
code	int	接口回调的状态码，0 代表成功，非 0 代表出现异常
targetId	string	超级群ID
count	int	未读数

代码示例

engine.onUltraGroupUnreadMentionedCountLoaded = delegate(
  int code,
  string targetId,
  int count
)
{

}

获取指定频道免打扰级别

获取为当前用户设置的超级群频道免打扰级别。

方法

int loadConversationNotificationLevel(
  RCIMConversationType type,
  string targetId,
  string channelId);

参数说明

参数	类型	说明
type	RCIMConversationType	会话类型
targetId	string	会话 ID
channelId	string	频道 ID，仅支持超级群使用，其他会话类型传 null 即可

返回值

返回值	描述
int	当次接口操作状态码，并不代表最终操作结果，状态码详细信息

代码示例

int code = engine.loadConversationNotificationLevel(
  type,
  targetId,
  channelId
);

回调方法

• onConversationNotificationLevelLoaded

delegate void OnConversationNotificationLevelLoadedDelegate(int code,
  RCIMConversationType type,
  string targetId,
  string channelId,
  RCIMPushNotificationLevel level);

OnConversationNotificationLevelLoadedDelegate onConversationNotificationLevelLoaded;

参数说明

参数	类型	说明
code	int	接口回调的状态码，0 代表成功，非 0 代表出现异常
type	RCIMConversationType	会话类型
targetId	string	会话 ID
channelId	string	频道 ID，仅支持超级群使用，其他会话类型传 null 即可
level	RCIMPushNotificationLevel	消息通知级别

代码示例

engine.onConversationNotificationLevelLoaded = delegate(
  int code,
  RCIMConversationType type,
  string targetId,
  string channelId,
  RCIMPushNotificationLevel level
)
{

}