TIMFriendshipGetFriendsInfo

功能介绍

获取好友信息

params 建议一次最大 100 个,因为数量过多可能会导致数据包太大被后台拒绝,后台限制数据包最大为 1M。

参数详解

参数名称 参数类型 是否必填 描述
friendshipStringArrayParams FriendshipStringArrayParams 获取好友信息的参数

返回模板

Promise<commonResult<Array<FriendInfoGetResult>>>

{
    code: TIMResult | TIMErrCode;
    desc?: string | undefined;
    json_param?: Array<FriendInfoGetResult> | undefined;
    json_params?: Array<FriendInfoGetResult> | undefined; // 兼容
    user_data?: string | undefined;
}

返回值详解

名称 数值类型 描述
code TIMResultTIMErrCode 返回状态码
desc string | undefined 返回描述
json_param Array< FriendInfoGetResult > | undefined 根据具具体接口返回
json_params Array< FriendInfoGetResult > | undefined 兼容的字段,某些情况下会返回这个,根据具体接口返回
user_data string | undefined ImSDK负责透传的用户自定义数据,未做任何处理

代码示例

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.TIMFriendshipGetFriendsInfo(param);
if(code == 0){
    // 成功
}

results matching ""

    No results matching ""