TIMGroupGetGroupAttributes

功能介绍

获取群指定属性

keys 传 null 则获取所有群属性。

目前只支持 AVChatRoom

key 最多支持16个,长度限制为32字节

value 长度限制为4k

总的 attributes(包括 key 和 value)限制为16k

initGroupAttributes、setGroupAttributes、deleteGroupAttributes 接口合并计算, SDK 限制为5秒10次,超过后回调8511错误码;后台限制1秒5次,超过后返回10049错误码

除了话题外,群属性支持所有的群类型

参数详解

参数名称 参数类型 是否必填 描述
params DeleteAttributeParams 获取群指定属性的参数

返回模板

Promise<commonResult<Array<GroupAttributes>>>

{
    code: TIMResult | TIMErrCode;
    desc?: string | undefined;
    json_param?: Array<GroupAttributes> | undefined;
    json_params?: Array<GroupAttributes> | undefined; // 兼容
    user_data?: string | undefined;
}

返回值详解

名称 数值类型 描述
code TIMResultTIMErrCode 返回状态码
desc string | undefined 返回描述
json_param Array< GroupAttributes > | undefined 根据具具体接口返回
json_params Array< GroupAttributes > | undefined 兼容的字段,某些情况下会返回这个,根据具体接口返回
user_data string | undefined ImSDK负责透传的用户自定义数据,未做任何处理

代码示例

import TimRender from "im_electron_sdk/dist/renderer";
const timRenderInstance = new TimRender();
import { DeleteAttributeParams } from "im_electron_sdk/dist/interfaces";

let grouId = ''
let attributesKey=''
let param : DeleteAttributeParams = {
    groupId:grouId, //必填
    attributesKey: [attributesKey], //必填
    data: ''//选填
}
const {code} =await timRenderInstance.TIMGroupGetGroupAttributes(param)
if(code ==0){
    // 成功
}

results matching ""

    No results matching ""