SDKsHarmonyOSEnterprise

Kick group member

Remove one or more members from a specified group.

This method cannot be used to remove the group owner. To change the group owner, first use Transfer group ownership.

Code example

import sdk, { KickGroupMemberReq } from '@openimsdk/imsdk';

const request: KickGroupMemberReq = {
  groupID: groupID,
  kickedUserIDs: [targetUserID],
  reason: 'Left the project',
};
await sdk.kickGroupMember(request);

Parameters

Parameter	Type	Required	Description
`groupID`	`string`	Yes	Target group identifier.
`kickedUserIDs`	`string[]`	Yes	Array of user IDs to kick out of the group.
`reason`	`string`	No	Reason for removal.

Return value

Returns a Promise that resolves to void when the removal request is accepted by the server.

Deduplicate kickedUserIDs before invoking this method. Promise resolution confirms that the server accepted the kick request. The SDK triggers group member removed events; upon receiving the notification, clients remove the corresponding records by groupID:userID. For complete event listeners, see Retrieve group member list.

Was this page helpful?

Code example

Parameters

Return value

State changes after the call