Skip to main content

Conversation Management

getOpenedConversation​

Global IM UIKit provides the getOpenedConversation interface to retrieve the currently opened conversation in the UI. If no conversation is currently open, the return value will be null.

const conversation = kitApp.getOpenedConversation();

openConversation​

Opens a specified conversation. If the conversation does not exist in the currently displayed conversation list, Global IM UIKit will create a new conversation and place it as far forward as possible in the conversation list.

const { code } = await kitApp.openConversation({ conversationType: ConversationType.PRIVATE, targetId: 'A' });

setConversationExtension​

Adds extension features to the conversation display panel. The added extensions will be displayed in the area to the right of the conversation information Title panel, above the opened conversation, as indicated by the arrow below.

kitApp.setConversationExtension([
  {
    id: "NOT_SYSTEM", // Feature ID, used to distinguish between different extension features
    icon: "", // The icon file address to be displayed, SVG images are recommended
    filter(conversation) {
      // Filter function, used to differentiate display for different conversations; when the return value is false, the extension feature will not be displayed
      // In this example, the feature is not displayed for system conversation types
      return conversation.conversationType !== ConversationType.SYSTEM;
    },
  },
  {
    id: "ALL",
    icon: "",
  },
]);

When a user clicks on an extension feature button, Global IM UIKit will dispatch the RCKitEvents.CONVERSATION_EXTENSION_CLICK event for notification.

import { RCKitEvents } from '@rongcloud/global-im-uikit';

kitApp.addEventListener(RCKitEvents.CONVERSATION_EXTENSION_CLICK, (evt) => {
  const data = evt.data;
  console.log('Clicked feature ID:', data.id);
  console.log('Current conversation:', data.conversation);
})
Last updated on