Event Listening

Global IM UIKit provides event listening capabilities, allowing developers to intercept and modify the handling logic of certain events to override default behaviors and meet customized business requirements.

All external event type definitions can be obtained through the RCKitEvents constant provided by Global IM UIKit.

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

Adding Event Listeners

Code Example

// Using RCKitEvents.ALERT_EVENT as an example
kitApp.addEventListener(RCKitEvents.ALERT_EVENT, (evt) => {
  // evt is an RCKitEvent object containing event type, data, and other information
  const { data } = evt;
  console.log('Received warning message:', data);
});

Parameters

Name	Type	Required	Description
eventType	String	Yes	Event type, available through the RCKitEvents constant
listener	Function	Yes	Event listener, which receives an RCKitEvent object as a parameter
thisObj	Object	No	this context for the event listener

RCKitEvent Object

All event listener callback functions receive an RCKitEvent object or its subclass as a parameter, which contains event type, data, and other information.

preventDefault

The RCKitEvent object provides the preventDefault method to block Global IM UIKit's default behavior.

For example, when Global IM UIKit dispatches the RCKitEvents.ALERT_EVENT event, you can use the RCKitEvent object to retrieve the warning message and block the default UI warning behavior using preventDefault. Instead, you can use a custom warning popup UI component to display the message.

const listener = (evt) => {
  const { data } = evt;
  // Block SDK's default behavior; the SDK will no longer display a warning popup
  evt.preventDefault();
  // Use a custom warning popup UI component to ensure consistent UI style
  alert(data);
};

kitApp.addEventListener(RCKitEvents.ALERT_EVENT, listener);

sendResult

Some events require returning a result to Global IM UIKit for further processing. In such cases, you can use the sendResult method of the RCKitEvent object to return the result.

For example, the RCKitEvents.CONFIRM_EVENT event triggers a built-in confirmation popup in Global IM UIKit and expects a boolean value as the user's choice. You can intercept this event to implement a custom popup UI component and return the user's confirmation result to Global IM UIKit using sendResult.

const listener = (evt) => {
  const { data } = evt;
  // Block SDK's default behavior to prevent the SDK from using its built-in UI popup
  evt.preventDefault();
  // Use a custom confirmation popup UI component to ensure consistent UI style
  confirm(data, (result) => {
    // Return the user's confirmation result to the SDK
    evt.sendResult(result);
  });
};

kitApp.addEventListener(RCKitEvents.CONFIRM_EVENT, listener);

sendResult only accepts the first parameter passed during its initial call as the processing result; subsequent calls are ignored.

Removing Event Listeners

Example

kitApp.removeEventListener(RCKitEvents.ALERT_EVENT, listener);

Parameter Description

Name	Type	Required	Description
eventType	String	Yes	Event type, available through the RCKitEvents constant
listener	Function	Yes	Event listener, which receives an RCKitEvent object as a parameter
thisObj	Object	No	this context for the event listener

Event List

The RCKitEvents constant defines all event types provided by Global IM UIKit. You can retrieve event types through this constant.

Dispatch Mode Description:

• 0: (default) Dispatch to the business layer first; if weakly intercepted by the business layer, the event will not continue to propagate to the SDK.
• 1: Dispatch to both the business layer and the SDK, unaffected by business layer interception, and does not receive results from the business layer.
• 2: Dispatch only to the business layer; the SDK does not handle the event.

Event	Data Type	Dispatch Mode	Description
ALERT_EVENT	String	0	SDK warning message
CONFIRM_EVENT	String	0	SDK confirmation popup event, Note: This listener can receive results from the business layer; result type: Boolean
DELETE_MESSAGE_MODAL_EVENT	IRCKitModalDeleteMessage	0	Message recall or delete confirmation popup, Note: This listener can receive results from the business layer; result type: IRCKitModalDeleteMessageResult
MEDIA_MESSAGE_MODAL_EVENT	IRCKitCachedMessage	0	Media message popup event
COMBINE_MESSAGE_MODAL_EVENT	IRCKitCachedMessage	0	Merge and forward message popup event
FORWARDING_EVENT	RCKitModalForwardingType	0	Message forwarding popup event, Note: This listener can receive results from the business layer; result type: IRCKitModalForwardingResult
UNSCHEDULED_MESSAGES	IAReceivedMessage	0	Received messages that the SDK cannot handle internally; the business layer can retrieve these messages by listening to this event
CONVERSATION_EXTENSION_CLICK	IRCKitConversationExtensionClick	0	Conversation panel business extension button click event
BEFORE_SYSTEM_CONVERSATION_OPEN	IRCKitCachedConversation	2	Event before opening a system conversation; the business layer can intercept the opening of system conversations by listening to this event to customize the opening method
CONVERSATION_MENU_ITEM_CLICK	IRCKitConversationMenuItemClick	0	Conversation menu item click event
INPUT_MENU_ITEM_CLICK	IRCKitInputMenuItemClick	2	Input box menu click event
CONVERSATION_SELECTED	IRCKitCachedConversation	1	Selected conversation change event
CONVERSATION_ICON_CLICK	IRCKitConversationIconClick	2	Message list avatar click event
MESSAGES_DELETED	IRCKitDeleteMessageData	1	Message deletion event
MESSAGE_MENU_ITEM_CLICK	IRCKitMessageMenuItemClick	0	Message menu click event
MESSAGE_LINK_CLICK	IRCKitMessageLinckClick	0	Text message link click event
DOWNLOAD_LINK_EVENT	IRCKitCachedMessage	0	Media message download click event
FILE_SEND_FAILED_EVENT	File[]	0	File send failure event, usually caused by file size exceeding limits or being empty