Browse SDKs · uni-app / uni-app x
SDKsuni-appEnterprise

Update a conversation group

OpenIM uni-app / uni-app x SDK guide for Update a conversation group.

Copy

updateConversationGroup() Commercial updates only the supplied fields.

Parameters

ParameterTypeRequiredDescription
conversationGroupIDstringYesGroup to update.
namestring or nullNoNew name.
exstring or nullNoNew extension string; completely replaces the old value.
hiddenboolean or nullNoWhether the application UI hides the group.
import { updateConversationGroup } from '@/uni_modules/unix-openim-sdk'

const result = await updateConversationGroup({
  conversationGroupID: groupID,
  name: 'Important',
  hidden: false,
})

Provide at least one real update field in addition to conversationGroupID. ex is a complete replacement; if several modules share it, read and merge their application namespaces first.

Return result

The Promise resolves directly to OpenIMUpdateConversationGroupResult or null. conversationGroup is the updated snapshot or null. Merge it immediately only when it has a valid ID, then reconcile through onConversationGroupChanged or a new query.