kickGroupMember
Introduction
Remove or kick some members out of the group.
All the members of the group,including self, will receive the OnMemberKickedCallback callback, after members have been removed or kicked.
AVChatRoom: Do not supports kick members, as it has no restrictions for entering the room, but you can mute a member by muteGroupMember.
Work Group: Only group owner and APP administrators can kick members.
Public Group: Only group owner, group administrators and APP administrators can kick members.
Parameter details
| Parameter name | Parameter type | Required | Platform | Description |
|---|---|---|---|---|
| groupID | String | yes | All | The group ID. |
| memberList | List< String > | yes | All | The list of members that to be kicked or removed. |
| reason | String | no | All | The reason for the operation. |
Returned template
V2TimCallback
{
code : int
desc : String
}
Return value details
| name | type | description |
|---|---|---|
| code | int | Request result: Error codes. 0 means success. |
| desc | String | The description of the error. It will be empty if success. |
Code example
V2TimCallback kickGroupMemberRes =
await TencentImSDKPlugin.v2TIMManager.getGroupManager().kickGroupMember(
groupID: "groupID",
memberList: [],
reason: ""
);
if (kickGroupMemberRes.code == 0) {
}