Browse SDKs · React Native
Platform
SDKsReact Native

Dismiss a group

Disband and permanently dismiss a group as group owner using the OpenIM React Native SDK.

Copy

Disband and permanently dismiss a group. Only the group owner possesses permission to dismiss the group:

await OpenIMSDK.dismissGroup(groupID);

Parameters

ParameterTypeRequiredDescription
groupIDstringYesTarget group ID to dismiss. Verified against the caller's owner role by the server.

Return value

A resolved Promise confirms that the group has been permanently dismissed on the server.

Dismissal emits the OnGroupDismissed event to all members with the dismissed group payload. Remove the group entry identified by groupID from the joined groups list and clear local group member caches. For event listeners, see Group overview.