TIMGroupGetJoinedCommunityList
Introduction
get joined community list
Parameter details
Parameter name | Parameter type | Required | Description |
---|---|---|---|
get community list param | GetCommunityListParam | yes | Param of getting community list |
Returned template
Promise<commonResult<Array<GroupBaseInfo>>>
{
code: TIMResult | TIMErrCode;
desc?: string | undefined;
json_param?: Array<GroupBaseInfo> | undefined;
json_params?: Array<GroupBaseInfo> | undefined;
user_data?: string | undefined;
}
Return value details
name | type | description |
---|---|---|
code | TIMResult | TIMErrCode | Request result: Error codes. 0 means success. |
desc | string | undefined | The description of the error. It will be empty if success. |
json_param | Array< GroupBaseInfo > | undefined | Return value of calling API |
json_params | Array< GroupBaseInfo > | undefined | Return value of calling API. Compatible field, which is returned in some cases. |
user_data | string | undefined | ImSDK is responsible for transporting user-defined data without any processing |
Code example
import TimRender from "im_electron_sdk/dist/renderer";
const timRenderInstance = new TimRender();
import { GetCommunityListParam } from "im_electron_sdk/dist/interfaces";
let param:GetCommunityListParam = {
user_data:""
}
const {code} = await timRenderInstance.TIMGroupGetJoinedCommunityList(param)
if(code == 0){
//success
}