TIMGroupInitGroupAttributes
功能介绍
初始化群属性
调用此api会清空原有的群属性列表
除话题外，群属性支持所有的群类型
key 最多支持16个，长度限制为32字节
value 长度限制为4k
总的 attributes（包括 key 和 value）限制为16k
initGroupAttributes、setGroupAttributes、deleteGroupAttributes 接口合并计算， SDK 限制为5秒10次，超过后回调8511错误码；后台限制1秒5次，超过后返回10049错误码
除话题外，群属性支持所有的群类型
getGroupAttributes 接口SDK限制 5 秒 20 次
当每次APP启动后初次修改群属性时，请您先调用 getGroupAttributes 拉取到最新的群属性之后，再发起修改操作；
当多个用户同时修改同一个群属性时，只有第一个用户可以执行成功，其它用户会收到 10056 错误码；收到这个错误码之后，请您调用 getGroupAttributes 把本地保存的群属性更新到最新之后，再发起修改操作。
参数详解
| 参数名称 | 参数类型 | 是否必填 | 描述 |
|---|---|---|---|
| initAttributesParams | InitGroupAttributeParams | 是 | 初始化群属性的参数 |
返回模板
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 { InitGroupAttributeParams,GroupAttributes } from "im_electron_sdk/dist/interfaces";
let groupId = ''
let attributes:GroupAttributes = {
group_attribute_key:'', //必填
group_attribute_value:'', //必填
}
let param : InitGroupAttributeParams = {
groupId:groupId, //必填
attributes: [attributes], //必填
data: '' //选填
}
const {code} =await timRenderInstance.TIMGroupInitGroupAttributes(param)
if(code == 0){
//成功
}