All Real-time Listeners

Learn about all our real-time listeners.

CometChat provides 4 listeners viz.

  1. UserListener
  2. GroupListener
  3. MessageListener

User Listener

The UserListener class provides you with live events related to users. Below are the callback methods provided by the UserListener class.

Method

Information

onUserOnline(User 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 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, you need to use the addUserListener() method provided by the CometChat class.

var listenerID = "UNIQUE_LISTENER_ID";
CometChat.addUserListener(
  listenerID,
  new CometChat.UserListener({
    onUserOnline: onlineUser => {
      /* when someuser/friend comes online, user will be received here */
      console.log("On User Online:", { onlineUser });
    },
    onUserOffline: offlineUser => {
      /* when someuser/friend went offline, user will be received here */
      console.log("On User Offline:", { offlineUser });
    }
  })
);

where UNIQUE_LISTENER_ID is the unique identifier for the listener. Please make sure that no two listeners are added with the same listener id as this could lead to unexpected behavior resulting in loss of events.

Once the UserListener is not in use, you need to remove the listener using the removeUserListener() method which takes the id of the listener to be removed as the parameter.

CometChat.removeUserListener(UNIQUE_LISTENER_ID)

Group Listener

The GroupListener class provides you with all the real-time events related to groups. Below are the callback methods provided by the GroupListener class.

Method

Information

onGroupMemberJoined(Action action, User joinedUser, Group joinedGroup)

This method is triggered when a user joins any group. All the members present in the group will receive this event.

onGroupMemberLeft(Action action, User leftUser, Group leftGroup)

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 action, User kickedUser, User kickedBy, Group kickedFrom)

This method is triggered when a user is kicked from a group. All the members including the user receive this event

onGroupMemberBanned(Action action, User bannedUser, User bannedBy, Group bannedFrom)

This method is triggered when a user is banned from a group. All the members including the user receive this event

onGroupMemberUnbanned(Action action, User unbannedUser, User unbannedBy, Group unbannedFrom)

This method is triggered when a user is banned from a group. All the members of the group receive this event.

onGroupMemberScopeChanged(Action action, User changedUser, String newScope, String oldScope, Group changedGroup)

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 action, User userAdded, User addedBy, Group addedTo)

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, you need to use the addGroupListener() method provided by the CometChat class.

CometChat.addGroupListener(
  "UNIQUE_LISTENER_ID",
  new CometChat.GroupListener({
    onGroupMemberJoined: (message, joinedUser, joinedGroup) => {
      console.log("onGroupMemberJoined", { message, joinedUser, joinedGroup });
    },
    onGroupMemberLeft: (message, leftUser, leftGroup) => {
      console.log("onGroupMemberLeft", { message, leftUser, leftGroup });
    },
    onGroupMemberKicked: (message, kickedUser, kickedBy, kickedFrom) => {
      console.log("onGroupMemberKicked", { message, kickedUser, kickedBy, kickedFrom });
    },
    onGroupMemberBanned: (message, bannedUser, bannedBy, bannedFrom) => {
      console.log("onGroupMemberBanned", { message, bannedUser, bannedBy, bannedFrom });
    },
    onGroupMemberUnbanned: (message, unbannedUser, unbannedBy, unbannedFrom) => {
      console.log("onGroupMemberUnbanned", { message, unbannedUser, unbannedBy, unbannedFrom });
    },
    onGroupMemberScopeChanged: (message, changedUser, newScope, oldScope, changedGroup) => {
      console.log("onGroupMemberScopeChanged", { message, changedUser, newScope, oldScope, changedGroup });
    },
    onMemberAddedToGroup: (message, userAdded, addedby, addedTo) => {
      console.log("onMemberAddedToGroup", { message, userAdded, addedby, addedTo });
    },
  })
);

where UNIQUE_LISTENER_ID is the unique identifier for the listener. Please make sure that no two listeners are added with the same listener id as this could lead to unexpected behavior resulting in loss of events.

Once the GroupListener is not in use, you need to remove the listener using the removeGroupListener() method which takes the id of the listener to be removed as the parameter.

CometChat.removeGroupListener(UNIQUE_LISTENER_ID)

Message Listener

The MessageListener class provides you with live events related to messages. Below are the callback methods provided by the MessageListener class.

Method

Information

onTextMessageReceived(TextMessage message)

This event is triggered when a Text Message is received.

onMediaMessageReceived(MediaMessage message)

This event is triggered when a Media Message is received.

onCustomMessageReceived(CustomMessage message)

This event is triggered when a Custom Message is received.

onTypingStarted(TypingIndicator typingIndicator)

This event is triggered when a user starts typing in a user/group conversation

onTypingEnded(TypingIndicator typingIndicator)

This event is triggered when a user stops typing in a user/group conversation.

onMessagesDelivered(MessageReceipt messageReceipt)

This event is triggered when a set of messages are marked as delivered for any particular conversation.

onMessagesRead(MessageReceipt messageReceipt)

This event is triggered when a set of messages are marked as read for any particular conversation.

onMessageEdited(BaseMessage message)

This method is triggered when a particular message has been edited in a user/group conversation.

onMessageDeleted(BaseMessage message)

This event is triggered when a particular message is deleted in a user/group conversation.

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 => {
      console.log("Text message received successfully", textMessage);
    },
    onMediaMessageReceived: mediaMessage => {
      console.log("Media message received successfully", mediaMessage);
    },
    onCustomMessageReceived: customMessage => {
      console.log("Custom message received successfully", customMessage);
    },
    onMessagesDelivered: messageReceipt => {
      console.log("Message Delivered", messageReceipt);
    },
    onMessagesRead: messageReceipt => {
      console.log("Message Read", messageReceipt);
    },
    onTypingStarted: typingIndicator => {
      console.log("Typing Started", typingIndicator);
    },
    onTypingEnded: typingIndicator => {
      console.log("Typing Ended", typingIndicator);
    },
    onMessagesDeleted: message => {
      console.log("Message Delted", message);
    },
    onMessagesEdited: message => {
      console.log("Message Edited", message);
    }
  })
);

where UNIQUE_LISTENER_ID is the unique identifier for the listener. Please make sure that no two listeners are added with the same listener id as this could lead to unexpected behavior resulting in loss of events.

Once the MessageListener is not in use, you need to remove the listener using the removeMessageListener() method which takes the id of the listener to be removed as the parameter.


Did this page help you?