kickGroupMember
功能介绍
踢人
普通群成员被踢后,全员(包括被踢人)会收到 OnMemberKicked 回调。
由于直播群(AVChatRoom)对进群没有限制,因此直播群(AVChatRoom)没有支持踢人的接口,您可以使用 muteGroupMember 禁言指定成员达到类似的成员管控的目的。
工作群(Work):只有群主或 APP 管理员可以踢人。
公开群(Public)、会议群(Meeting):群主、管理员和 APP 管理员可以踢人 。
直播群(AVChatRoom):只支持禁言(muteGroupMember),不支持踢人。
参数详解
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
groupID | string | 是 | 需要踢人的群组id |
memberList | string[] | 是 | 踢出的用户id列表 |
返回模板
V2TimCallback
{
code : number
desc : string
}
返回值详解
名称 | 数值类型 | 描述 |
---|---|---|
code | number | 请求结果错误码 |
desc | string | 请求结果描述符 |
代码示例
import { TencentImSDKPlugin } from 'react-native-tim-js';
//群组踢人
const kickGroupMemberRes = await TencentImSDKPlugin.v2TIMManager
.getGroupManager()
.kickGroupMember(
'groupID', // 需要踢人的群组id
[], // 踢出的用户id列表
'reason' // 踢出原因
);
if (kickGroupMemberRes.code === 0) {
// 踢出成功
}