Getting Started

The LikeMinds Android Feed SDK empowers you to integrate personalized and engaging feeds into your Android application, enhancing user experiences and driving user engagement. This guide will walk you through the steps to get started with the LikeMinds Android Feed SDK and set up a dynamic feed in your application. Obtain the necessary API key from the LikeMinds dashboard.

Prerequisites

Before you begin, ensure that you have the following:

1. Kotlin Version: Your project's kotlin version should be greater than 1.6.0.
2. Minimun Android SDK Version: minSdk should be atleast 21.
3. Dependency Resolution Management: mavenCentral() and jitpack.io should be mentioned in dependencyResolutionManagement.

Step-by-Step Integration Guide

Follow these steps to integrate the LikeMinds Feed SDK into your Android application using MavenCentral:

Step 1 - Installation

Implement likeminds-feed-core project in your app level build.gradle.

dependencies {
    ...
    implementation 'community.likeminds:likeminds-feed-core:1.7.0'
}

note

Set dataBinding true in your app level build.gradle if not done already.

Now, sync the gradle before moving to next step.

Step 2 - Setup LikeMinds Feed

Initiate LMFeedCore in onCreate() method of the Application class using the following code:

Kotlin

val application = this
val theme = LMFeedTheme.SOCIAL_FEED
val enablePushNotifications = false
val deviceId = null
val domain = "ENTER YOUR DOMAIN HERE"
val lmFeedCoreCallback = null

LMFeedCore.setup(
    application = application,
    theme,
    enablePushNotifications = enablePushNotifications,
    deviceId = deviceId,
    domain = domain,
    lmFeedCoreCallback = lmFeedCoreCallback
)

Java

Application applicationInstance = this; // instance of your application
LMFeedTheme theme = LMFeedTheme.SOCIAL_FEED; // theme selected for your app
String domain = "ENTER YOUR DOMAIN HERE"; // your domain
boolean enablePushNotifications = false; // whether to enable push notifications or not
String deviceId = null; // id of the device
LMFeedAppearanceRequest appearanceRequest = new LMFeedAppearanceRequest.Builder().build(); // object of [LMFeedAppearanceRequest]
LMFeedCoreCallback coreCallback = null; // object of feed core callback

LMFeedCore.INSTANCE.setup(
    applicationInstance, // instance of the application
    theme,
    domain, // your domain
    enablePushNotifications, // enable push notifications
    deviceId, // device id
    appearanceRequest, // object of [LMFeedAppearanceRequest] to set appearance of Feed
    coreCallback // callback for various operations in SDK
);

VARIABLE	TYPE	DESCRIPTION	OPTIONAL
application	Application	Instance of your application class.
theme	LMFeedTheme	Theme selected for theme.
domain	String	Your domain url.	✔
enablePushNotifications	Boolean	Whether to enable push notifications or not	✔
deviceId	String	Unique Id of the device, if notifications are enabled	✔
lmFeedAppearance	LMFeedAppearanceRequest	Request object to set appearance of the Feed.	✔
lmFeedCoreCallback	LMFeedCoreCallback	Callback for various operations in SDK .	✔

Step 3 - Initiate User Session

You have successfully initiated the LMFeedCore. Now, you have to initiate a user session. Provide API Key directly to LikeMinds Feed SDK, which will be used to initiate a user session by calling LMFeedCore.showFeed().

Kotlin

val apiKey = "Your generated API key" // api key generated from the dashboard
val userName = "ENTER USER NAME" // name of the user
val userId = "ENTER USER ID" // id of the user
val context = this // instance of context

val successCallback = { response : UserResponse? ->
    //user session initiated successfully, write your logic here
    Unit
} // callback triggered when the initiate user call is successful

val failureCallback = { errorMessage ->
  Log.e("Example", errorMessage)
  Unit
} // callback triggered when the initiate user call fails

LMFeedCore.showFeed(
    context = context,
    apiKey = apiKey,
    uuid = userId,
    userName = userName,
    success = successCallback,
    error = failureCallback
)

Java

String apiKey = "Your generated API key"; // api key generated from the dashboard
String userId = "ENTER USER ID"; // id of the user
String userName = "ENTER USER NAME"; // name of the user
Context context = this;

LMFeedCore.INSTANCE.showFeed(
    context,
    apiKey,
    userId,
    userName,
    (UserResponse response) -> {
        // callback triggered when the initiate user call is successful, write your logic here
        return null;
    },
    (String error) -> {
        // callback triggered when the initiate user call fails
        Log.e("Example", error);
        return null;
    }
);

tip

For enhanced security, you can use Server Side User Authentication to initiate user sessions through your own server.

Step 4 - Navigation to the feed

Once you have initiated the user session, you can navigate the user to your Feed in the above mentioned successCallback to be passed in LMFeedCore.showFeed(). LikeMinds provide various Feed Themes to which you can navigate with the help of following code:

Social Feed

Kotlin

// pass this successCallback to LMFeedCore.showFeed()
val successCallback = { response : UserResponse? ->
  // inflate social feed fragment in your activity
  val containerViewId = R.id.frame_layout
  val fragment = LMFeedSocialFeedFragment.getInstance()

  val transaction = supportFragmentManager.beginTransaction()
  transaction.replace(containerViewId, fragment, containerViewId.toString())
  transaction.commit()
  Unit
} // callback triggered when the initiate user call is successful

Java

// pass this callback to LMFeedCore.showFeed()
(UserResponse response) -> {
    // callback triggered when the initiate user call is successful
    try {
        getSupportFragmentManager().beginTransaction().replace(R.id.frame_layout, new LMFeedSocialFeedFragment.getInstance(LMFeedType.UNIVERSAL_FEED))).commit();
    } catch (Exception e) {
        throw new RuntimeException(e);
    }
    // callback triggered when the initiate user call is successful, write your logic here
    return null;
}

Video Feed

Kotlin

// pass this successCallback to LMFeedCore.showFeed()
val successCallback = { response : UserResponse? ->
  // inflate video feed fragment in your activity
  val containerViewId = R.id.frame_layout
  val fragment = LMFeedVideoFeedFragment.getInstance()

  val transaction = supportFragmentManager.beginTransaction()
  transaction.replace(containerViewId, fragment, containerViewId.toString())
  transaction.commit()
  Unit
} // callback triggered when the initiate user call is successful

Java

// pass this callback to LMFeedCore.showFeed()
(UserResponse response) -> {
    // callback triggered when the initiate user call is successful
    try {
        getSupportFragmentManager().beginTransaction().replace(R.id.frame_layout, new LMFeedVideoFeedFragment.getInstance(LMFeedType.UNIVERSAL_FEED, null)).commit();
    } catch (Exception e) {
        throw new RuntimeException(e);
    }
    // callback triggered when the initiate user call is successful, write your logic here
    return null;
}

QnA Feed

Kotlin

// pass this successCallback to LMFeedCore.showFeed()
val successCallback = { response : UserResponse? ->
  // inflate qna feed fragment in your activity
  val containerViewId = R.id.frame_layout
  val fragment = LMFeedQnAFeedFragment.getInstance()

  val transaction = supportFragmentManager.beginTransaction()
  transaction.replace(containerViewId, fragment, containerViewId.toString())
  transaction.commit()
  Unit
} // callback triggered when the initiate user call is successful

Java

// pass this callback to LMFeedCore.showFeed()
(UserResponse response) -> {
    // callback triggered when the initiate user call is successful
    try {
        getSupportFragmentManager().beginTransaction().replace(R.id.frame_layout, new LMFeedQnAFeedFragment.getInstance(LMFeedType.UNIVERSAL_FEED)).commit();
    } catch (Exception e) {
        throw new RuntimeException(e);
    }
    // callback triggered when the initiate user call is successful, write your logic here
    return null;
}

That's it! You have successfully integrated the LikeMinds Feed SDK into your Android application. The next step would be to explore additional customization options or configurations provided by the SDK to tailor the feed to your application's needs.