Skip to main content
// User Listener — online/offline presence
CometChat.addUserListener("ID", new CometChat.UserListener({
  onUserOnline: (user) => { },
  onUserOffline: (user) => { }
}));

// Message Listener — messages, typing, receipts, reactions
CometChat.addMessageListener("ID", new CometChat.MessageListener({
  onTextMessageReceived: (msg) => { },
  onMediaMessageReceived: (msg) => { },
  onTypingStarted: (indicator) => { },
  onMessagesRead: (receipt) => { }
}));

// Group Listener — member join/leave/kick/ban/scope changes
CometChat.addGroupListener("ID", new CometChat.GroupListener({
  onGroupMemberJoined: (action, joinedUser, joinedGroup) => { },
  onGroupMemberLeft: (action, leftUser, leftGroup) => { }
}));

// Call Listener — incoming/outgoing call events
CometChat.addCallListener("ID", new CometChat.CallListener({
  onIncomingCallReceived: (call) => { },
  onOutgoingCallAccepted: (call) => { }
}));

// Always clean up
CometChat.removeUserListener("ID");
CometChat.removeMessageListener("ID");
CometChat.removeGroupListener("ID");
CometChat.removeCallListener("ID");
Real-time listeners let you receive live events — messages, presence changes, group updates, and call signals — as they happen. The pattern is the same for all four listener types:
  1. Register a listener with a unique ID using addXListener()
  2. Handle events in the callback methods
  3. Remove the listener with removeXListener() when it’s no longer needed
Each listener ID must be unique. Re-registering with the same ID replaces the previous listener. Always remove listeners on component unmount or page navigation to prevent memory leaks.
Always remove listeners when they’re no longer needed (e.g., on component unmount or page navigation). Failing to remove listeners can cause memory leaks and duplicate event handling.
CometChat provides 4 listeners viz.
  1. User Listener
  2. Group Listener
  3. Message Listener
  4. Call Listener
  5. AI Assistant Listener
  6. Ongoing Call Listener (Calls SDK)

User Listener

Receive online/offline presence events for users.
MethodInformation
onUserOnline(user: CometChat.User)This method is triggered when a user comes online and is available to chat. The details of the user can be obtained from the user object received as the method parameter.
onUserOffline(user: CometChat.User)This method is triggered when a user goes offline. The details of the user can be obtained from the User object received as the parameter.
To add the UserListener:
const listenerID: string = "UNIQUE_LISTENER_ID";
CometChat.addUserListener(
  listenerID,
  new CometChat.UserListener({
    onUserOnline: (onlineUser: CometChat.User) => {
      /* when someuser/friend comes online, user will be received here */
      console.log("On User Online:", { onlineUser });
    },
    onUserOffline: (offlineUser: CometChat.User) => {
      /* when someuser/friend went offline, user will be received here */
      console.log("On User Offline:", { offlineUser });
    },
  })
);
Remove the listener when no longer needed:
let listenerID: string = "UNIQUE_LISTENER_ID";
CometChat.removeUserListener(listenerID);

Group Listener

Receive events when group members join, leave, are kicked/banned, or have their scope changed.
MethodInformation
onGroupMemberJoined(action: CometChat.Action, joinedUser: CometChat.User, joinedGroup: CometChat.Group)This method is triggered when a user joins any group. All the members present in the group will receive this event.
onGroupMemberLeft(action: CometChat.Action, leftUser: CometChat.User, leftGroup: CometChat.Group)This method is triggered when a user who was a member of any group leaves the group. All the members of the group receive this event.
onGroupMemberKicked(action: CometChat.Action, kickedUser: CometChat.User, kickedBy: CometChat.User, kickedFrom: CometChat.Group)This method is triggered when a user is kicked from a group. All the members including the user receive this event
onGroupMemberBanned(action: CometChat.Action, bannedUser: CometChat.User, bannedBy: CometChat.User, bannedFrom: CometChat.Group)This method is triggered when a user is banned from a group. All the members including the user receive this event
onGroupMemberUnbanned(action: CometChat.Action, unbannedUser: CometChat.User, unbannedBy: CometChat.User, unbannedFrom: CometChat.Group)This method is triggered when a user is banned from a group. All the members of the group receive this event.
onGroupMemberScopeChanged(action: CometChat.Action, changedUser: CometChat.User, newScope: string, oldScope: string, changedGroup: CometChat.Group)This method is triggered when the scope of any Group Member has been changed. All the members that are a part of that group receive this event
onMemberAddedToGroup(action: CometChat.Action, userAdded: CometChat.User, addedBy: CometChat.User, addedTo: CometChat.Group)This method is triggered when a user is added to any group. All the members including the user himself receive this event.
To add the GroupListener:
CometChat.addGroupListener(
  "UNIQUE_LISTENER_ID",
  new CometChat.GroupListener({
    onGroupMemberJoined: (
      message: CometChat.Action,
      joinedUser: CometChat.User,
      joinedGroup: CometChat.Group
    ) => {
      console.log("onGroupMemberJoined", { message, joinedUser, joinedGroup });
    },
    onGroupMemberLeft: (
      message: CometChat.Action,
      leftUser: CometChat.User,
      leftGroup: CometChat.Group
    ) => {
      console.log("onGroupMemberLeft", { message, leftUser, leftGroup });
    },
    onGroupMemberKicked: (
      message: CometChat.Action,
      kickedUser: CometChat.User,
      kickedBy: CometChat.User,
      kickedFrom: CometChat.Group
    ) => {
      console.log("onGroupMemberKicked", {
        message,
        kickedUser,
        kickedBy,
        kickedFrom,
      });
    },
    onGroupMemberBanned: (
      message: CometChat.Action,
      bannedUser: CometChat.User,
      bannedBy: CometChat.User,
      bannedFrom: CometChat.Group
    ) => {
      console.log("onGroupMemberBanned", {
        message,
        bannedUser,
        bannedBy,
        bannedFrom,
      });
    },
    onGroupMemberUnbanned: (
      message: CometChat.Action,
      unbannedUser: CometChat.User,
      unbannedBy: CometChat.User,
      unbannedFrom: CometChat.Group
    ) => {
      console.log("onGroupMemberUnbanned", {
        message,
        unbannedUser,
        unbannedBy,
        unbannedFrom,
      });
    },
    onGroupMemberScopeChanged: (
      message: CometChat.Action,
      changedUser: CometChat.User,
      newScope: string,
      oldScope: string,
      changedGroup: CometChat.Group
    ) => {
      console.log("onGroupMemberScopeChanged", {
        message,
        changedUser,
        newScope,
        oldScope,
        changedGroup,
      });
    },
    onMemberAddedToGroup: (
      message: CometChat.Action,
      userAdded: CometChat.User,
      addedby: CometChat.User,
      addedTo: CometChat.Group
    ) => {
      console.log("onMemberAddedToGroup", {
        message,
        userAdded,
        addedby,
        addedTo,
      });
    },
  })
);
Remove the listener when no longer needed:
let listenerID: string = "UNIQUE_LISTENER_ID";
CometChat.removeGroupListener(listenerID);

Message Listener

Receive events for incoming messages, typing indicators, read/delivery receipts, message edits/deletes, reactions, and moderation results.
MethodInformation
onTextMessageReceived(message: CometChat.TextMessage)This event is triggered when a Text Message is received.
onMediaMessageReceived(message: CometChat.MediaMessage)This event is triggered when a Media Message is received.
onCustomMessageReceived(message: CometChat.CustomMessage)This event is triggered when a Custom Message is received.
onTypingStarted(typingIndicator: CometChat.TypingIndicator)This event is triggered when a user starts typing in a user/group conversation
onTypingEnded(typingIndicator: CometChat.TypingIndicator)This event is triggered when a user stops typing in a user/group conversation.
onMessagesDelivered(messageReceipt: CometChat.MessageReceipt)This event is triggered when a set of messages are marked as delivered for any particular conversation.
onMessagesRead(messageReceipt: CometChat.MessageReceipt)This event is triggered when a set of messages are marked as read for any particular conversation.
onMessageEdited(message: CometChat.BaseMessage)This method is triggered when a particular message has been edited in a user/group conversation.
onMessageDeleted(message: CometChat.BaseMessage)This event is triggered when a particular message is deleted in a user/group conversation.
onTransientMessageReceived(receipt: CometChat.TransientMessage)This event is triggered when a Transient Message is received.
onMessageReactionAdded(receipt: CometChat.ReactionEvent)This event is triggered when a reaction is added to a message in a user/group conversation.
onMessageReactionRemoved(receipt: CometChat.ReactionEvent)This event is triggered when a reaction is remove from a message in a user/group conversation.
onMessageModerated(message: CometChat.BaseMessage)This event is triggered when a message sent by the logged-in user is successfully processed by moderation and receives either an approved or disapproved status.
onMessagesDeliveredToAll(receipt: CometChat.MessageReceipt)This event is triggered when a group message is delivered to all members. Group conversations only.
onMessagesReadByAll(receipt: CometChat.MessageReceipt)This event is triggered when a group message is read by all members. Group conversations only.
onAIAssistantMessageReceived(message: CometChat.AIAssistantMessage)This event is triggered when a persisted AI assistant reply is received after an agent run completes.
onAIToolResultReceived(message: CometChat.AIToolResultMessage)This event is triggered when a persisted AI tool result message is received after an agent run completes.
onAIToolArgumentsReceived(message: CometChat.AIToolArgumentMessage)This event is triggered when a persisted AI tool argument message is received after an agent run completes.
To add the MessageListener, you need to use the addMessageListener() method provided by the CometChat class.
CometChat.addMessageListener(
  "UNIQUE_LISTENER_ID",
  new CometChat.MessageListener({
    onTextMessageReceived: (textMessage: CometChat.TextMessage) => {
      console.log("Text message received successfully", textMessage);
    },
    onMediaMessageReceived: (mediaMessage: CometChat.MediaMessage) => {
      console.log("Media message received successfully", mediaMessage);
    },
    onCustomMessageReceived: (customMessage: CometChat.CustomMessage) => {
      console.log("Custom message received successfully", customMessage);
    },
    onMessagesDelivered: (messageReceipt: CometChat.MessageReceipt) => {
      console.log("Message Delivered", messageReceipt);
    },
    onMessagesRead: (messageReceipt: CometChat.MessageReceipt) => {
      console.log("Message Read", messageReceipt);
    },
    onTypingStarted: (typingIndicator: CometChat.TypingIndicator) => {
      console.log("Typing Started", typingIndicator);
    },
    onTypingEnded: (typingIndicator: CometChat.TypingIndicator) => {
      console.log("Typing Ended", typingIndicator);
    },
    onMessageDeleted: (message: CometChat.BaseMessage) => {
      console.log("Message Delted", message);
    },
    onMessageEdited: (message: CometChat.BaseMessage) => {
      console.log("Message Edited", message);
    },
    onTransientMessageReceived: (message: CometChat.TransientMessage) => {
      console.log("Transient Message received", message);
    },
    onMessageReactionAdded: (reaction: CometChat.ReactionEvent) => {
      console.log("Message Reaction added", reaction);
    },
    onMessageReactionRemoved: (reaction: CometChat.ReactionEvent) => {
      console.log("Message Reaction removed", reaction);
    },
    onMessageModerated: (message: CometChat.BaseMessage) => {
      console.log("Message Moderated", message);
    },
    onMessagesDeliveredToAll: (messageReceipt: CometChat.MessageReceipt) => {
      console.log("Message Delivered to All", messageReceipt);
    },
    onMessagesReadByAll: (messageReceipt: CometChat.MessageReceipt) => {
      console.log("Message Read by All", messageReceipt);
    },
    onAIAssistantMessageReceived: (message: CometChat.AIAssistantMessage) => {
      console.log("AI Assistant message received", message);
    },
    onAIToolResultReceived: (message: CometChat.AIToolResultMessage) => {
      console.log("AI Tool result received", message);
    },
    onAIToolArgumentsReceived: (message: CometChat.AIToolArgumentMessage) => {
      console.log("AI Tool arguments received", message);
    },
  })
);
Remove the listener when no longer needed:
let listenerID: string = "UNIQUE_LISTENER_ID";
CometChat.removeMessageListener(listenerID);

Call Listener

Receive events for incoming and outgoing call state changes.
MethodInformation
onIncomingCallReceived(call: CometChat.Call)This event is triggered when the logged-in user receives an incoming call. The details of the call can be obtained from the Call object received as the method parameter.
onOutgoingCallAccepted(call: CometChat.Call)This event is triggered when the call initiated by the logged-in user is accepted by the recipient. The details of the call can be obtained from the Call object received as the method parameter.
onOutgoingCallRejected(call: CometChat.Call)This event is triggered when the call initiated by the logged-in user is rejected by the recipient. The details of the call can be obtained from the Call object received as the method parameter
onIncomingCallCancelled(call: CometChat.Call)This event is triggered when an incoming call is canceled by the initiator of the call. The details of the call can be obtained from the Call object received as the method parameter
onCallEndedMessageReceived(call: CometChat.Call)This event is triggered when a call ends. The call object contains the final status and duration.
To add the CallListener:
CometChat.addCallListener(
  "UNIQUE_LISTENER_ID",
  new CometChat.CallListener({
    onIncomingCallReceived: (call: CometChat.Call) => {
      console.log("Incoming call:", call);
    },
    onOutgoingCallAccepted: (call: CometChat.Call) => {
      console.log("Outgoing call accepted:", call);
    },
    onOutgoingCallRejected: (call: CometChat.Call) => {
      console.log("Outgoing call rejected:", call);
    },
    onIncomingCallCancelled: (call: CometChat.Call) => {
      console.log("Incoming call canceled:", call);
    },
    onCallEndedMessageReceived: (call: CometChat.Call) => {
      console.log("Call ended message:", call);
    },
  })
);
Remove the listener when no longer needed:
let listenerID: string = "UNIQUE_LISTENER_ID";
CometChat.removeCallListener(listenerID);

AI Assistant Listener

The AIAssistantListener provides real-time streaming events from AI Agent runs. These events are received as the agent processes a user’s message, before the final persisted messages arrive via the MessageListener.
MethodInformation
onAIAssistantEventReceived(event: CometChat.AIAssistantBaseEvent)This event is triggered for each streaming event during an AI Agent run (run start, tool calls, text message streaming, run finished). See AIAssistantBaseEvent for the event structure.
const listenerID: string = "UNIQUE_LISTENER_ID";
CometChat.addAIAssistantListener(
  listenerID,
  new CometChat.AIAssistantListener({
    onAIAssistantEventReceived: (event: CometChat.AIAssistantBaseEvent) => {
      console.log("AI Assistant event:", event.getType(), event);
    },
  })
);
To remove the listener:
CometChat.removeAIAssistantListener("UNIQUE_LISTENER_ID");

Ongoing Call Listener (Calls SDK)

The OngoingCallListener provides real-time callbacks for active call session events. It is part of the CometChat Calls SDK (not the Chat SDK) and is used with CallSettingsBuilder.setCallListener() or CometChatCalls.addCallEventListener(). All three calling flows — Call Session, Standalone Calling, and Ringing — use the same OngoingCallListener.

Callbacks

CallbackParameterDescription
onUserJoined(user)user objectA remote participant joined the call
onUserLeft(user)user objectA remote participant left the call
onUserListUpdated(userList)Array of user objectsThe participant list changed (join or leave)
onCallEnded()The call session terminated (1:1 calls only, fires for both participants)
onCallEndButtonPressed()The local user clicked the end call button
onSessionTimeout()The call was auto-terminated due to inactivity. v4.1.0+
onScreenShareStarted()The local user started sharing their screen
onScreenShareStopped()The local user stopped sharing their screen
onUserMuted(event)event objectA participant’s mute state changed
onCallSwitchedToVideo(event)event objectAn audio call was upgraded to video
onMediaDeviceListUpdated(deviceList)deviceList objectAvailable audio/video devices changed
onRecordingStarted(event)event objectA user started recording the call
onRecordingStopped()Recording was stopped
onError(error)CometChatCallsExceptionAn error occurred during the call session

Callback Parameter Shapes

user object (received by onUserJoined, onUserLeft):
PropertyTypeDescription
namestringDisplay name of the user
avatarstringURL of the user’s avatar
uidstringUID of the user
onUserListUpdated(userList) — receives an array of user objects with the same shape as above. onUserMuted(event):
PropertyTypeDescription
event.muted.namestringName of the muted user
event.muted.uidstringUID of the muted user
event.muted.isAudioMutedbooleanWhether audio is muted
event.muted.isVideoMutedbooleanWhether video is muted
event.mutedBy.namestringName of the user who muted
event.mutedBy.uidstringUID of the user who muted
onCallSwitchedToVideo(event):
PropertyTypeDescription
event.sessionIdstringSession ID of the call
event.initiator.namestringName of the user who initiated the switch
event.initiator.uidstringUID of the initiator
event.responder.namestringName of the responder
event.responder.uidstringUID of the responder
onMediaDeviceListUpdated(deviceList):
PropertyTypeDescription
deviceList.videoInputDevicesMediaDeviceInfo[]Available cameras
deviceList.audioInputDevicesMediaDeviceInfo[]Available microphones
deviceList.audioOutputDevicesMediaDeviceInfo[]Available speakers/headphones
onRecordingStarted(event):
PropertyTypeDescription
event.user.namestringName of the user who started recording
event.user.uidstringUID of the user who started recording
onRecordingStopped(), onCallEnded(), onSessionTimeout(), onCallEndButtonPressed(), onScreenShareStarted(), onScreenShareStopped() — receive no arguments.
const listenerId: string = "UNIQUE_LISTENER_ID";

CometChatCalls.addCallEventListener(listenerId, {
  onUserJoined: (user: any) => {
    console.log("User joined:", user);
  },
  onUserLeft: (user: any) => {
    console.log("User left:", user);
  },
  onCallEnded: () => {
    console.log("Call ended");
  },
  onCallEndButtonPressed: () => {
    console.log("End call button pressed");
  },
  onError: (error: any) => {
    console.log("Call error:", error);
  },
});

// Remove listener when done
CometChatCalls.removeCallEventListener(listenerId);

Login Listener

Receive events when the user’s authentication state changes — login success/failure and logout success/failure.
MethodDescription
loginSuccess(user)User logged in successfully. Provides the User object.
loginFailure(error)Login failed. Provides a CometChatException.
logoutSuccess()User logged out successfully.
logoutFailure(error)Logout failed. Provides a CometChatException.
const listenerID: string = "UNIQUE_LISTENER_ID";
CometChat.addLoginListener(
  listenerID,
  new CometChat.LoginListener({
    loginSuccess: (user: CometChat.User) => {
      console.log("LoginListener :: loginSuccess", user);
    },
    loginFailure: (error: CometChat.CometChatException) => {
      console.log("LoginListener :: loginFailure", error);
    },
    logoutSuccess: () => {
      console.log("LoginListener :: logoutSuccess");
    },
    logoutFailure: (error: CometChat.CometChatException) => {
      console.log("LoginListener :: logoutFailure", error);
    }
  })
);
Remove the listener when no longer needed:
CometChat.removeLoginListener("UNIQUE_LISTENER_ID");

Connection Listener

Receive events when the WebSocket connection state changes.
MethodDescription
onConnected()SDK has an active connection to CometChat servers.
inConnecting()SDK is attempting to establish or re-establish a connection.
onDisconnected()SDK is disconnected due to network issues or other errors.
onFeatureThrottled()A feature has been throttled due to rate limiting.
const listenerID: string = "UNIQUE_LISTENER_ID";
CometChat.addConnectionListener(
  listenerID,
  new CometChat.ConnectionListener({
    onConnected: () => {
      console.log("ConnectionListener :: connected");
    },
    inConnecting: () => {
      console.log("ConnectionListener :: connecting");
    },
    onDisconnected: () => {
      console.log("ConnectionListener :: disconnected");
    },
    onFeatureThrottled: () => {
      console.log("ConnectionListener :: feature throttled");
    }
  })
);
Remove the listener when no longer needed:
CometChat.removeConnectionListener("UNIQUE_LISTENER_ID");

Next Steps

Receive Messages

Handle incoming messages in real-time

Typing Indicators

Show when users are typing

User Presence

Track online/offline status of users

Connection Status

Monitor SDK connection state changes