TIMFriendshipGetFriendsInfo

Introduction

Get friends' info

json_get_friends_info_param length maximum 100, for too much data in one package the connection may be rejected for the maximum size of data package is 1M.

Parameter details

Parameter name Parameter type Required Description
friendshipStringArrayParams FriendshipStringArrayParams yes Param of getting friends' info

Returned template

Promise<commonResult<Array<FriendInfoGetResult>>>

{
    code: TIMResult | TIMErrCode;
    desc?: string | undefined;
    json_param?: Array<FriendInfoGetResult> | undefined;
    json_params?: Array<FriendInfoGetResult> | 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< FriendInfoGetResult > | undefined Return value of calling API
json_params Array< FriendInfoGetResult > | 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: ""    // optional
}

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

results matching ""

    No results matching ""