TIMFriendshipGetPendencyList

Introduction

Get friend request pendency list

Friend pendency means unresolved (undetermined) friend request.

Parameter details

Parameter name Parameter type Required Description
friendshipGetPendencyListParams FriendshipGetPendencyListParams yes Param of getting friend request pendency list

Returned template

Promise<commonResult<PendencyPage>>

{
    code: TIMResult | TIMErrCode;
    desc?: string | undefined;
    json_param?: PendencyPage | undefined;
    json_params?: PendencyPage | 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 PendencyPage | undefined Return value of calling API
json_params PendencyPage | 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 { FriendshipGetPendencyListParams } from "im_electron_sdk/dist/interfaces";
let param: FriendshipGetPendencyListParams = {
    params: {
        friendship_get_pendency_list_param_type: 0,
        friendship_get_pendency_list_param_start_seq: 0,
        friendship_get_pendency_list_param_start_time: 0,
        friendship_get_pendency_list_param_limited_size: 0,
    },
    user_data: ""    // optional
}

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

results matching ""

    No results matching ""