TIMFriendshipGetBlackList

Introduction

Get blacklist

Parameter details

Parameter name Parameter type Required Description
getBlackListParams GetBlackListParams yes Param of getting blacklist

Returned template

Promise<commonResult<Array<FriendProfile>>>

{
    code: TIMResult | TIMErrCode;
    desc?: string | undefined;
    json_param?: Array<FriendProfile> | undefined;
    json_params?: Array<FriendProfile> | 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< [FriendProfile]) > ｜ undefined Return value of calling API
json_params Array< [FriendProfile]) > ｜ 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 { GetBlackListParams } from "im_electron_sdk/dist/interfaces";
let param: GetBlackListParams = {
    user_data: ""    // optional
}

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

results matching ""

    No results matching ""