Browse SDKs · Flutter
Platform
SDKsFlutter

Kick a group member

Remove members from an OpenIM group using the Flutter SDK.

Copy

A group owner or administrator can remove specified members from a group:

Parameters

ParameterTypeRequiredDescription
groupIDStringYesTarget group ID.
reasonStringYesReason or administrative note for removing the members.
userIDListList<String>YesList of user IDs to remove from the group.

Code example

await OpenIM.iMManager.groupManager.kickGroupMember(
  groupID: groupID,
  reason: 'Member roster adjustments',
  userIDList: selectedUserIDs,
);

Return value

A successful Future indicates that the member removal request has been processed by the server.

State changes after the call

Connected clients in the group receive member removal notifications via onGroupMemberDeleted. Remove the corresponding records from local group member rosters using groupID:userID as the key. For complete listener integration, see Retrieving group members overview.