GroupGetGroupAttributes
introduction
Get group attributes
Only works with AVChatRoom temporarily.
If json_keys is NULL, you will get all group attributes.
Parameter details
overload1
| Parameter name | Parameter type | Required | Description |
|---|---|---|---|
| group_id_list | string | Required | Group ID |
| json_keys | List< string > | Required | Key list |
| callback | ValueCallback< List< GroupAttributes > > | Required | Asynchronous callback The format of json_param in the return value is json |
overload2
| Parameter name | Parameter type | Required | Description |
|---|---|---|---|
| group_id_list | string | Required | Group ID |
| json_keys | List< string > | Required | Key list |
| callback | ValueCallback< string > | Required | Asynchronous callback The format of json_param in the return value is string |
Returned template
TIMResult
The parameters of the callback function after successfully calling the API：
code:int
desc:string
json_param:
'[{
"group_atrribute_key": "atrribute_key1",
"group_atrribute_value": "atrribute_value1"
}]' // For the meaning of Json Key, please refer to [GroupAttributes]
user_data:string
Return value details
| name | type | description |
|---|---|---|
| TIMResult | TIMResult | Return value of calling API |
| code | int | Result error code: Error Codes |
| desc | string | The description of the error. |
| json_param | string | Json string. Calling different API will get different Json strings. For the meaning of Json Key, please refer to GroupAttributes |
| user_data | string | User-defined data transfered by ImSDK without any processing |