TIMMsgSetGroupReceiveMessageOpt
功能介绍
设置群消息的接收选项
完全不接收消息: 消息接收选项设置为 kTIMRecvMsgOpt_Not_Receive 后，单聊/群聊的任何消息都收不到，会话列表也不会更新。
接收消息但不提醒: 在会话列表界面显示小圆点（不显示未读数), 消息接收选项设置为 kTIMRecvMsgOpt_Not_Notify
当单聊/群聊收到新消息，会话列表需要更新时，可以通过会话 V2TIMConversation 中的 unreadCount 获取到消息未读数。
根据 V2TIMConversation 的 recvOpt 判断获取到的消息接收选项为 kTIMRecvMsgOpt_Not_Notify 时显示小红点而非消息未读数。
参数详解
| 参数名称 | 参数类型 | 是否必填 | 描述 |
|---|---|---|---|
| msgSetGroupReceiveMessageOptParams | MsgSetGroupReceiveMessageOptParams | 是 | 设置群消息的接收选项的参数 |
返回模板
Promise<commonResult<string>>
{
code: TIMResult | TIMErrCode;
desc?: string | undefined;
json_param?: string | undefined;
json_params?: string | undefined; // 兼容
user_data?: string | undefined;
}
返回值详解
| 名称 | 数值类型 | 描述 |
|---|---|---|
| code | TIMResult ｜ TIMErrCode | 返回状态码 |
| desc | string ｜ undefined | 返回描述 |
| json_param | string ｜ undefined | 根据具具体接口返回 |
| json_params | string ｜ undefined | 兼容的字段，某些情况下会返回这个，根据具体接口返回 |
| user_data | string ｜ undefined | ImSDK负责透传的用户自定义数据，未做任何处理 |
代码示例
import TimRender from "im_electron_sdk/dist/renderer";
const timRenderInstance = new TimRender();
import { MsgSetGroupReceiveMessageOptParams } from "im_electron_sdk/dist/interfaces";
let groupId = ''
let opt = 0
let param:MsgSetGroupReceiveMessageOptParams = {
group_id: '',
opt: opt,
user_data: ''
}
const {code} = await timRenderInstance.TIMMsgSetGroupReceiveMessageOpt(param);
if(code == 0){
// 成功
}