Installation

Overview

Kommunicate is live chat and chatbots powered customer support software. Kommunicate allows you to add customizable live chat SDK to your Android apps. It enables you to chat with your app users and customers through a customizable chat interface.

Installing Kommunicate in your Android app is easy and fast. We will walk you through the procedure so you can start answering your support queries within a few minutes.

Android sdk

Installation

Add the following in your app's(app level) build.gradle dependency:

dependencies {
//...
implementation 'io.kommunicate.sdk:kommunicateui:2.1.0'
}

NOTE: Kommunicate requires minimum Android SDK 16 or higher. Be sure to check if that is what you are using. You can find the minimum android SDK version in your app's build.gradle file, inside defaultConfig. The field is named as minSdkVersion.

Building with ProGuard

If you are using ProGuard in your application, then add the below rules to your proguard-rules.pro file:

#keep JSON classes                
-keep class * extends com.applozic.mobicommons.json.JsonMarker {
    !static !transient <fields>;
}

-keepclassmembernames class * extends com.applozic.mobicommons.json.JsonParcelableMarker {
    !static !transient <fields>;
}

#GSON Config          
-keepattributes Signature          
-keep class sun.misc.Unsafe { *; }           
-keep class com.google.gson.examples.android.model.** { *; }            
-keep class org.eclipse.paho.client.mqttv3.logging.JSR47Logger { *; } 
-keep class android.support.** { *; }
-keep interface android.support.** { *; }
-dontwarn android.support.v4.**
-keep public class com.google.android.gms.* { public *; }
-dontwarn com.google.android.gms.**
-keep class com.google.gson.** { *; }

Launch conversation

Kommunicate provides KmConversationBuilder class to create and launch conversation directly. This way, you can save the extra steps of authentication, creation, initialization and launch. Below are some examples of how you can customize the builder for launching a single conversation thread.

Visitors

If you would like to launch the conversation directly without making the user entering any details, then use the builder as below:

       new KmConversationBuilder(activityContext)
                   .launchConversation(new KmCallback() {
                        @Override
                        public void onSuccess(Object message) {
                            Log.d("Conversation", "Success : " + message);
                        }

                        @Override
                        public void onFailure(Object error) {
                            Log.d("Conversation", "Failure : " + error);
                        }
                    });

For the activityContext parameter you need to pass the activity context. One way to get it is the YourActivityName.this.

Parameter description:

Below are the description of the paramters used in the KmConversationBuilder. The parameters are passed as arguments in the methods.

ParameterParameter typeMethodDescription
activityContextActivitynew KmConversationBuilder(<activityContext>)Passed in the constructor. Only Activity Context is accepted. Exception is thrown otherwise
APP_IDStringsetAppId(<APP_ID>)Ignore if you have already initialized the SDK with APP_ID
kmUserKMUsersetKmUser(<kmUser>)If you have user details, you can pass them here. Ignore if you do not have user details.
withPreChatbooleansetWithPreChat(<withPreChat>)Pass true if you would like the user to fill the details (such as name, email and phone etc.) before starting the chat. If you already have user details, then you can pass false.
isSingleConversationbooleansetSingleConversation(<isSingleConversation>)Pass false if you would like to create new conversation every time a particular user starts a conversation. This is true by default which means only one conversation will open for the user every time the user starts a conversation.
conversationAssigneeStringOptional, Pass either the agentId or botId. The conversation created will skip the routing rules and will be assigned to this agent or bot. You also need to pass the agentId in agentIds array or botId in the botIds array, if you are using the conversationAssignee parameter
clientConversationIdStringOptional, Pass the unique id using which you can recognize the conversation. For e.g If you have a shopping app and each order has its specific conversation, the orderId of the order can be used as a clientConversationId. In this case everyId will have its specific conversation.
conversationTitleStringOptional, Pass the custom title for a conversation. Use this if you would like to display a custom title instead of the conversation assignee name.

If you want to create a new conversation every time then call .setSingleConversation(false) on the builder. Note that, if you are doing so, the conversation history will not be retained.

For all the parameters used with KmConversationBuilder, refer this section.

Note: If you have a different use-case and would like to customize the conversation creation, user creation and conversation launch, you can explore the docs further.

← TroubleshootingAuthentication →