Get Started

Configure and Initialize TapTalk.io Omnichannel Android SDK

Step 1: Install TapTalk.io SDK

To start, open your Android project and add the following repositories to your top-level build.gradle file.

Project build.gradle
allprojects {
    repositories {
        google()
        jcenter()
        maven { url 'https://jitpack.io' }
        maven { url "https://s3.amazonaws.com/repo.commonsware.com" }
    }
}

Then add the following dependency to your app-level build.gradle:

app module build.gradle
dependencies {
    implementation 'com.github.taptalk-io:taptalk.io-omnichannel-android:1.0.6'
}

app module build.gradle
android {
    
    ...
​
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

Step 2: Initialize TapTalkLive

In order to use TapTalkLive SDK, you must first initialize a TapTalkLive instance by passing the CONTEXT, APP_KEY_SECRET, CLIENT_APP_ICON, and CLIENT_APP_NAME assigned to your application to the init method as a parameter. Generally, initialization is implemented in the Application class in your project.

Application.java
TapTalkLive.init(
        CONTEXT, 
        APP_KEY_SECRET, 
        CLIENT_APP_ICON, 
        CLIENT_APP_NAME,
        new TapTalkLiveListener() {
            @Override
            public void onInitializationCompleted() {
                super.onInitializationCompleted();
            }
​
            @Override
            public void onCloseButtonInCreateCaseFormTapped() {
                super.onCloseButtonInCreateCaseFormTapped();
            }
​
            @Override
            public void onCloseButtonInCaseListTapped() {
                super.onCloseButtonInCaseListTapped();
            }
        });

Application.kt
TapTalkLive.init(
        CONTEXT, 
        APP_KEY_SECRET, 
        CLIENT_APP_ICON, 
        CLIENT_APP_NAME,
        object : TapTalkLiveListener() {
                    override fun onInitializationCompleted() {
                        super.onInitializationCompleted()
                    }
​
                    override fun onCloseButtonInCreateCaseFormTapped() {
                        super.onCloseButtonInCreateCaseFormTapped()
                    }
​
                    override fun onCloseButtonInCaseListTapped() {
                        super.onCloseButtonInCaseListTapped()
                    }
                })

Setup FileProvider in your application

To enable file transfer through chat messages, you need to define FileProvider in your application's AndroidManifest.xml file, under the <application> tag.

AndroidManifest.xml
<application
    android:name=".YourApplication"
    ...>
​
    <provider
        android:name="android.support.v4.content.FileProvider"
        android:authorities="${applicationId}.fileprovider"
        android:exported="false"
        android:grantUriPermissions="true">
        <meta-data
            android:name="android.support.FILE_PROVIDER_PATHS"
            android:resource="@xml/file_paths" />
    </provider>
​
</application>

Initialize Google Places API Key (Optional)

To enable location search result preview while sending location message, a Google Places API Key is required. To obtain the API key for your application, you can check the documentation provided by Google. To initialize, insert your obtained key using the initializeGooglePlacesApiKey() method after TapTalkLive SDK has completed its initialization.

TapTalkLive.initializeGooglePlacesApiKey(GOOGLE_MAPS_API_KEY);

TapTalkLive.initializeGooglePlacesApiKey(GOOGLE_MAPS_API_KEY)

Your key also needs to be defined in your application's AndroidManifest.xml file, under the <application> tag.

AndroidManifest.xml
<application
    android:name=".YourApplication"
    ...>
​
    <meta-data
        android:name="com.google.android.geo.API_KEY"
        android:value="GOOGLE_PLACES_API_KEY" />
​
</application>

Open TapTalk Omnichannel View

To open TapTalkLive's view UI for your application, you can use the openTapTalkLiveView method from the TapTalkLive class. This will open an activity containing a chat room list for your user, and will open a Create Case Form activity on top if the user is new or do not have any existing case.

YourActivity.java
TapTalkLive.openTapTalkLiveView(YourActivity.this);

YourActivity.java
TapTalkLive.openTapTalkLiveView(this@YourActivity)