Authentication

Overview

This section is dedicated to authenticate and authorize users to avail support chat in your android app. You can also get instruction to set and update user details such as pre-chat lead collection forms to get user's information before starting the chat, updating user details of an existing user and sending additional details as metadata along with user details.

Authorization

Note: You need to initialize Kommunicate Chat SDK before proceesing further. You can find the instrcutions in the Android Installation section.

You can authorize a user by using the below method:

        KMUser user = new KMUser();
        user.setUserId(<USER_ID>);  // You can set any unique user ID

Post this, call the method as described below:

Kommunicate.login(this, user, new KMLoginHandler() {
      @Override
      public void onSuccess(RegistrationResponse registrationResponse, Context context) {
            // You can perform operations such as opening the conversation, creating a new conversation or update user details on success
      }

      @Override
      public void onFailure(RegistrationResponse registrationResponse, Exception exception) {
            // You can perform actions such as repeating the login call or throw an error message on failure
      }
});

You can also add other optional custom fields such as emails, display name, contact number etc. to the user object:

       user.setDisplayName(<DISPLAY_NAME>); // Pass the display name of the user
       user.setPassword(<PASSWORD>);
       user.setImageLink(<IMAGE_URL>); // Pass the image URL for the user's display image
       user.setContactNumber(<PHONE_NUMBER>); // Pass the user's contact number 
       user.setEmail(<EMAIL_ID>); // Pass the email ID of the user

If at some point, you need to check if the user is logged in, you can use this code snippet:

KMUser.isLoggedIn(context){
      // A check for identifying whether the user is logged in  
}

If you want to get the user details of the logged in user, use this code snippet:

KMUser user = KMUser.getLoggedInUser(context);

Logging in as visitors

You might not have the details of all the users coming to chat. You can start the chat with a visitor by calling the below method from the SDK:

  Kommunicate.loginAsVisitor(this, new KMLoginHandler() {
      @Override
      public void onSuccess(RegistrationResponse registrationResponse, Context context) {
            // You can perform operations such as opening the conversation, creating a new conversation or update user details on success
      }

      @Override
      public void onFailure(RegistrationResponse registrationResponse, Exception exception) {
            // You can perform actions such as repeating the login call or throw an error message on failure
      }
  });

Passing on additional details as metadata

Sometimes, you may need to pass additional details for the user apart from the already existing properties of KMUser. You can pass the additional details in metadata of the KMUser object.

Map<String, String> metadata = new HashMap<>();
metadata.put("Department" , "Engineering"); // This is example data. You can set it according to the additional details you want to add
metadata.put("Designation" , "Software Engineer"); // This is example data
metadata.put("Team" , "Device Team"); // This is example data

kmUser.setMetadata(metadata);

Updating the details of logged in users

Once the user has logged in, you can still update some of their properties such as display name, image Url, contact number, metadata, and status.

First, create a KMUser object and set the property you want to update:

KMUser kmUser = new KMUser();
kmUser.setDisplayName(<NEW_DISPLAY_NAME>);
kmUser.setImageLink(<NEW_IMAGE_URL>);

Map<String, String> metadata = new HashMap<>();
metadata.put("Department" , "Mobility"); // This is an example of updating metadata.
metadata.put("Designation" , "Software Engineer II"); // This is an example of updating metadata.

kmUser.setMetadata(metadata);

Then call the below method in a background thread or Async task:

 UserService.getInstance(context).updateLoggedInUser(kmUser);