Browse SDKs · React Native
SDKsReact NativeEnterprise

Set a conversation remark

Set a remark for a conversation for the current account.

Copy

Call setConversation() to set a conversation remark for the current account.

await OpenIMSDK.setConversation({
  conversationID,
  remark: 'Project discussion',
});

Parameters

ParameterTypeRequiredDescription
conversationIDstringYesConversation ID to update.
remarkstringNoConversation remark. Pass an empty string to clear the existing remark.

When displaying a conversation name, the application can prefer remark and fall back to showName when no remark is set. A conversation remark does not update the user's profile or the group name.

Return result

After the call completes, the conversation's remark is updated. Changes in the conversation list are delivered through OnConversationChanged; see Retrieve the conversation list.