TIMGroupDelete

Introduction

Delete group

Permission description:

No one can dismiss Private group.

Group owner can dismiss Group/Meeting group and AVChatRoom.

Delete specified group_id group, you can tell success or not by the callback.

Call GroupDelete to delete a group. Then all group members receive the GroupTipsEventCallback callback.

Parameter details

Parameter name Parameter type Required Description
deleteParams DeleteGroupParams yes Param of deleting group

Returned template

Promise<commonResult<string>>

{
    code: TIMResult | TIMErrCode;
    desc?: string | undefined;
    json_param?: string | undefined;
    json_params?: string | 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 string | undefined Return value of calling API
json_params string | 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 { DeleteGroupParams } from "im_electron_sdk/dist/interfaces";
let groupId = ''

let param: DeleteGroupParams = {
    groupId: groupId,// required
    data: ""    // optional
}
let { code } = await timRenderInstance.TIMGroupDelete(param);
if (code == 0) {
    // success
}

results matching ""

    No results matching ""