TIMFriendshipCheckFriendType
功能介绍
检测好友类型(单向或双向)
开发者可以通过此接口检测给定的 UserID 列表跟当前账户的好友关系,检测好友相关内容请参考 检测好友。
参数详解
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
checkFriendTypeParams | CheckFriendTypeParams | 是 | 检测好友类型的参数 |
返回模板
Promise<commonResult<Array<CheckFriendTypeResult>>>
{
code: TIMResult | TIMErrCode;
desc?: string | undefined;
json_param?: Array<CheckFriendTypeResult> | undefined;
json_params?: Array<CheckFriendTypeResult> | undefined; // 兼容
user_data?: string | undefined;
}
返回值详解
名称 | 数值类型 | 描述 |
---|---|---|
code | TIMResult | TIMErrCode | 返回状态码 |
desc | string | undefined | 返回描述 |
json_param | Array< CheckFriendTypeResult > | undefined | 根据具具体接口返回 |
json_params | Array< CheckFriendTypeResult > | undefined | 兼容的字段,某些情况下会返回这个,根据具体接口返回 |
user_data | string | undefined | ImSDK负责透传的用户自定义数据,未做任何处理 |
代码示例
import TimRender from "im_electron_sdk/dist/renderer";
const timRenderInstance = new TimRender();
import { CheckFriendTypeParams } from "im_electron_sdk/dist/interfaces";
let param:CheckFriendTypeParams = {
params: {
friendship_check_friendtype_param_check_type: 0,
friendship_check_friendtype_param_identifier_array: [""]
},
user_data: "" //选填
}
const {code} = await timRenderInstance.TIMFriendshipCheckFriendType(param);
if(code == 0){
// 成功
}