setGroupReceiveMessageOpt
功能介绍
设置群组消息接收选项
完全不接收消息
消息接收选项设置为 V2TIM_NOT_RECEIVE_MESSAGE 后,单聊/群聊的任何消息都收不到,会话列表也不会更新。
接收消息但不提醒,在会话列表界面显示小圆点(不显示未读数)
消息接收选项设置为 V2TIM_RECEIVE_NOT_NOTIFY_MESSAGE。
当单聊/群聊收到新消息,会话列表需要更新时,可以通过会话 V2TIMConversation 中的 unreadCount 获取到消息未读数。
根据 V2TIMConversation 的 recvOpt 判断获取到的消息接收选项为 V2TIM_RECEIVE_NOT_NOTIFY_MESSAGE 时显示小红点而非消息未读数。
参数详解
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
groupID | string | 是 | 需要设置的群组id |
opt | ReceiveMsgOptEnum | 是 | 群组消息接收选项属性 |
返回模板
V2TimCallback
{
code : number
desc : string
}
返回值详解
名称 | 数值类型 | 描述 |
---|---|---|
code | number | 请求结果错误码 |
desc | string | 请求结果描述 |
代码示例
//设置群组消息接收选项
import { TencentImSDKPlugin, ReceiveMsgOptEnum } from 'react-native-tim-js';
// 设置在线和离线都不接收消息
const setGroupReceiveMessageOptRes = await TencentImSDKPlugin.v2TIMManager
.getMessageManager()
.setGroupReceiveMessageOpt(
'groupID', // 需要设置的群组id
ReceiveMsgOptEnum.V2TIM_NOT_RECEIVE_MESSAGE
); // 用户消息接收选项属性
if (setGroupReceiveMessageOptRes.code === 0) {
//设置成功
}