SDKsuni-app / uni-app x

Kick a group member

Remove one or more members from a specified group.

Invoke kickGroupMember() as a group owner or administrator to expel one or more members from a group. This method cannot be used to remove the group owner; transfer ownership first via Transfer group ownership.

Parameters

Parameter	Type	Required	Description
`groupID`	`string`	Yes	Target group identifier.
`reason`	`string`	Yes	Explanation for kicking the members; pass an empty string if omitted.
`userIDList`	`string[]`	Yes	Array of user IDs of members to kick; deduplicate before invoking.

Code example

import { kickGroupMember } from '@/uni_modules/unix-openim-sdk'

await kickGroupMember({
  groupID: groupID,
  reason: 'Departed from the project',
  userIDList: [targetUserID],
})

Return value

The Promise resolves with void once OpenIMServer processes the expulsion request.

State changes after the call

A resolved Promise confirms that the request was processed by OpenIMServer. Connected clients receive onGroupMemberDeleted, at which point the UI removes the member records using the composite key groupID:userID. For complete member event handling, see Get group member list.

Was this page helpful?