MsgSetGroupReceiveMessageOpt
功能介绍
设置群收消息选项
查询群消息的接收选项:您可以在群资料GroupBaseInfo中获得这个信息
使用不同的 TIMReceiveMessageOpt 可以实现群消息免打扰:
完全不接收群内消息:
群消息接收选项设置为 kTIMRecvMsgOpt_Not_Receive 后,群内的任何消息都收不到,会话列表也不会更新。
接收群内消息但不提醒,在会话列表界面显示小圆点(不显示未读数):
群消息接收选项设置为 kTIMRecvMsgOpt_Not_Notify。
当群内收到新消息,会话列表需要更新时,可以通过会话 ConvInfo 中的 conv_unread_num 获取到消息未读数。
根据 ConvInfo 的 conv_recv_opt 判断获取到的群消息接收选项为 kTIMRecvMsgOpt_Not_Notify 时显示小红点而非消息未读数。
此方式需使用未读计数功能,因此仅适用于好友工作群(Work)和陌生人社交群(Public)。
参数详解
重载1
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
group_id | string | 是 | 群组ID |
opt | TIMReceiveMessageOpt | 是 | 接收消息选项 |
callback | NullValueCallback | 是 | 异步回调 |
重载2
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
group_id | string | 是 | 群组ID |
opt | TIMReceiveMessageOpt | 是 | 接收消息选项 |
callback | ValueCallback< string > | 是 | 异步回调 返回值的json_param的格式为string |
返回模板
TIMResult
调用成功后回调函数参数:
code:int
desc:string
json_param:'' // json_params为空字符串""
user_data:string
返回值详解
名称 | 数值类型 | 描述 |
---|---|---|
TIMResult | TIMResult | 调用接口的返回值 |
code | int | 值为ERR_SUCC表示成功,其他值表示失败。详情请参考 错误码 |
desc | string | 错误描述字符串 |
json_param | string | Json字符串,不同的接口,Json字符串不一样 |
user_data | string | ImSDK负责透传的用户自定义数据,未做任何处理 |