按会话设置免打扰

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

方法

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

changeConversationNotificationLevel(
  type: RCIMIWConversationType,
  targetId: string,
  channelId: string,
  level: RCIMIWPushNotificationLevel,
  callback: IRCIMIWChangeConversationNotificationLevelCallback
): Promise<number>;

参数说明

参数名	参数类型	描述
type	RCIMIWConversationType	会话类型。请注意以下限制： 超级群会话类型：如在 2022.09.01 之前开通超级群业务，默认不支持为单个超级群会话所有消息设置免打扰级别（“所有消息”指所有频道中的消息和不属于任何频道的消息）。该接口仅设置指定超级群会话（targetId）中不属于任何频道的消息的免打扰状态级别。如需修改请提交工单。 聊天室会话类型：不支持，因为聊天室消息默认不支持消息推送提醒。
targetId	string	会话 ID
channelId	string	超级群的会话频道 ID。其他类型传 null 即可。 如果传入频道 ID，则针对该指定频道设置消息免打扰级别。如果不指定频道 ID，则对所有超级群消息生效。 注意：2022.09.01 之前开通超级群业务的客户，如果不指定频道 ID，则默认传 "" 空字符串，即仅针对指定超级群会话（targetId）中不属于任何频道的消息设置免打扰状态级别。如需修改请提交工单。
level	RCIMIWPushNotificationLevel	消息通知级别
callback	IRCIMIWChangeConversationNotificationLevelCallback	事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

返回值

返回值	描述
Promise<number>	当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考状态码文档。
:------	:------
Promise<number>	当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考状态码文档。

代码示例

let callback = {
onConversationNotificationLevelChanged:(res) => {
//...
}};
let code = await engine.changeConversationNotificationLevel(type, targetId, channelId, level, callback);

回调方法

• setOnConversationNotificationLevelChangedListener

setOnConversationNotificationLevelChangedListener(listener?: ({code, type, targetId, channelId, level}) => void): void;

参数说明

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

代码示例

engine.setOnConversationNotificationLevelChangedListener((res) => {
    //...
});

获取会话的免打扰状态

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

方法

getConversationNotificationLevel(
  type: RCIMIWConversationType,
  targetId: string,
  channelId: string,
  callback: IRCIMIWGetConversationNotificationLevelCallback
): Promise<number>;

参数说明

参数名	参数类型	描述
type	RCIMIWConversationType	会话类型。请注意以下限制： 超级群会话类型：如在 2022.09.01 之前开通超级群业务，默认不支持为单个超级群会话所有消息设置免打扰级别（“所有消息”指所有频道中的消息和不属于任何频道的消息）。该接口仅设置指定超级群会话（targetId）中不属于任何频道的消息的免打扰状态级别。如需修改请提交工单。 聊天室会话类型：不支持，因为聊天室消息默认不支持消息推送提醒。
targetId	string	会话 ID
channelId	string	超级群的会话频道 ID。其他类型传 null 即可。 如果传入频道 ID，则针对该指定频道设置消息免打扰级别。如果不指定频道 ID，则对所有超级群消息生效。 注意：2022.09.01 之前开通超级群业务的客户，如果不指定频道 ID，则默认传 "" 空字符串，即仅针对指定超级群会话（targetId）中不属于任何频道的消息设置免打扰状态级别。如需修改请提交工单。
callback	IRCIMIWGetConversationNotificationLevelCallback	事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

返回值

返回值	描述
Promise<number>	当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考状态码文档。
:------	:------
Promise<number>	当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考状态码文档。

代码示例

let callback = {
onSuccess:(res) => {
//...
},
onError:(res) => {
//...
}};
let code = await engine.getConversationNotificationLevel(type, targetId, channelId, callback);

回调方法

• setOnConversationNotificationLevelLoadedListener

setOnConversationNotificationLevelLoadedListener(listener?: ({code, type, targetId, channelId, level}) => void): void;

参数说明

参数名	参数类型	描述
code	number	接口回调的状态码，0 代表成功，非 0 代表出现异常
type	RCIMIWConversationType	会话类型
targetId	string	会话 ID
channelId	string	频道 ID，仅支持超级群使用，其他会话类型传 null 即可。
level	RCIMIWPushNotificationLevel	当前会话的消息通知级别

代码示例

engine.setOnConversationNotificationLevelLoadedListener((res) => {
    //...
});

获取免打扰状态列表

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

方法

getBlockedConversations(
  conversationTypes: Array<RCIMIWConversationType>,
  channelId: string,
  callback: IRCIMIWGetBlockedConversationsCallback
): Promise<number>;

参数说明

getBlockedConversations(
  conversationTypes: Array<RCIMIWConversationType>,
  channelId: string,
  callback: IRCIMIWGetBlockedConversationsCallback
): Promise<number>;

返回值

返回值	描述
Promise<number>	当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考状态码文档。

代码示例

let callback = {
onSuccess:(res) => {
//...
},
onError:(res) => {
//...
}};
let code = await engine.getBlockedConversations(conversationTypes, channelId, callback);

回调方法

• setOnBlockedConversationsLoadedListener

setOnBlockedConversationsLoadedListener(listener?: ({code, conversationTypes, channelId, conversations}) => void): void;

参数说明

参数名	参数类型	描述
code	number	接口回调的状态码，0 代表成功，非 0 代表出现异常
conversationTypes	Array<RCIMIWConversationType>	会话类型集合
channelId	string	频道 ID，仅支持超级群使用，其他会话类型传 null 即可。
conversations	Array<RCIMIWConversation>	获取到的会话集合

代码示例

engine.setOnBlockedConversationsLoadedListener((res) => {
    //...
});