TIMFriendshipModifyFriendGroup

Introduction

Modify friend group

Parameter details

Parameter name Parameter type Required Description
modifyFriendGroupParams ModifyFriendGroupParams yes Param of modifying friend group

Returned template

Promise<commonResult<Array<FriendResult>>>

{
    code: TIMResult | TIMErrCode;
    desc?: string | undefined;
    json_param?: Array<FriendResult> | undefined;
    json_params?: Array<FriendResult> | 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< FriendResult > ｜ undefined Return value of calling API
json_params Array< FriendResult > ｜ 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 { ModifyFriendGroupParams } from "im_electron_sdk/dist/interfaces";
let param: ModifyFriendGroupParams = {
    params: {
        friendship_modify_friend_group_param_name: "",    // required
        friendship_modify_friend_group_param_new_name: "",    // optional
        friendship_modify_friend_group_param_delete_identifier_array: [""],    // optional
        friendship_modify_friend_group_param_add_identifier_array: [""]    // optional
    },
    user_data: ""
}

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

results matching ""

    No results matching ""