TIMGroupDeleteMember
功能介绍
删除群组成员
对于私有群：只有创建者可删除群组成员。
对于公开群和聊天室：只有管理员和群主可以踢人。
对于直播大群：不能踢人。
参数详解
| 参数名称 | 参数类型 | 是否必填 | 描述 |
|---|---|---|---|
| deleteMemberParams | DeleteMemberParams | 是 | 删除群组成员的参数 |
返回模板
Promise<commonResult<DeleteMemberResult>>
{
code: TIMResult | TIMErrCode;
desc?: string | undefined;
json_param?: DeleteMemberResult | undefined;
json_params?: DeleteMemberResult | undefined; // 兼容
user_data?: string | undefined;
}
返回值详解
| 名称 | 数值类型 | 描述 |
|---|---|---|
| code | TIMResult ｜ TIMErrCode | 返回状态码 |
| desc | string ｜ undefined | 返回描述 |
| json_param | DeleteMemberResult ｜ undefined | 根据具具体接口返回 |
| json_params | DeleteMemberResult ｜ undefined | 兼容的字段，某些情况下会返回这个，根据具体接口返回 |
| user_data | string ｜ undefined | ImSDK负责透传的用户自定义数据，未做任何处理 |
代码示例
import TimRender from "im_electron_sdk/dist/renderer";
const timRenderInstance = new TimRender();
import { DeleteMemberParams } from "im_electron_sdk/dist/interfaces";
let groupId = ''
let identifier = ''
let param : DeleteMemberParams ={
params: {
group_delete_member_param_group_id: groupId, //必填
group_delete_member_param_identifier_array: [identifier], //必填
group_delete_member_param_user_data: '' //选填
},
data: 'test data' //选填
}
const {code} = await timRenderInstance.TIMGroupDeleteMember(param)
if(code == 0){
// 成功
}