TIMGroupDelete
功能介绍
删除(解散)群组
对于公开群、聊天室和直播大群,群主可以解散群组。
对于私有群,任何人都无法解散群组。
参数详解
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
deleteParams | DeleteGroupParams | 是 | 删除(解散)群组的参数 |
返回模板
Promise<commonResult<string>>
{
code: TIMResult | TIMErrCode;
desc?: string | undefined;
json_param?: string | undefined;
json_params?: string | undefined; // 兼容
user_data?: string | undefined;
}
返回值详解
名称 | 数值类型 | 描述 |
---|---|---|
code | TIMResult | TIMErrCode | 返回状态码 |
desc | string | undefined | 返回描述 |
json_param | string | undefined | 根据具具体接口返回 |
json_params | string | undefined | 兼容的字段,某些情况下会返回这个,根据具体接口返回 |
user_data | string | undefined | ImSDK负责透传的用户自定义数据,未做任何处理 |
代码示例
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,//必填
data: "" //选填
}
let {code} =await timRenderInstance.TIMGroupDelete(param);
if(code == 0){
//删除成功
}