OpenIMSDKDocs

Type at least two characters to search titles and routes.

EN

Language

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

Pin or unpin a conversation

Pin a conversation to the top of the list or remove its pin state using the OpenIM React Native SDK.

Copy

Toggle the pin-to-top status on a conversation for the current account. Pinned conversations are rendered at the top of the conversation list:

await OpenIMSDK.pinConversation({
  conversationID,
  isPinned: true,
});

Parameters

ParameterTypeRequiredDescription
conversationIDstringYesTarget conversation ID to update.
isPinnedbooleanYesSet true to pin the conversation to the top, or false to unpin.

Return value

A resolved Promise confirms that the conversation pin state was updated on the server and local database.

The update triggers the OnConversationChanged event. Use conversationID to identify the conversation in your local state store and update isPinned so the list order recalculates immediately. For event listeners, see Retrieve conversation list.