setC2CReceiveMessageOpt
功能介绍
设置用户消息接收选项
您可以通过参数 userIDList 设置一批用户，但一次最大允许设置 30 个用户
该接口调用频率被限制为 1 秒内最多调用 5 次。
完全不接收消息: 消息接收选项设置为 V2TIM_NOT_RECEIVE_MESSAGE 后，单聊/群聊的任何消息都收不到，会话列表也不会更新。
接收消息但不提醒: 在会话列表界面显示小圆点（不显示未读数), 消息接收选项设置为 V2TIM_RECEIVE_NOT_NOTIFY_MESSAGE。
当单聊/群聊收到新消息，会话列表需要更新时，可以通过会话 V2TIMConversation 中的 unreadCount 获取到消息未读数。
根据 V2TIMConversation 的 recvOpt 判断获取到的消息接收选项为 V2TIM_RECEIVE_NOT_NOTIFY_MESSAGE 时显示小红点而非消息未读数。
参数详解
| 参数名称 | 参数类型 | 是否必填 | 平台 | 描述 |
|---|---|---|---|---|
| userIDList | List< String > | 是 | 全部 | 需要设置的用户id列表 |
| opt | ReceiveMsgOptEnum | 是 | 全部 | 用户消息接收选项属性 |
返回模板
V2TimCallback
{
code : int
desc : String
}
返回值详解
| 名称 | 数值类型 | 描述 |
|---|---|---|
| code | int | 请求结果错误码 |
| desc | String | 请求结果描述 |
代码示例
//设置用户消息接收选项
// 设置在线和离线都不接收消息
V2TimCallback setC2CReceiveMessageOptRes = await TencentImSDKPlugin
.v2TIMManager
.getMessageManager()
.setC2CReceiveMessageOpt(
userIDList: ['user1', 'user2'], // 需要设置的用户id列表
opt: ReceiveMsgOptEnum.V2TIM_NOT_RECEIVE_MESSAGE); // 用户消息接收选项属性
if (setC2CReceiveMessageOptRes.code == 0) {
//设置成功
}