TIMGroupQuit

功能介绍

退出群组

对于私有群,全员可退出群组。

对于公开群、聊天室和直播大群,群主不能退出。

退出指定群组groupId的接口,退出成功与否可根据回调cb的参数判断。

参数详解

参数名称 参数类型 是否必填 描述
quitGroupParams QuitGroupParams 退出群组的参数

返回模板

Promise<commonResult<string>>

{
    code: TIMResult | TIMErrCode;
    desc?: string | undefined;
    json_param?: string | undefined;
    json_params?: string | undefined; // 兼容
    user_data?: string | undefined;
}

返回值详解

名称 数值类型 描述
code TIMResultTIMErrCode 返回状态码
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 { QuitGroupParams } from "im_electron_sdk/dist/interfaces";

let groupId =''
let param : QuitGroupParams = {
    groupId: groupId,   //必填
    data: ''    //选填
}
const {code} =await timRenderInstance.TIMGroupQuit(param)
if(code == 0){
    // 成功
}

results matching ""

    No results matching ""