GroupGetGroupAttributes

功能介绍

获取群指定属性

基于群属性,我们可以做语聊房的麦位管理。当有人上麦的时候,可以设置一个群属性管理上麦人信息。当有人下麦的时候,可以删除对应群属性。其他成员可以通过获取群属性列表来展示麦位列表。

目前群属性功能仅支持直播群(AVChatRoom)。

如果 json_keys 字段填 null ,则会获取所有的群属性。

参数详解

重载1

参数名称 参数类型 是否必填 描述
group_id_list string 群ID列表
json_keys List< string > 属性key列表
callback ValueCallback< List< GroupAttributes > > 异步回调 返回值的json_param的格式为json

重载2

参数名称 参数类型 是否必填 描述
group_id_list string 群ID列表
json_keys List< string > 属性key列表
callback ValueCallback< string > 异步回调 返回值的json_param的格式为string

返回模板

TIMResult

调用成功后回调函数参数:
code:int
desc:string
json_param:
'[{
    "group_atrribute_key": "atrribute_key1",
    "group_atrribute_value": "atrribute_value1"
}]' // Json Key请参考[GroupAttributes]
user_data:string

返回值详解

名称 数值类型 描述
TIMResult TIMResult 调用接口的返回值
code int 值为ERR_SUCC表示成功,其他值表示失败。详情请参考 错误码
desc string 错误描述字符串
json_param string Json字符串,不同的接口,Json字符串不一样 Json Key请参考GroupAttributes
user_data string ImSDK负责透传的用户自定义数据,未做任何处理

results matching ""

    No results matching ""