setGroupAttributes
功能介绍
设置群属性
如果设置的群属性不存在,会自动添加该群属性。
目前只支持 AVChatRoom
key 最多支持16个,长度限制为32字节
value 长度限制为4k
总的 attributes(包括 key 和 value)限制为16k
initGroupAttributes、setGroupAttributes、deleteGroupAttributes 接口合并计算, SDK 限制为5秒10次,超过后回调8511错误码;后台限制1秒5次,超过后返回10049错误码
参数详解
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
groupID | string | 是 | 需要设置属性的群组id |
attributes | StringMap | 是 | 设置的属性 |
返回模板
V2TimCallback
{
code : number
desc : string
}
返回值详解
名称 | 数值类型 | 描述 |
---|---|---|
code | number | 请求结果错误码 |
desc | string | 请求结果描述符 |
代码示例
// 注意:需要先调用joinGroup进入直播群才能进行设置
import { TencentImSDKPlugin } from 'react-native-tim-js';
// 设置群属性
const setGroupAttributesRes = await TencentImSDKPlugin.v2TIMManager
.getGroupManager()
.setGroupAttributes(
'groupID', // 需要设置属性的群组id
{ custom: 'custom' } // 设置的属性
);
if (setGroupAttributesRes.code === 0) {
// 设置成功
}