TIMFriendshipGetFriendGroupList
Introduction
Get friend group list
Parameter details
Parameter name |
Parameter type |
Required |
Description |
friendshipStringArrayParams |
FriendshipStringArrayParams |
yes |
Param of getting friend group list |
Returned template
Promise<commonResult<Array<FriendGroupInfo>>>
{
code: TIMResult | TIMErrCode;
desc?: string | undefined;
json_param?: Array<FriendGroupInfo> | undefined;
json_params?: Array<FriendGroupInfo> | 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< FriendGroupInfo > | undefined |
Return value of calling API |
json_params |
Array< FriendGroupInfo > | 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 { FriendshipStringArrayParams } from "im_electron_sdk/dist/interfaces";
let param: FriendshipStringArrayParams = {
params: [""],
user_data: ""
}
const { code } = await timRenderInstance.TIMFriendshipGetFriendGroupList(param);
if (code == 0) {
}