Login Listeners

Guide to monitoring login and logout events using the CometChat iOS SDK CometChatLoginDelegate.

Quick Reference for AI Agents & Developers

• Set delegate: CometChat.logindelegate = self (conform to CometChatLoginDelegate)
• Delegate methods: onLoginSuccess(user:), onLoginFailed(error:), onLogoutSuccess(), onLogoutFailed(error:)
• Related: Authentication · Connection Status · Setup

CometChat SDK provides you with a mechanism to get real-time status whenever a user logs into CometChat or logs out from CometChat.

Login Listener provides you with the below 4 methods:

Delegate Method	Information
onLoginSuccess(user: User)	This method is triggered when the user successfully logs into the CometChat SDK. It returns an Object of the User loggedIn.
onLoginFailed(error: CometChatException?)	This method is triggered when the user could not successfully log into the CometChat SDK. It returns an Object of the CometChatException.
onLogoutSuccess()	This method is called when the user successfully logs out from the CometChat SDK. It does not return anything.
onLogoutFailed(error: CometChatException?)	This method is triggered when the user could not successfully log out of the CometChat SDK. It returns an Object of the CometChatException.

In order to use the Delegate methods you must add protocol conformance CometChatLoginDelegate as CometChat.logindelegate = self . Here is the example of CometChatLoginDelegate:

Swift

extension AppDelegate: CometChatLoginDelegate {

	func onLoginSuccess(user: User) {
       print("Login Success")
    }
    
    func onLoginFailed(error: CometChatException?) {
        print("Login Failed")
    }
    
    func onLogoutSuccess() {
        print("Logout Success")
    }
    
    func onLogoutFailed(error: CometChatException?) {
        print("Logout Failed")
    }
}

Objective C

@interface ViewController ()<CometChatConnectionDelegate>

@end

@implementation ViewController

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

- (void)onLoginSuccess(user : User) {
    
    NSLog(@"onLoginSuccess");
}

- (void)onLoginFailed(error : CometChatException) {
    
    NSLog(@"onLoginFailed");
}

- (void)onLogoutSuccess() {
    
    NSLog(@"onLogoutSuccess");
}

- (void)onLogoutFailed(error : CometChatException) {
    
    NSLog(@"onLogoutFailed");
}

---

Delegate Methods

onLoginSuccess(user: User)

This method is triggered when the user successfully logs into the CometChat SDK. It returns a User object containing all information about the logged-in user.

Sample Payloads

Request

Trigger: CometChat.login(UID:authKey:) or CometChat.login(authToken:)

Parameter	Type	Value
UID	String	"cometchat-uid-1"
authKey	String	"AUTH_KEY"

Success Response

Delegate Method: onLoginSuccess(user: User)

Parameter Type: User

Parameter	Type	Value
uid	String	"cometchat-uid-1"
name	String	"John Doe"
avatar	String	"https://data-us.cometchat.io/avatars/cometchat-uid-1.png"
link	String?	"https://example.com/profile/john"
role	String	"default"
metadata	[String: Any]	["department": "Engineering", "level": 5]
status	CometChat.UserStatus	0 (.online)
statusMessage	String?	"Available"
lastActiveAt	Double	1708934400.0
hasBlockedMe	Bool	false
blockedByMe	Bool	false
tags	[String]	["premium", "verified"]
deactivatedAt	Double	0.0
authToken	String?	"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
createdAt	Double?	1700000000.0
updatedAt	Double?	1708934400.0

Error Response

N/A — This delegate method only fires on success.

For login failures, see onLoginFailed(error:).

---

onLoginFailed(error: CometChatException?)

This method is triggered when the user could not successfully log into the CometChat SDK. It returns a CometChatException object with error details.

Sample Payloads

Request

Trigger: CometChat.login(UID:authKey:) with invalid credentials

Parameter	Type	Value
UID	String	"invalid_user"
authKey	String	"AUTH_KEY"

Success Response

N/A — This delegate method only fires on failure.

For login success, see onLoginSuccess(user:).

Error Response

Delegate Method: onLoginFailed(error: CometChatException?)

Parameter Type: CometChatException?

Parameter	Type	Value
errorCode	String	"ERR_UID_NOT_FOUND"
errorDescription	String	"The UID 'invalid_user' does not exist."
details	String?	"Verify the UID is registered in your CometChat app."

---

onLogoutSuccess()

This method is called when the user successfully logs out from the CometChat SDK. It does not return any data.

Sample Payloads

Request

Trigger: CometChat.logout()

Parameter	Type	Value
—	—	No request parameters

Success Response

Delegate Method: onLogoutSuccess()

Return Type: Void (no payload)

Parameter	Type	Value
—	—	This delegate method receives no parameters

Success is indicated by the method being called. CometChat.getLoggedInUser() will return nil after successful logout.

Error Response

N/A — This delegate method only fires on success.

For logout failures, see onLogoutFailed(error:).

---

onLogoutFailed(error: CometChatException?)

This method is triggered when the user could not successfully log out of the CometChat SDK. It returns a CometChatException object with error details.

Sample Payloads

Request

Trigger: CometChat.logout() when no user is logged in

Parameter	Type	Value
—	—	No request parameters

Success Response

N/A — This delegate method only fires on failure.

For logout success, see onLogoutSuccess().

Error Response

Delegate Method: onLogoutFailed(error: CometChatException?)

Parameter Type: CometChatException?

Parameter	Type	Value
errorCode	String	"ERR_NOT_LOGGED_IN"
errorDescription	String	"Cannot logout - no user is currently logged in."
details	String?	nil