Authentication

Authentication — CometChat documentation.

Create User

Before you login the user, you must add the user to CometChat.

1. For proof of concept/MVPs: Create the user using the CometChat Dashboard.
2. For production apps: Use the CometChat Create User API to create the user when your user signs up in your app.

Sample Users

We have setup 5 users for testing having UIDs: cometchat-uid-1, cometchat-uid-2, cometchat-uid-3, cometchat-uid-4 and cometchat-uid-5.

Once initialization is successful, you will need to log the user into CometChat using the login() method.

We recommend you call the CometChat login() method once your user logs into your app. The login() method needs to be called only once.

The CometChat SDK maintains the session of the logged in user within the SDK. Thus you do not need to call the login method for every session. You can use the CometChat.getLoggedInUser() method to check if there is any existing session in the SDK. This method should return the details of the logged-in user. If this method returns null, it implies there is no session present within the SDK and you need to log the user into ComeChat.

Login using Auth Key

This simple authentication procedure is useful when you are in development.

Dart

String UID = "user_id"; // Replace with the UID of the user to login
String authKey = "AUTH_KEY"; // Replace with your App Auth Key

final user = await CometChat.getLoggedInUser();
if (user == null) {
  await CometChat.login(UID, authKey,
		onSuccess: (User user) {
			debugPrint("Login Successful : $user" );
		}, onError: (CometChatException e) {
			debugPrint("Login failed with exception:  ${e.message}");
		});
}

Parameter	Description
UID	The UID of the user that you would like to login
authKey	CometChat App Auth Key

After the user logs in, their information is returned in the User object.

Be sure to use the Auth Only API Key and not the Full Access API Key. This ensures that even if a malicious user reverse engineers your client code, they will only be able to log in to CometChat and not call any other APIs.

Login using Auth Token

This authentication procedure does not use the API Key directly in your client code ensuring that your API Key is not leaked even if the client code is reverse engineered.

1. Create a User via the CometChat API when the user signs up in your app.
2. Create an Auth Token via the CometChat API for the new user every time the user logs in to your app.
3. Pass the Auth Token to your client and use it in the login() method.

Dart

String authToken = "AUTH_TOKEN";
var user = await CometChat.getLoggedInUser(onSuccess: (_){}, onError: (_){});
if (user == null) {
   if(authToken!=null){
     await  CometChat.loginWithAuthToken(authToken,
                                         onSuccess: (User loggedInUser){
                                           debugPrint("Login Successful : $user" );
                                         }, onError: ( CometChatException e){
                                           debugPrint("Login failed with exception:  ${e.message}");
                                         });
   }
}

Parameter	Description
authToken
Auth Token of the user you would like to login

After the user logs in, their information is returned in the User object.

Logout

You can use the logout() method to log out the user from CometChat. We suggest you call this method once your user has been successfully logged out from your app.

Dart

CometChat.logout( onSuccess: ( successMessage) {
      debugPrint("Logout successful with message $successMessage");
    }, onError: (CometChatException e ){
      debugPrint("Logout failed with exception:  ${e.message}");
        }
    );