按会话设置免打扰
设置会话的消息免打扰状态
方法
即时通讯业务用户为指定会话或超级群设置免打扰级别,支持单聊、群聊、超级群会话。
changeConversationNotificationLevel(
type: RCIMIWConversationType,
targetId: string,
channelId: string,
level: RCIMIWPushNotificationLevel,
callback: IRCIMIWChangeConversationNotificationLevelCallback
): Promise<number>;
参数说明
参数名 | 参数类型 | 描述 |
---|---|---|
type | RCIMIWConversationType | 会话类型。请注意以下限制:
|
targetId | string | 会话 ID |
channelId | string | 超级群的会话频道 ID。其他类型传 null 即可。
|
level | RCIMIWPushNotificationLevel | 消息通知级别 |
callback | IRCIMIWChangeConversationNotificationLevelCallback | 接口调用结果回调。 |
返回值
返回值 | 描述 |
---|---|
number | 当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码 |
:------ | :------ |
number | 当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码 |
代码示例
const callback = {
onConversationNotificationLevelChanged: (code: number) => {
//...
},
};
let code = await engine.changeConversationNotificationLevel(type, targetId, channelId, level, callback);
获取会话的免打扰状态
查询当前用户为指定会话设置的免打扰级别
方法
getConversationNotificationLevel(
type: RCIMIWConversationType,
targetId: string,
channelId: string,
callback: IRCIMIWGetConversationNotificationLevelCallback
): Promise<number>;
参数说明
参数名 | 参数类型 | 描述 |
---|---|---|
type | RCIMIWConversationType | 会话类型。请注意以下限制:
|
targetId | string | 会话 ID |
channelId | string | 超级群的会话频道 ID。其他类型传 null 即可。
|
callback | IRCIMIWGetConversationNotificationLevelCallback | 接口调用结果回调。 |
返回值
返回值 | 描述 |
---|---|
number | 当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码 |
:------ | :------ |
number | 当次接口操作的状态码。0 代表调用成功 具体结果需要实现 接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码 |
代码示例
const callback = {
onSuccess: (t: RCIMIWPushNotificationLevel) => {
//...
},
onError: (code: number) => {
//...
},
};
let code = await engine.getConversationNotificationLevel(type, targetId, channelId, callback);
获取免打扰状态列表
获取所有设置了消息免打扰的会话列表。
方法
getBlockedConversations(
conversationTypes: Array<RCIMIWConversationType>,
channelId: string,
callback: IRCIMIWGetBlockedConversationsCallback
): Promise<number>;
参数说明
getBlockedConversations(
conversationTypes: Array<RCIMIWConversationType>,
channelId: string,
callback: IRCIMIWGetBlockedConversationsCallback
): Promise<number>;
返回值
返回值 | 描述 |
---|---|
number | 当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码 |
代码示例
const callback = {
onSuccess: (t: Array<RCIMIWConversation>) => {
//...
},
onError: (code: number) => {
//...
},
};
let code = await engine.getBlockedConversations(conversationTypes, channelId, callback);