All Real Time Delegates (Listeners)

Complete reference for all CometChat iOS SDK real-time delegates including User, Group, Message, and Call listeners.

AI Integration Quick Reference

• User delegate: CometChat.userdelegate = self (conform to CometChatUserDelegate) — onUserOnline(user:), onUserOffline(user:)
• Group delegate: CometChat.groupdelegate = self (conform to CometChatGroupDelegate) — member joined/left/kicked/banned events
• Message delegate: CometChat.messagedelegate = self (conform to CometChatMessageDelegate) — message received/edited/deleted/reaction events
• Call delegate (superseded): CometChat.calldelegate = self (conform to CometChatCallDelegate) — legacy incoming/outgoing call events; new apps use the Calls SDK’s CometChatCalls.addIncomingCallListener (Ringing)
• Login delegate: CometChat.addLoginListener(_:_:) (conform to CometChatLoginDelegate) — login/logout success/failure events
• Connection delegate: CometChat.addConnectionListener(_:_:) (conform to CometChatConnectionDelegate) — connection status events
• AI Assistant delegate: CometChat.addAIAssistantListener(_:_:) (conform to AIAssistantEventsDelegate) — AI events
• Related: User Presence · Receive Message · Ringing

CometChat provides 4 listeners (Delegates) viz.

1. User Delegate (Listener)
2. Group Delegate (Listener)
3. Message Delegate (Listener)
4. Call Delegate (Listener)

---

​

User Delegate Methods

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

Delegate 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.

In order to use the Delegate methods you must add protocol conformance CometChatUserDelegate as Shown Below:

Swift

extension ViewController : CometChatUserDelegate {

    func onUserOnline(user: User) {
      print(user.stringValue() + " status becomes online.")
    }

    func onUserOffline(user: User) {
      print(user.stringValue() + " status becomes offline.")
    }
}

Objective C

@interface ViewController ()<CometChatUserDelegate>

@end

@implementation ViewController

- (void)viewDidLoad {
    [super viewDidLoad];

    [CometChat setUserdelegate:self];
}

- (void)onUserOfflineWithUser:(User * _Nonnull)user {
    NSLog(@"%@ status becomes offline.",[user stringValue]);
}

- (void)onUserOnlineWithUser:(User * _Nonnull)user {

    NSLog(@"%@ status becomes online.",[user stringValue]);
}

@end

Do not forget to set your view controller as a CometChat delegate probably in viewDidLoad() as CometChat.userdelegate = self

---

​

Group Delegate Methods

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

Method	Information
onGroupMemberJoined(action: Action, joinedUser: User, joinedGroup: Group)	This method is triggered when a user joins any group. All the members present in the group will receive this event.
onGroupMemberLeft(action: Action, leftUser: User, leftGroup: 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: Action, kickedUser: User, kickedBy: User, kickedFrom: Group)	This method is triggered when a user is kicked from a group. All the members including the user receive this event
onGroupMemberBanned(action: Action, bannedUser: User, bannedBy: User, bannedFrom: Group)	This method is triggered when a user is banned from a group. All the members including the user receive this event
onGroupMemberUnbanned(action: Action, unbannedUser: User, unbannedBy: User, unbannedFrom: Group)	This method is triggered when a user is banned from a group. All the members of the group receive this event.
onGroupMemberScopeChanged(action: Action, updatedBy: User, updatedUser: User, scopeChangedTo: String, scopeChangedFrom: String, group: 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: Action, addedby: User, userAdded: User, addedTo: Group)	This method is triggered when a user is added to any group. All the members including the user himself receive this event.

You can receive live events related to groups. In order to receive group events, you must add protocol conformance CometChatGroupDelegate as shown below:

Swift

extension AppDelegate: CometChatGroupDelegate {

  func onGroupMemberJoined(action: ActionMessage, joinedUser: User, joinedGroup: Group) {
    print("\(joinedUser.name) joined the group \(joinedGroup.name).")
  }

  func onGroupMemberLeft(action: ActionMessage, leftUser: User, leftGroup: Group) {
    print("\(leftUser.name) left the group \(leftGroup.name).")
  }

  func onGroupMemberKicked(action: ActionMessage, kickedUser: User, kickedBy: User, kickedFrom: Group) {
    print("\(kickedUser.name) kicked from the group \(kickedFrom.name) by \(kickedBy.name).")
  }

  func onGroupMemberBanned(action: ActionMessage, bannedUser: User, bannedBy: User, bannedFrom: Group) {
    print("\(bannedUser.name) banned from the group \(bannedFrom.name) by \(bannedBy.name).")
  }

  func onGroupMemberUnbanned(action: ActionMessage, unbannedUser: User, unbannedBy: User, unbannedFrom: Group) {
    print("\(unbannedUser.name) unbanned from the group \(unbannedFrom.name) by \(unbannedBy.name).")
  }

  func onGroupMemberScopeChanged(action: ActionMessage, scopeChangeduser: User, scopeChangedBy: User, scopeChangedTo: String, scopeChangedFrom: String, group: Group) {
    print("\(scopeChangeduser.name) scope changed from \(scopeChangedFrom) to \(scopeChangedTo) by \(scopeChangedBy.name) in the group \(group.name).")
  }
}

Objective C

@interface ViewController ()<CometChatGroupDelegate>

@end

@implementation ViewController

- (void)viewDidLoad {
  [super viewDidLoad];
  [CometChat setGroupdelegate:self];
}

- (void)onGroupMemberBannedWithAction:(ActionMessage * _Nonnull)action bannedUser:(User * _Nonnull)bannedUser bannedBy:(User * _Nonnull)bannedBy bannedFrom:(Group * _Nonnull)bannedFrom {
  NSLog(@"Group member banned.");
}

- (void)onGroupMemberJoinedWithAction:(ActionMessage * _Nonnull)action joinedUser:(User * _Nonnull)joinedUser joinedGroup:(Group * _Nonnull)joinedGroup {
  NSLog(@"Group member joined.");
}

- (void)onGroupMemberKickedWithAction:(ActionMessage * _Nonnull)action kickedUser:(User * _Nonnull)kickedUser kickedBy:(User * _Nonnull)kickedBy kickedFrom:(Group * _Nonnull)kickedFrom {
  NSLog(@"Group member kicked.");
}

- (void)onGroupMemberLeftWithAction:(ActionMessage *)action leftUser:(User *)leftUser leftGroup:(Group *)leftGroup {
  NSLog(@"Group member left.");
}

- (void)onGroupMemberScopeChangedWithAction:(ActionMessage * _Nonnull)action scopeChangeduser:(User * _Nonnull)scopeChangeduser scopeChangedBy:(User * _Nonnull)scopeChangedBy scopeChangedTo:(NSString * _Nonnull)scopeChangedTo scopeChangedFrom:(NSString * _Nonnull)scopeChangedFrom group:(Group * _Nonnull)group {
  NSLog(@"Group member scope changed.");
}

- (void)onGroupMemberUnbannedWithAction:(ActionMessage * _Nonnull)action unbannedUser:(User * _Nonnull)unbannedUser unbannedBy:(User * _Nonnull)unbannedBy unbannedFrom:(Group * _Nonnull)unbannedFrom {
  NSLog(@"Group member unbanned.");
}

@end

Do not forget to set your view controller as a CometChat delegate probably in viewDidLoad() as CometChat.groupdelegate = self

---

​

Message Delegate Methods

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

Method	Information
onTextMessageReceived(textMessage: TextMessage)	This event is triggered when a Text Message is received.
onMediaMessageReceived(mediaMessage: MediaMessage)	This event is triggered when a Media Message is received.
onCustomMessageReceived(customMessage: CustomMessage)	This event is triggered when a Custom Message is received.
onTypingStarted(_ typingDetails: TypingIndicator)	This event is triggered when a user starts typing in a user/group conversation.
onTypingEnded(_ typingDetails: TypingIndicator)	This event is triggered when a user stops typing in a user/group conversation.
onTransisentMessageReceived(_ message: TransientMessage)	This event is triggered when a transient message is received.
onMessagesDelivered(receipt: MessageReceipt)	This event is triggered when a set of messages are marked as delivered for any particular conversation.
onMessagesRead(receipt: MessageReceipt)	This event is triggered when a set of messages are marked as read for any particular conversation.
onMessagesDeliveredToAll(receipt: MessageReceipt)	This event is triggered when messages are delivered to all participants in a group.
onMessagesReadByAll(receipt: MessageReceipt)	This event is triggered when messages are read by all participants in a group.
onMessageEdited(message: BaseMessage)	This method is triggered when a particular message has been edited in a user/group conversation.
onMessageDeleted(message: BaseMessage)	This event is triggered when a particular message is deleted in a user/group conversation.
onInteractiveMessageReceived(interactiveMessage: InteractiveMessage)	This event is triggered when an Interactive Message is received.
onInteractionGoalCompleted(_ receipt: InteractionReceipt)	This event is triggered when an interaction Goal is achieved.
onMessageReactionAdded(reactionEvent: ReactionEvent)	This event is triggered when a reaction is added to a message.
onMessageReactionRemoved(reactionEvent: ReactionEvent)	This event is triggered when a reaction is removed from a message.
onMessagePinned(message: BaseMessage)	Available since v4.1.9. This event is triggered when a message is pinned. Broadcast to everyone in the conversation. See Pin & Save Messages.
onMessageUnpinned(message: BaseMessage)	Available since v4.1.9. This event is triggered when a message is unpinned. Broadcast to everyone in the conversation.
onMessageSaved(message: BaseMessage)	Available since v4.1.9. This event is triggered when a message is saved. Private — reaches only the saving user’s other devices.
onMessageUnsaved(message: BaseMessage)	Available since v4.1.9. This event is triggered when a message is unsaved. Private — reaches only the saving user’s other devices.
onMessageModerated(_ message: BaseMessage)	This event is triggered when a message is moderated.
onAIAssistantMessageReceived(_ message: AIAssistantMessage)	This event is triggered when an AI Assistant message is received.
onAIToolResultMessageReceived(_ message: AIToolResultMessage)	This event is triggered when an AI Tool result message is received.
onAIToolArgumentsMessageReceived(_ message: AIToolArgumentMessage)	This event is triggered when an AI Tool arguments message is received.

In order to receive incoming messages, you must add protocol conformance CometChatMessageDelegate as shown below:

Swift

extension ViewController: CometChatMessageDelegate {

  func onTextMessageReceived(textMessage: TextMessage) {
    print("TextMessage received successfully.")
  }

  func onMediaMessageReceived(mediaMessage: MediaMessage) {
    print("MediaMessage received successfully.")
  }

  func onCustomMessageReceived(customMessage: CustomMessage) {
    print("CustomMessage received successfully.")
  }

  func onMessageEdited(message: BaseMessage) {
    print("Message edited successfully.")
  }

  func onMessageDeleted(message: BaseMessage) {
    print("Message deleted successfully.")
  }

  func onTypingStarted(_ typingDetails: TypingIndicator) {
    print("Typing started received successfully")
  }

  func onTypingEnded(_ typingDetails: TypingIndicator) {
    print("Typing ended received successfully")
  }

  func onTransisentMessageReceived(_ message: TransientMessage) {
    print("Transient message received.")
  }

  func onMessagesDelivered(receipt: MessageReceipt) {
    print("Messages delivered receipt received.")
  }

  func onMessagesRead(receipt: MessageReceipt) {
    print("Messages read receipt received.")
  }

  func onMessagesDeliveredToAll(receipt: MessageReceipt) {
    print("Messages delivered to all receipt received.")
  }

  func onMessagesReadByAll(receipt: MessageReceipt) {
    print("Messages read by all receipt received.")
  }

  func onInteractiveMessageReceived(interactiveMessage: InteractiveMessage) {
    print("InteractiveMessage received successfully.")
  }

  func onInteractionGoalCompleted(_ receipt: InteractionReceipt) {
    print("Interaction goal completed.")
  }

  func onMessageReactionAdded(reactionEvent: ReactionEvent) {
    print("Reaction added to message.")
  }

  func onMessageReactionRemoved(reactionEvent: ReactionEvent) {
    print("Reaction removed from message.")
  }

  func onMessageModerated(_ message: BaseMessage) {
    print("Message moderated.")
  }

  func onAIAssistantMessageReceived(_ message: AIAssistantMessage) {
    print("AI Assistant message received.")
  }

  func onAIToolResultMessageReceived(_ message: AIToolResultMessage) {
    print("AI Tool result message received.")
  }

  func onAIToolArgumentsMessageReceived(_ message: AIToolArgumentMessage) {
    print("AI Tool arguments message received.")
  }
}

Do not forget to set your view controller as a CometChat delegate probably in viewDidLoad() as CometChat.messagedelegate = self

---

​

Call Delegate Methods

Superseded. CometChatCallDelegate, CometChat.calldelegate and addCallListener(_:_:) are no longer the way calls announce themselves, and a coming Chat SDK release marks them deprecated together with the Chat SDK’s other calling methods. Calls now ring through the Push Notifications SDK (PushKit and CallKit) and announce themselves on the Calls SDK’s CometChatCalls.addIncomingCallListener (onIncomingCallReceived(call:), onIncomingCallEnded(call:reason:)), whether the call arrived by push to a killed app or while the app was running. The caller’s “answered” event is ParticipantEventListener.onParticipantJoined(participant:) on the prepared session. See Ringing and Migrating from Legacy Ringing. The section below is kept for apps still on the legacy flow.

The CometChatCallDelegate provides you with live events related to calls. Below are the callback methods provided by the CometChatCallDelegate.

Method	Information
onIncomingCallReceived(incomingCall: Call?, error: CometChatException?)	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(acceptedCall: Call?, error: CometChatException?)	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(rejectedCall: Call?, error: CometChatException?)	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(canceledCall: Call?, error: CometChatException?)	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(endedCall: Call?, error: CometChatException?)	This event is triggered when a call ended message is received. The details of the call can be obtained from the Call object received as the method parameter

In order to receive all call events, you must add protocol conformance CometChatCallDelegate as shown below:

Swift

extension ViewController: CometChatCallDelegate {

  func onIncomingCallReceived(incomingCall: Call?, error: CometChatException?) {
    print("Incoming call " + (incomingCall?.stringValue() ?? ""))
  }

  func onOutgoingCallAccepted(acceptedCall: Call?, error: CometChatException?) {
    print("Outgoing call accepted " + (acceptedCall?.stringValue() ?? ""))
  }

  func onOutgoingCallRejected(rejectedCall: Call?, error: CometChatException?) {
    print("Rejected call " + (rejectedCall?.stringValue() ?? ""))
  }

  func onIncomingCallCancelled(canceledCall: Call?, error: CometChatException?) {
    print("Cancelled call " + (canceledCall?.stringValue() ?? ""))
  }

  func onCallEndedMessageReceived(endedCall: Call?, error: CometChatException?) {
    print("Call ended " + (endedCall?.stringValue() ?? ""))
  }
}

Objective C

@interface ViewController ()<CometChatCallDelegate>

@end

@implementation ViewController

- (void)viewDidLoad {
  [super viewDidLoad];
  [CometChat setCalldelegate:self];
}

- (void)onIncomingCallCancelledWithCanceledCall:(Call * _Nullable)canceledCall error:(CometChatException * _Nullable)error {
  NSLog(@"Incoming call cancelled %@",[canceledCall stringValue]);
}

- (void)onIncomingCallReceivedWithIncomingCall:(Call * _Nullable)incomingCall error:(CometChatException * _Nullable)error {
  NSLog(@"Incoming call %@",[incomingCall stringValue]);
}

- (void)onOutgoingCallAcceptedWithAcceptedCall:(Call * _Nullable)acceptedCall error:(CometChatException * _Nullable)error {
  NSLog(@"Outgoing call accepted %@",[acceptedCall stringValue]);
}

- (void)onOutgoingCallRejectedWithRejectedCall:(Call * _Nullable)rejectedCall error:(CometChatException * _Nullable)error {
  NSLog(@"Outgoing call rejected %@",[rejectedCall stringValue]);
}

- (void)onCallEndedMessageReceivedWithEndedCall:(Call * _Nullable)endedCall error:(CometChatException * _Nullable)error {
  NSLog(@"Call ended %@",[endedCall stringValue]);
}

@end

Do not forget to set your view controller as a CometChat delegate probably in viewDidLoad() as CometChat.calldelegate = self

---

​

Login Delegate Methods

The CometChatLoginDelegate provides you with live events related to login and logout. Below are the callback methods provided by the CometChatLoginDelegate.

Method	Information
onLoginSuccess(user: User)	This event is triggered when a user successfully logs in.
onLoginFailed(error: CometChatException?)	This event is triggered when a login attempt fails.
onLogoutSuccess()	This event is triggered when a user successfully logs out.
onLogoutFailed(error: CometChatException?)	This event is triggered when a logout attempt fails.

In order to receive login/logout events, you must add protocol conformance CometChatLoginDelegate as shown below:

Swift

extension ViewController: CometChatLoginDelegate {

  func onLoginSuccess(user: User) {
    print("Login successful for user: " + user.stringValue())
  }

  func onLoginFailed(error: CometChatException?) {
    print("Login failed with error: " + (error?.errorDescription ?? "Unknown error"))
  }

  func onLogoutSuccess() {
    print("Logout successful")
  }

  func onLogoutFailed(error: CometChatException?) {
    print("Logout failed with error: " + (error?.errorDescription ?? "Unknown error"))
  }
}

To add the login listener:

CometChat.addLoginListener("unique_listener_id", self)

To remove the login listener:

CometChat.removeLoginListener("unique_listener_id")

---

​

Connection Delegate Methods

The CometChatConnectionDelegate provides you with live events related to the WebSocket connection status. Below are the callback methods provided by the CometChatConnectionDelegate.

Method	Information
connecting()	This event is triggered when the SDK is attempting to establish a connection.
connected()	This event is triggered when the SDK successfully establishes a connection.
disconnected()	This event is triggered when the SDK disconnects from the server.
onfeatureThrottled()	This event is triggered when a feature is throttled due to rate limiting.
onConnectionError(error: CometChatException)	This event is triggered when there is an error in the connection.

In order to receive connection events, you must add protocol conformance CometChatConnectionDelegate as shown below:

Swift

extension ViewController: CometChatConnectionDelegate {

  func connecting() {
    print("Connecting to CometChat...")
  }

  func connected() {
    print("Connected to CometChat")
  }

  func disconnected() {
    print("Disconnected from CometChat")
  }

  func onfeatureThrottled() {
    print("Feature throttled")
  }

  func onConnectionError(error: CometChatException) {
    print("Connection error: " + error.errorDescription)
  }
}

To add the connection listener:

CometChat.addConnectionListener("unique_listener_id", self)

To remove the connection listener:

CometChat.removeConnectionListener("unique_listener_id")

---

​

AI Assistant Events Delegate

The AIAssistantEventsDelegate provides you with live events related to AI Assistant features. Below are the callback methods provided by the AIAssistantEventsDelegate.

Method	Information
onAIAssistantEventReceived(_ event: AIAssistantBaseEvent)	This event is triggered when an AI Assistant event is received.

In order to receive AI Assistant events, you must add protocol conformance AIAssistantEventsDelegate as shown below:

Swift

extension ViewController: AIAssistantEventsDelegate {

  func onAIAssistantEventReceived(_ event: AIAssistantBaseEvent) {
    print("AI Assistant event received: " + event.stringValue())
  }
}

To add the AI Assistant listener:

CometChat.addAIAssistantListener("unique_listener_id", self)

To remove the AI Assistant listener:

CometChat.removeAIAssistantListener("unique_listener_id")

---

---

​

Offline listeners

With offline support enabled (SDK 4.2.0 or later), CometChatMessageDelegate also receives onMessagesSynced(_:). It fires after the SDK catches up on reconnect and carries updates to already-cached messages that changed while offline: reactions, edits, deletes and receipts. Messages that arrived while offline still come through the typed callbacks such as onTextMessageReceived.

Four more listeners report what the SDK does on the device rather than events from the server. Each is documented with examples on its own page.

Listener	What it reports	Details
OutboxListener	Every outbox transition, app-wide: a message queued, sent or failed	Send While Offline
SyncListener	Progress and outcome of each catch-up sync	Stay in Sync
OfflineCacheResetListener	The on-device cache was rebuilt, for example after the encryption key was lost	Encrypt the Cache
MediaDownloadListener	A background media download finished or failed	Media Caching

​

Next Steps

User Presence

Monitor user online/offline status

Receive Messages

Handle incoming messages in real time

Connection Status

Monitor the SDK connection state

Login Listeners

Listen for login and logout events