按会话设置免打扰
设置会话的消息免打扰状态
方法
即时通讯业务用户为指定会话或超级群设置免打扰级别,支持单聊、群聊、超级群会话。
changeConversationNotificationLevel(type: RCIMIWConversationType, targetId: string, channelId: string, level: RCIMIWPushNotificationLevel): Promise<number>;
参数说明
参数 | 类型 | 说明 |
---|---|---|
conversationType | RCIMIWConversationType | 会话类型。请注意以下限制:
|
targetId | string | 会话 ID/超级群ID |
channelId | string | 超级群的会话频道 ID。
|
level | RCIMIWPushNotificationLevel | 免打扰级别,参考免打扰概述 |
返回值
返回值 | 描述 |
---|---|
Promise<number> | 当次接口操作状态码,并不代表最终操作结果,状态码详细信息 |
代码示例
engine.changeConversationNotificationLevel(
type,
targetId,
channelId,
level
)
.then((code: number) => {});
回调方法
- setOnConversationNotificationLevelChangedListener
setOnConversationNotificationLevelChangedListener(listener?: (code: number, type: RCIMIWConversationType, targetId: string, channelId: string, level: RCIMIWPushNotificationLevel) => void): void;
参数说明
参数 | 类型 | 说明 |
---|---|---|
code | number | 接口回调的状态码,0 代表成功,非 0 代表出现异常 |
type | RCIMIWConversationType | 调用接口时传入的会话类型 |
targetId | string | 调用接口时传入的会话ID |
channelId | string | 调用接口时传入的频道 ID |
level | RCIMIWPushNotificationLevel | 调用接口时传入的免打扰级别,参考免打扰概述 |
代码示例
engine.setOnConversationNotificationLevelChangedListener(
(
code: number,
type: RCIMIWConversationType,
targetId: string,
channelId: string,
level: RCIMIWPushNotificationLevel
) => {}
);
获取会话的免打扰状态
查询当前用户为指定会话设置的免打扰级别
方法
loadConversationNotificationLevel(type: RCIMIWConversationType, targetId: string, channelId: string): Promise<number>;
参数说明
参数 | 类型 | 说明 |
---|---|---|
conversationType | RCIMIWConversationType | 会话类型。请注意以下限制:
|
targetId | string | 会话 ID/超级群ID |
channelId | string | 超级群的会话频道 ID。
|