TIMGroupGetJoinedGroupList

Introduction

Get joined group list

Maximum calling 10 times per second. Once exceeded, it returns ERR_SDK_COMM_API_CALL_FREQUENCY_LIMIT (7008) error code.

Parameter details

Parameter name Parameter type Required Description
data string yes Param of getting joined group list

Returned template

Promise<commonResult<Array<GroupInfo>>>

{
    code: TIMResult | TIMErrCode;
    desc?: string | undefined;
    json_param?: Array<GroupInfo> | undefined;
    json_params?: Array<GroupInfo> | undefined; 
    user_data?: string | undefined;
}

Return value details

name type description
code TIMResultTIMErrCode Request result: Error codes. 0 means success.
desc string | undefined The description of the error. It will be empty if success.
json_param Array< GroupInfo > | undefined Return value of calling API
json_params Array< GroupInfo > | 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();

const { code } = await timRenderInstance.TIMGroupGetJoinedGroupList();
if (code == 0) {
    // success
}

results matching ""

    No results matching ""