OpenIMSDKDocs

Type at least two characters to search titles and routes.

EN

Language

ENEnglishEnglish docs简中简体中文中文文档
Browse SDKs · React Native
Platform
SDKsReact NativeEnterprise

Set conversation remark

Configure a personal alias remark for a conversation using the OpenIM React Native SDK.

Copy

Assign a custom alias remark for a conversation visible only to the current account:

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

Parameters

ParameterTypeRequiredDescription
conversationIDstringYesTarget conversation ID to update.
remarkstringNoCustom conversation remark. Pass an empty string "" to clear the existing remark.

When rendering conversation titles in the list view, prioritize remark over showName if present. Setting a conversation remark affects only the conversation display for this account; it does not change the global nickname of a user or group.

Return value

A resolved Promise confirms that the conversation remark was saved to the server.

The update triggers the OnConversationChanged event. Use conversationID to identify the conversation entry and update its remark field. For event listener details, see Retrieve conversation list.