Dismiss a group
Disband and permanently dismiss a specified group as the group owner.
Invoke dismissGroup() as the group owner to disband a group permanently. Dismissing a group terminates the group for all members, which differs from an individual member quitting, or deleting/hiding a conversation.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
groupID | string | Yes | The ID of the group to dismiss. |
Code example
import { dismissGroup } from '@/uni_modules/unix-openim-sdk'
await dismissGroup(groupID)Return value
The Promise resolves with void once OpenIMServer accepts the dismissal request.
State changes after the call
A resolved Promise confirms that the disband request was accepted. Connected clients receive onGroupDismissed, at which point the UI marks the group indexed by groupID as dismissed, disabling message input and membership actions. For group event handling, see Group overview.
Conversation retention policies belong to the conversation domain; the group dismissal handler should not unilaterally purge local conversation history.
Was this page helpful?