Browse SDKs · HarmonyOS
Platform
SDKsHarmonyOSEnterprise

Delete conversation group

Delete a conversation group and remove its conversation associations.

Copy

Deleting a conversation group disassociates its assigned conversations, but does not delete the underlying conversations or chat messages.

Code example

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

const request: DeleteConversationGroupReq = {
  conversationGroupID: conversationGroupID,
};
await sdk.deleteConversationGroup(request);

Parameters

ParameterTypeRequiredDescription
conversationGroupIDstringYesThe identifier of the conversation group to delete (not a chat group ID).

Return value

Returns a Promise that resolves to void upon deletion.

State changes after the call

Once the Promise resolves, remove the group entry from local state using conversationGroupID. The server notifies connected clients via EventOnConversationGroupDeleted. See Conversation groups overview for complete listener setups.