Authentication

Authorization

You need to initialise the Kommunicate SDK with your App ID obtained from dashboard before accessing any method. You can get the App ID by Signing up on Kommunicate dashboard:

Kommunicate.init(context, <your APP_ID>);

You can authorize a user as described below:

        KMUser user = new KMUser();
        user.setUserId("reytum_01");  //unique userId

Post this, call the method described below:

Kommunicate.login(this, user, new KMLoginHandler() {
      @Override
      public void onSuccess(RegistrationResponse registrationResponse, Context context) {
            //do something in on success
      }

      @Override
      public void onFailure(RegistrationResponse registrationResponse, Exception exception) {
            //do something in on failure
      }
});

You can also add other optional fields like emailId, displayName, contact number etc to the user object:

       user.setDisplayName("Keith Richards");
       user.setPassword("password");
       user.setImageLink(<image-url>);
       user.setContactNumber("9087654321");
       user.setEmail("keith@live.com");

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

KMUser.isLoggedIn(context){
      //user is logged in  
}

To get the user details of logged in user, use this code snippet:

KMUser user = KMUser.getLoggedInUser(context);

Logging in as visitor:

You can start a visitor's chat by calling the below method from the SDK.

  Kommunicate.loginAsVisitor(this, new KMLoginHandler() {
      @Override
      public void onSuccess(RegistrationResponse registrationResponse, Context context) {
            //do something in on success
      }

      @Override
      public void onFailure(RegistrationResponse registrationResponse, Exception exception) {
            //do something in on failure
      }
  });

Passing additional details:

Sometimes you would 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");
metadata.put("Designation" , "Software Engineer");
metadata.put("Team" , "Device Team");

kmUser.setMetadata(metadata);

Updating logged in user details:

Once the user has logged in, you can still update some of its properties like displayName, imageUrl, contactNumber, Metadata, and status. 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 link>);

Map<String, String> metadata = new HashMap<>();
metadata.put("Department" , "Mobility");
metadata.put("Designation" , "Software Engineer II");

kmUser.setMetadata(metadata);

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

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