Getting Started

This is a developers' guide for setting up Android Engagement SDK configuration for native Android apps. We will take you through the basic technical steps for configuration and show you how to send your first widgets and chat messages. We will also provide detailed samples and instructions for complete LiveLike integration.

Prerequisites

• An admin login and registered application on the Producer Suite
• Client ID - Used to initialize the SDK. To get your ClientID, register your application in the Producer Suite
• Minimum OS: Android 5.0
• Minimum Android SDK: Lollipop SDK 21

🚧

Android X Upgrade

The Android Engagement SDK has been migrated to Android X from 2.15 onwards

If you have any issues with the integration please reach out.

Installation

👍

Current Version is 2.93.4

Step 1
Add the JitPack repository to your build file

allprojects {
    repositories {
        ...
        maven { url 'https://jitpack.io' }
    }
}

<repositories>
  <repository>
    <id>jitpack.io</id>
      <url>https://jitpack.io</url>
  </repository>
</repositories>

resolvers += "jitpack" at "https://jitpack.io"

:repositories [["jitpack" { :url "https://jitpack.io" }]]

Step 2
Add the dependency

implementation 'com.livelike.android-engagement-sdk:engagementsdk:<<android-current-version>>'

<dependency>
  <groupId>com.livelike.android-engagement-sdk</groupId>
  <artifactId>engagementsdk</artifactId>
  <version> <<android-current-version>> </version>
</dependency>

libraryDependencies += "com.livelike.android-engagement-sdk" % "engagementsdk" % "<<android-current-version>>"

:dependencies [[com.livelike.android-engagement-sdk/engagementsdk " <<android-current-version>> "]]

📘

Artifact name

There has been some change in artifact name since version 2.17, Please make sure while upgrading the version, it matches exactly what mentioned above

Initialization

For this step, you will need your Client ID to initialize the Android Engagement SDK. See here to retrieve your Client ID.

Note: The LiveLike SDK generates a User Access Token whenever initialized. You can either choose to store it locally or persist it within your internal user database (although we have already managed it internally in the SDK). The access Token is stored locally which can be updated if the user uninstalls the application or clears data from application settings. This may result in higher MAUs([Monthly Active Users], so it is highly recommended to pass the accessToken delegate as a param on SDK init and store the accessToken for persistent users count.
See Profiles for more info.
We also recommend that you initialize the SDK as late as possible in your application - just before the user accesses the EngagementSDK features.

val engagementSDK = EngagementSDK(
            LIVELIKE_CLIENT_ID,
            applicationContext,
            object : ErrorDelegate() {
                override fun onError(error: String) {
                   
                }
            }, accessTokenDelegate = object : AccessTokenDelegate {
                override fun getAccessToken(): String? {
                    return getSharedPreferences(PREFERENCES_APP_ID, Context.MODE_PRIVATE).getString(
                        PREF_USER_ACCESS_TOKEN,
                        null
                    ).apply {
                        
                    }
                }

                override fun storeAccessToken(accessToken: String?) {
                    getSharedPreferences(PREFERENCES_APP_ID, Context.MODE_PRIVATE).edit().putString(
                        PREF_USER_ACCESS_TOKEN, accessToken
                    ).apply()
                }
            })

EngagementSDK engagementSDK = new EngagementSDK(
                LIVELIKE_CLIENT_ID,
                applicationContext, null, null,
                new AccessTokenDelegate() {
                    @Nullable
                    @Override
                    public String getAccessToken() {
                        return token;
                    }

                    @Override
                    public void storeAccessToken(@Nullable String accessToken) {
                     // store access token
                    }
                }
        );

Configure Your Layout

Now you have to configure your media page layout and declare containers for the Android Engagement SDK Widget and Chat views to live inside.

📘

Even though this guide makes use of both the chat and widget components, if desired it is possible to use only one of the components.

🚧

The width of the Widget view must be at least 292dp and the width of the Chat view must be at least 292dp.

Add the following to your layout XML

<com.livelike.engagementsdk.chat.ChatView
    android:id="@+id/chat_view"
    android:layout_width="0dp"
    android:layout_height="0dp"
    android:minWidth="292dp"
    app:displayUserProfile="true"
    app:layout_constraintTop_toTopOf="parent"
    app:layout_constraintStart_toStartOf="parent"
    app:layout_constraintEnd_toEndOf="parent"
    app:layout_constraintBottom_toBottomOf="parent"/>
            
<com.livelike.engagementsdk.widget.view.WidgetView
    android:id="@+id/widget_view"
    android:layout_width="0dp"
    android:layout_height="wrap_content"
    android:minWidth="292dp"                                               
    app:layout_constraintTop_toTopOf="parent"
    app:layout_constraintStart_toStartOf="parent"
    app:layout_constraintEnd_toEndOf="parent"/>

Notes:

• The displayUserProfile boolean property is used to control the display of the user profile bar above the chat input box.
• Properties of the view can be set via XML or programmatically.

Start a Content Session

A Content Session represents a user's subscription to a particular program (typically a live, linear TV show, game, or episode). To start a Content Session you will need a Program ID. Integrating teams are expected to create programs within the LiveLike system, either through the API or through the Producer Suite. The team should then copy the Program IDs into the relevant media metadata in their own systems so that content sessions can be started along with media playback.

How to retrieve a Program ID:

How to publish a widget:

Starting a Content Session

val contentSession = engagementSDK.createContentSession("<program-id >")
widget_view.setSession(contentSession)
chat_view.setSession(contentSession.chatSession)

LiveLikeContentSession session = engagementSDK.createContentSession("<program-id>");
WidgetView widgetView = findViewById(R.id.widgetView);
widgetView.setSession(session);
ChatView chatView = findViewById(R.id.chatView);
chatView.setSession(session);

Handling application going to background

When your application goes to background the Android Engagement SDK is still listening for new widgets to make sure the user doesn't lose any of the action when coming back.

If you want to disable this feature and assure the application remains dormant when backgrounded, you will need to Pause and Resume the Content Session.

// When going to background
contentSession.pause()

// When coming back from background 
contentSession.resume()

// When exiting your activity
contentSession.close()

// When going to background
contentSession.pause();

// When coming back from background 
contentSession.resume();

// When exiting your activity
contentSession.close();

📘

For SDK version 2.63 and above.

The setWidgetThemeViewAttribute earlier accessed from Content Session is now moved to Widget View and now can be accessed by widgetView.widgetViewThemeAttributes

The shouldDisplayedAvatar earlier accessed from Chat Session is now moved to Chat View and can be accessed by chatView.shouldDisplayAvatar = true

The setProfilePicUrl earlier accessed from Content Session, can now be accessed from sdk as sdk.updateChatUserPic(url)