跳到主要内容

按会话设置免打扰

设置会话的消息免打扰状态

方法

即时通讯业务用户为指定会话或超级群设置免打扰级别,支持单聊、群聊、超级群会话。

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

参数说明

参数类型说明
typeRCIMConversationType会话类型。请注意以下限制:
  • 超级群会话类型:暂不支持针对单个超级群会话所有消息设置免打扰级别(“所有消息”指所有频道中的消息和不属于任何频道的消息)。该接口仅设置指定超级群会话(targetId)中不属于任何频道的消息的免打扰状态级别。
  • 聊天室会话类型:不支持,因为聊天室消息默认不支持消息推送提醒。
targetIdstring会话 ID/超级群ID
channelIdstring超级群的会话频道 ID。
  • 如果传入频道 ID,则针对该指定频道设置消息免打扰级别。
  • 注意:如果不指定频道 ID,则默认传 "" 空字符串,即仅针对指定超级群会话(targetId)中不属于任何频道的消息设置免打扰状态级别。
levelRCIMPushNotificationLevel免打扰级别,参考免打扰概述

返回值

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

代码示例

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

回调方法

  • onConversationNotificationLevelChanged
delegate void OnConversationNotificationLevelChangedDelegate(
int code, RCIMConversationType type,
string targetId, string channelId,
RCIMPushNotificationLevel level);

OnConversationNotificationLevelChangedDelegate onConversationNotificationLevelChanged;

参数说明

参数类型说明
codeint接口回调的状态码,0 代表成功,非 0 代表出现异常
typeRCIMConversationType调用接口时传入的会话类型
targetIdstring调用接口时传入的会话ID
channelIdstring调用接口时传入的频道 ID
levelRCIMPushNotificationLevel调用接口时传入的免打扰级别,参考免打扰概述

代码示例

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

}

获取会话的免打扰状态

查询当前用户为指定会话设置的免打扰级别

方法

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

参数说明

参数类型说明
typeRCIMConversationType会话类型。请注意以下限制:
  • 超级群会话类型:暂不支持针对单个超级群会话所有消息设置免打扰级别(“所有消息”指所有频道中的消息和不属于任何频道的消息)。该接口仅设置指定超级群会话(targetId)中不属于任何频道的消息的免打扰状态级别。
  • 聊天室会话类型:不支持,因为聊天室消息默认不支持消息推送提醒。
targetIdstring会话 ID/超级群ID
channelIdstring超级群的会话频道 ID。
  • 如果传入频道 ID,则针对该指定频道设置消息免打扰级别。
  • 注意:如果不指定频道 ID,则默认传 "" 空字符串,即仅针对指定超级群会话(targetId)中不属于任何频道的消息设置免打扰状态级别。

返回值

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

代码示例

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

回调方法

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

OnConversationNotificationLevelLoadedDelegate onConversationNotificationLevelLoaded;

参数说明

参数类型说明
codeint接口回调的状态码,0 代表成功,非 0 代表出现异常
typeRCIMConversationType调用接口时传入的会话类型
targetIdstring调用接口时传入的会话ID
channelIdstring调用接口时传入的频道 ID
levelRCIMPushNotificationLevel调用接口时传入的免打扰级别,参考免打扰概述

代码示例

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

}

获取免打扰状态列表

获取所有设置了消息免打扰的会话列表。

方法

int loadBlockedConversations(
List<RCIMConversationType> types,
string channelId
)

参数说明

参数类型说明
typesList<RCIMConversationType>会话类型数组, 可设置多个会话类型(不支持聊天室)。
channelIdstring频道 ID,仅支持超级群使用,其他会话类型传 null 即可

返回值

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

代码示例

int code = engine.loadBlockedConversations(
conversationTypesInt,
channelId
);

回调方法

  • onBlockedConversationsLoaded
delegate void OnBlockedConversationsLoadedDelegate(
int code,
List<RCIMConversationType> types,
string channelId,
List<RCIMConversation> conversations);

OnBlockedConversationsLoadedDelegate onBlockedConversationsLoaded;

参数说明

参数类型说明
codeint接口回调的状态码,0 代表成功,非 0 代表出现异常
typesList<[RCIMConversationType](https://www.rongcloud.cn/docs/api/unity/imlib_v5/latest/namespacecn__rongcloud__im__unity.html#a9d16c8fef2db0c4a5d6cfea2e5873aea)>会话类型
channelIdstring调用接口时传入的频道 ID
conversationsList<[RCIMConversation](https://www.rongcloud.cn/docs/api/unity/imlib_v5/latest/classcn__rongcloud__im__unity_1_1_r_c_i_m_conversation.html)>免打扰的会话列表

代码示例

engine.onBlockedConversationsLoaded = delegate(
int code,
List<RCIMConversationType> types,
string channelId,
List<RCIMConversation> conversations
)
{

}