Getting started

Learn how to add the OpenWeb SDK to your Android app.

The Android SDK enables you to create a fluent conversation experience in your Android app that fuels quality interactions with community and content and allows users to create valuable and engaging content. Benefits of the Android SDK include the following:

  • SSO support
  • Customizable Conversation appearance
  • Realtime moderation
  • Ability to continue a conversation started on your web pages

800

Mobile screenshots



Requirements

  • Android 6.0 (API level 23) or later
  • OpenWeb account
  • Android Studio


Add and initialize the Android SDK

To add a Conversation to your app, you must import the OpenWeb Android SDK and then configure your project.

Use the following steps to import the SDK from Maven:

  1. From within Android Studio, open your app.
  2. In the project build.gradle file, add the JitPack repository.
allprojects {
    repositories {
        ...
      maven { url "https://jitpack.io" }
    }
}
  1. In the app build.gradle file, add the com.github.SpotIM.spotim-android-sdk:spotim-sdk:1.17.3 dependency.

    πŸ“˜

    Be sure to use the correct code sample below. For Android 12 and above, a dependency constraint is required.

dependencies {
    ...
    implementation 'com.github.SpotIM.spotim-android-sdk:spotim-sdk:1.17.3'
        constraints {
        implementation('androidx.work:work-runtime:2.7.1') {
            because '''androidx.work:work-runtime:2.1.0 pulled from
                           play-services-ads has a bug using PendingIntent without
                           FLAG_IMMUTABLE or FLAG_MUTABLE and will fail in Apps
                           targeting S+.
                '''
    }
}
dependencies {
    ...
    implementation 'androidx.multidex:multidex:2.0.1'
    implementation 'com.github.SpotIM.spotim-android-sdk:spotim-sdk:1.17.0'
}
  1. In the AndroidManifest.xml file, add the permissions to use the Internet and to enable users to add images to comments from a camera or photo library.
  2. In onCreate() of the application class, initialize the OpenWeb SDK with your Spot ID. You can also initialize the OpenWeb SDK with a callback. The callback indicates if the initialization has been successful.
SpotIm.init(
    this,
    "SPOT_ID"
)
SpotIm.init(
    this,
    "SPOT_ID",
    object: SpotVoidCallback {
        override fun onSuccess(fragment: Fragment) {
            // All good...
        }

        override fun onFailure(exception: SpotException) {
            when(exception) {
                is SPServerErrorException -> { } // do something
                is SPNoInternetConnectionException -> { } // do something
                is SPSdkDisabeledException -> { } // do something
                else -> { } // do something 
            }
        }
    }
)



Next Step