Prerequisite

SDK supports Android 5.0 (API Level 21) and above

android {
    ...
    defaultConfig {
        minSDKVersion 21 // at least 21
    }
}

Installation

Add the Jitpack repository in your project level build.grade at the end of repositories:

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

Add the dependency in your module level build.grade. Find latest UIKit version at Changelog.

// add buildFeatures, compileOptions and kotlinOptions in android tag
android {

    buildFeatures {
        dataBinding = true
    }
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
    kotlinOptions {
        jvmTarget = JavaVersion.VERSION_1_8
    }
    
}
    
dependency {
implementation 'com.github.AmityCo.Amity-Social-Cloud-UIKit-Android:amity-uikit:x.y.z'
}

Managing Conflicting File Generation

In your app module's build.gradle , add the following packaging options.

android {
    ...
    packagingOptions {
        exclude 'META-INF/INDEX.LIST'
        exclude 'META-INF/io.netty.versions.properties'
    }
}

Code Obfuscation

By using our SDK, you can use the Android ProGuard tool to obfuscate, shrink, and optimize your code. Obfuscated code can be more difficult for other people to reverse engineer. ProGuard renames classes, fields, and methods with semantically obscure names and removes unused code. However, you need to add these configurations to your ProGuard rules when using our SDK.

-keep class com.ekoapp.ekosdk.** { *; }
-keep interface com.ekoapp.ekosdk.** { *; }
-keep enum com.ekoapp.ekosdk.** { *; }
-keep class com.amity.socialcloud.** { *; }
-keep interface com.amity.socialcloud.** { *; }
-keep enum com.amity.socialcloud.** { *; }

Limitation

UIKit provides already built UI elements in one page. You can change the appearances, such as color and typography in the global settings. However, UIKit does not allow you to replace these small components with other views. And you cannot modify the view hierarchy inside the page.

UIKIT allows the default behaviour to be overridden by custom logic

With UIKit you can customise some parts of the component

• Using your own navigation bar

Custom Post Rendering

UIKit provides default renderers for the core data types, text, image, and file. For custom post rendering, a map of data type and renderer can be registered and UIKit will refer to this map while rendering post component.

Usage

// To provide a custom renderer, implement an AmityPostRenderer
val customViewHolder = object : AmityPostRenderer {

    // Specify the dataType to be rendered by this renderer
    override fun getDataType(): String = "myapp.customtype"

    // Provide a layout of your viewHolder
    override fun getLayoutId(): Int = R.layout.custom_post

    // Provide a viewHolder that is subclassed from AmityPostContentViewHolder
    override fun createViewHolder(
        view: View
    ): AmityPostContentViewHolder {
        return MyCustomViewHolder(view)
    }

    // Choose whether to have a post header
    override fun enableHeader(): Boolean {
        return true 
    }

    // Choose whether to have a post footer 
    override fun enableFooter(): Boolean {
        return false
    }
}
    
 // Register the custom renderer    
AmityUIKitClient.socialUISettings.registerPostRenderers(listOf(customViewHolder))   

Post sharing settings

These settings allow you to control the "share" button visibility. The button appearance is based on the post origin and the destination that it can be shared to.

The are five possible targets that a post can be shared to

My feed - The post can be shared to my feed. This option will enable "Share to my timeline" menu when user clicks share button.

Public community - The post can be shared to any public community. This option will enable "Share to group" menu when user clicks share button.

Private community - The post can be shared to any private community. This option will enable "Share to group" menu when user clicks share button.

External - The post can be shared externally. This option will enable "More options" menu when user clicks share button.

Origin - The post can be shared within the community feed that it was created. If the post was created in either public or private community, this option will enable "Share to group" menu when user clicks share button.

There are four possible origins

My feed post - Posts that were created on my feed. By default, possible sharing targets are My feed, Public community, and Private community.

User feed post - Posts that were created on any other users' feed. By default, possible sharing targets are My feed, Public community, and Private community.

Public community feed post - Posts that were created on any public community. By default, possible sharing targets are My feed, Public community, and Private community.

Private community feed post - Posts that were created on any private community. By default, possible sharing target is Origin.

Usage

You can select a set of targets for each post origin.

// In your Application class

val mySharingSettings = AmityPostSharingSettings()


// Allow post created by logged-in user to be shared anywhere
mySharingSettings.myFeedPostSharingTarget 
        = listOf(AmityPostSharingSettings.values())
        
// Allow post created by any other user to be shared anywhere
mySharingSettings.userFeedPostSharingTarget 
        = listOf(AmityPostSharingSettings.values())  
        
// Allow post created by any other user to be shared anywhere
mySharingSettings.publicCommunityPostSharingTarget 
        = listOf(AmityPostSharingSettings.values())                  

// Ensure post created in private community cannot be shared elsewhere
mySharingSettings.privateCommunityPostSharingTarget 
        = listOf(AmityPostSharingSettings.originFeed)


AmityUIKitClient.socialUISettings.postSharingSettings = mySharingSettings
        

Post sharing events

Based on Post sharing settings, there are up to three post sharing events that can be emitted by UIKit.

Share to my timeline - an event emitted when a user clicks on "Share to my timeline" button.

Share to group - an event emitted when a user clicks on "Share to group" button.

Share externally - an event emitted when a user clicks "More options" button.

Usage

You can choose to intercept one or all of the events and apply your custom behaviors.

// In your Application class

// Ex. launch a share intent with post data
AmityUIKitClient.socialUISettings.feedEventHandler 
    = object : AmityPostShareClickListener {
            override fun shareToExternal(context: Context, post: EkoPost) {
                // generate a link 
                val sharingPost = "https://www.upstra.co/post?id=" + post.getPostId()
                // lauch an intent with the generated link
                val share = Intent.createChooser(Intent().apply {
                      action = Intent.ACTION_SEND
                      putExtra(Intent.EXTRA_TEXT, sharingPost)

                }, null)
                startActivity(share)
            }
        }

With our chat functionality in UIKit, you can find out how best to integrate and design messaging features and what they will look like in your app

UIKIT allows some parts of the component to be customized.

Limitation

UIKit provides already built UI elements in one page. You can change the appearances, such as color and typography in the global settings. However, UIKit does not allow you to replace these small components with other views. And you cannot modify the view hierarchy inside the page.

Requirements

• Android 5.0 (API level 21 or higher)

• Java 8

• AndroidX

• Material components

• Gradle 3.4.0 or higher

Implementation Strategies

The UIKit API provides several strategies to integrate with your application.

Page Presentation

• Use the UIKit, ready to use out of the box

• Integrate the Chat experience in the least amount of effort.

Page Presentation (Custom)

• Add a custom theme to the default implementation of the UIKit.

• Complete control of the visual style of Chat UI by implementing declarative styles (fonts and colors) for your user interface.

Page Integration

• Use key components from the UIKit SDK and integrate them directly into your application.

• Add the Chat UI to your existing design.

Key Concepts

Architecture

The UIKit is built on the foundation of the Amity Social Cloud API. We add a UI layer to speed product development efforts of your application. At the core, it is leveraging the same Channel, Messaging concepts, subscribing to live objects whilst adding a UIKit to accelerate product delivery and UI that delivers great user experience for companies wanting to deploy messaging and other functionality.

In the current state, there are two modules that can be used. You can follow the steps below. These two modules can be integrated into your application with ease using this documentation

To allow for more customization, we have now open sourced our UI Kits and deprecated the packaged UI Kit version that was previously available.

With open source, developers have more flexibility and greater customization options, allowing you to have complete control over the visual style. Open sourcing allows for more transparency and visibility, and enables contributions from a greater developer community in terms of good design, implementation, code improvement, and fixes, translating into a better product and development experience.

To ensure that you continue to receive the latest features and updates, we encourage you to migrate over to the open source version. This guide will help you:

• Migrate Android Open Source UI Kit with an existing project

• Modify Open Source UI Kit to customize the visual style

• Get latest Open Source UI Kit updates

Migrate Android Open Source UI Kit with Existing Project

Remove existing gradle dependency

If you've never used UI Kit from a gradle dependency before, you may skip this step and proceed to the next step. If you are migrating the UIKit with an existing gradle dependency, you will need to remove it from the gradle at the application level.

implementation 'com.github.AmityCo.Amity-Social-Cloud-UIKit-Android:amity-uikit:x.y.z'

Import UI Kit module to your existing project

• Clone or download source code from an open-source Github repository. https://github.com/AmityCo/Amity-Social-Cloud-UIKit-Android-OpenSource

• Navigate to your current application in Android Studio, then at the top navigation bar go to File > New > Import Module...

• Choose the source directory where you downloaded/cloned UI Kit source code.

• Make sure that you import :chat , :common, :social, and :amity-uikit module as per the screenshot described. The :sample module is optional and solely contains examples of UIKit Fragments and Activities.

• Navigate to the root project's settings.gradle file once the modules have been successfully imported. You may see that Android Studio generated a dependency path from the UI Kit source code directory you specified initially. However, there's a chance that Android Studio won't do so or may generate the incorrect path. Please double-check that the path is accurate.

• Additionally, in the root project's settings.gradle it's also mandatory to declare jitpack.io repository destination by adding maven { url https://jitpack.io } to dependencyResolutionManagement > repositories.

• Add the imported module to application's gradle file by adding:

implementation project(path: ':amity-uikit')

• Exclude these META-INF from the packaging options in application's gradle

 packagingOptions {
        exclude 'META-INF/INDEX.LIST'
        exclude 'META-INF/io.netty.versions.properties'
    }

• Lastly, apply this in the project-level build.gradle file. apply from: "../Amity-Social-Cloud-UIKit-Android/buildsystem/dependencies.gradle"

Woohoo! All set now you're ready to explore and modify our UI Kit in your application project.

Modifying Android Open Source UI Kit

You can modify the Android open source UI Kit to customize behaviors to fit your needs. To modify the code, simply copy and paste it into your local machine.

We recommend that you first fork the repository before starting any customization work, so that it will be easier to merge the code with the next version update that we provide from the main repository.

Reference on forking: https://docs.github.com/en/get-started/quickstart/fork-a-repo

Get Latest Open Source UI Kit Updates

To update to the latest version of the UI Kit, you can pull the latest commit of the git submodule.

cd Amity-Social-Cloud-UIKit-Android-OpenSource
git pull origin master
cd ..
git add .
git commit -m “Update android uikit opensource submodule”
git push origin branch_name

Using the default theme

UIKit uses the default theme as part of the design language.

Theme customization

The UIKit looks great without any customizations, though you can also edit the colors and fronts in the themes to suit your preferences all the same. However, if you wish to customize the theme, you can declare changes to both colors and typography.

Colors

UIKit uses a small set of declared colors to simplify the design task for developers. These colors are automatically rendered at appropriate shades to communicate states and interaction to the users.

Usage

Customize color theme by declaring color code to the specific color key.

colors.xml

<resources>
    <color name="amityColorPrimary">#1054DE</color>
    <color name="amityColorSecondary">#292B32</color>
    <color name="amityColorAlert">#FA4D30</color>
    <color name="amityColorHighlight">#1054DE</color>
    <color name="amityColorBase">#292B32</color>
    <color name="amityColorBaseInverse">#FFFFFF</color>
    <color name="amityMessageBubble">#1054DE</color>
    <color name="amityMessageBubbleInverse">#EBECEF</color>
</resources>

Overriding the default UIKit theme

When you integrate UIKit to your application, it applies the our customized theme to UIKit by default. This Amity.Base.Theme.AmityApp style extends a theme from our material based theme and includes overrides for styling attributes that are used by key UI elements. So you can quickly customize UIkit style by overriding the provided theme file and its attributes. Please note that all following attributes must be overriden.

For example, your styles.xml file should look similar to this:

    <!--     Override Amity UIKIT Theme, all of these attributes are mandatory. You could override them , but please don't remove any. Otherwise ui theme may be strange-->
    <style name="Amity.Base.Theme.AmityApp" parent="Amity.Base.Theme.MaterialThemeBuilder">
        <!--        Color of status bar-->
        <item name="android:statusBarColor">#000000</item>
        <!--        Light/dark theme of status bar-->
        <item name="android:windowLightStatusBar" tools:targetApi="23">false</item>
        <!--        Navigation bar color-->
        <item name="android:navigationBarColor">#000000</item>
        <!--        Global toolbar style-->
        <item name="toolbarStyle">@style/MyToolbarStyle</item>

        <!--        Primary accent color-->
        <item name="colorPrimary">@color/amityColorPrimary</item>
        <!--        Secondary accent color-->
        <item name="colorSecondary">@color/amityColorSecondary</item>
        <!--        Global background color-->
        <item name="android:colorBackground">@color/amityColorWhite</item>
        <item name="colorSurface">@color/amityColorWhite</item>

        <item name="colorError">@color/amityColorAlert</item>
        <item name="colorOnError">@color/amityColorWhite</item>
        <item name="android:actionMenuTextColor">@color/amityColorHighlight</item>

        <item name="materialAlertDialogTheme">@style/AmityAlertDialogTheme</item>
        <!--        Snackbar style-->
        <item name="snackbarStyle">@style/AmitySnackBarStyle</item>
        <!--        Search view style-->
        <item name="searchViewStyle">@style/AmitySearchViewStyle</item>

        <item name="shapeAppearanceSmallComponent">@style/Amity.ShapeAppearance.Theme.SmallComponent
        </item>
        <item name="shapeAppearanceMediumComponent">
            @style/Amity.ShapeAppearance.Theme.MediumComponent
        </item>
        <item name="shapeAppearanceLargeComponent">@style/Amity.ShapeAppearance.Theme.LargeComponent
        </item>
        <item name="bottomSheetDialogTheme">@style/Amity.ThemeOverlay.Theme.BottomSheetDialog</item>
    </style>

    <!--       Example of custom toolbar style, color is the only option can be customised here-->
    <style name="MyToolbarStyle" parent="Widget.MaterialComponents.Toolbar">
        <!--       Color of toolbar-->
        <item name="android:background">#3A3A3A</item>
    </style>

    <!--     Override Amity UIKIT text style in toolbar, all of these attributes are mandatory.
              You could override them but please don't remove any. Otherwise ui theme may be strange-->
    <style name="ToolBarLeftTextStyle">
        <!--     Please don't change width and height-->
        <item name="android:layout_width">0dp</item>
        <item name="android:layout_height">wrap_content</item>
        <!--     Text size of the toolbar title text-->
        <item name="android:textSize">@dimen/amity_text_size_title</item>
        <!--     Style of the toolbar title text-->
        <item name="android:textStyle">bold</item>
        <!--     Margin of the toolbar title text-->
        <item name="android:layout_marginStart">@dimen/amity_padding_m1</item>
        <!--     Text color of the toolbar title text-->
        <item name="android:textColor">#FFFF</item>
        <item name="android:maxLines">1</item>
        <item name="android:ellipsize">end</item>
        <item name="android:layout_marginEnd">@dimen/amity_padding_m1</item>
    </style>

    <!--     Override Amity UIKIT left icon in toolbar, all of these attributes are mandatory.
          You could override them but please don't remove any. Otherwise ui theme may be strange-->
    <style name="ToolBarLeftDrawableStyle">
        <!--     Please don't change width and height-->
        <item name="android:layout_width">wrap_content</item>
        <item name="android:layout_height">wrap_content</item>
        <!--     Color of the toolbar icon-->
        <item name="android:tint">#FFFF</item>
        <item name="android:layout_marginStart">@dimen/amity_padding_m2</item>
    </style>

Components

• Explore

• Newsfeed

Usage

Create a Fragment

AmityCommunityHomePageFragment
           .newInstance()
           .build()

Our UIKit provides the livestream recording feature that allows you to record livestreams and broadcast simultaneously in real-time. You can also play historical streams when the livestream ends.

This section describes the livestream recording feature in detail.

A livestream post can be viewed in the following feeds:

• Community feed

• User feed

• Global feed

• Content feed

You will be able to see the livestream post and interact with it as soon as the livestreamer starts streaming.

Creating a livestream post

To create a livestream post, follow these steps:

1. Create a livestream post by selecting Livestream from the pop-up and selecting a location where you want to post the stream.

2. Provide a title and description for your livestream. The title and description will be blank if you will not provide any.
3. Add a cover thumbnail from your media gallery for the livestream post and preview the cover image. This step however is optional. You may also update and delete the cover thumbnail.

4. Tap Go live to start streaming.
5. There will be a time indicator on the upper left. It will indicate how long it has been since the livestream started.

6. The livestream post will then show in the feed.

7. Tap Finish to end livestreaming. It will then show Ending livestream once the livestream has ended.

   Note: You have the option to edit or delete the post from the feed.

Viewing a livestream post

Live

Other viewers can watch your livestreaming while you are simultaneously recording it. They will see a LIVE indicator on the video.

Tapping the play button in the livestream post will play the video in a full screen mode.

Livestream ended

After ending your livestreaming, the playback video may not be available instantly for viewers to see while it is still in the process of producing the playback video. The viewers will see a message that the playback will be available for watching shortly.

Playback

When the playback video is already available for viewing, a RECORDED indicator is shown on the video post.

Idle state

The livestream may be in idle state. This happens when you delete the livestream in console or or other issues that will not enable the livestreaming to start. The viewer will see a message that the stream is currently unavailable.

Read-only mode

A livestream post will have the same privacy and access controls as with the other posts. This means that users without the permission, such as those who are not members of the community, won’t be able to view the livestreaming/playback video in a private community. If the community is public, non-members can view the post as read only so they won't be able to interact with it.

Permissions

If it's your first time creating a livestream, your device will prompt to allow access to your device's camera and microphone.

You need to allow access to be able to start a livestream. The pop-up below will not show once you allow access to your camera and microphone.

Features

Usage

Create a Fragment

AmityPostDetailFragment
         .newInstance(postId)
         .build()

Link Preview in Post

The Link Preview feature in posts is designed to enrich user experience by providing a visual and informative preview of external links. This feature enhances content sharing, making it more interactive and engaging. This feature significantly improves the user's posting experience. It allows for a preliminary check of the link's accuracy and relevance, adding visual appeal to the post with an informative preview.

When a user includes a link in a post, the feature automatically extracts and displays key information: the title, main image, and a short description, creating an informative preview of the linked content. If the link is unavailable, it will show a empty placeholder or error view instead.

Editing Capability

Users can edit the link preview even after the post is created. This flexibility ensures that the information remains up-to-date and accurate, enhancing the overall quality of the post.

Limitations and Use Cases

The preview feature is designed to only display images, titles, and descriptions after a post is created. This ensures clarity and relevance in the shared content.

Features

Usage

Create a Fragment

AmityMyCommunityPreviewFragment.newInstance().build()

Features

Usage

Create a Fragment

AmityCommunityFeedFragment
         .newInstance(community or communityId)
         .feedType(AmityFeedType.PUBLISHED) // optional, available from version 2.4
         .build(appcompatActivity)
                

Features

There are two views for the user profile page.

1. User's own profile

This view allows the user to see his own user profile detail and his own user feed. There are two states user can see.

Default state : Allows user to see his own following user counter and Follower user counter.

Request pending state : Allows user to see his own following user counter, Follower user counter, and also the follow request he received.

Components

• User feed (2.2)

You can get this view by using this code:

//Use as activity
val intent = AmityUserProfileActivity.newIntent(context, userId)
startActivity(intent)

//Use as fragment
AmityUserProfilePageFragment.newInstance(userId).build(context)

2. Other user's profile

This view allows the user to see other user's profile detail and their user feed. There are two states user can see.

In the other user view , UIKIT has two main views that support the Follow user connection and the User privacy view.

Default state: Allows user to see the connection between the current user and the target user profile.

If the current user is NOT connected to the viewing user and Private setting is Public

If the current user is connected to the viewing user and Private setting is Public

If the current user is NOT connected to the viewing user and Private setting is Private

If the current user has send request to the viewing user and Private setting is Private

Components

• User feed (2.2)

You can get this view by using this block of code

//Use as activity
val intent = AmityUserProfileActivity.newIntent(context, userId)
startActivity(intent)

//Use as fragment
AmityUserProfilePageFragment.newInstance(userId).build(context)

Features

How to use

AmityCommunityMemberSettingsFragment
          .newInstance(communutyId)
          .build()

Features

Usage

Create a Fragment

AmityUserFeedFragment
                .newInstance(user or userId)
                .build(activity)
                

User's Own Profile Setting Page

Other User's profile setting page

There are 2 main state based on the user connection:

If user is already connect with the target user

If user is not connected with the target user

You can try these codes:

//Use as activity
val intent = AmityUserSettingsActivity.newIntent(context, AmityUser)
startActivity(intent)

//Use as fragment
AmityUserSettingsFragment.newInstance(AmityUser).build(context)

Report User

user
.report()
.flag()
.subscribeOn(Schedulers.io())
.observeOn(AndroidSchedulers.mainThread())
.doOnComplete { //success }
.doOnError { //error }
.susbscribe()

UnReportUser

user
.report()
.unflag()
.subscribeOn(Schedulers.io())
.observeOn(AndroidSchedulers.mainThread())
.doOnComplete { //success }
.doOnError { //error }
.susbscribe()

UnFollow User

AmityCoreClient
.newUserRepository()
.relationship()
.me()
.unfollow(userId)
.subscribeOn(Schedulers.io())
.observeOn(AndroidSchedulers.mainThread())
.doOnComplete { //success }
.doOnError { //error }
.susbscribe()

User Profile Behavior

User's own profile

Other user's profile

Components

• User feed

Features

Usage

Create a Fragment

AmityUserProfilePageFragment
          .newInstnce(user or userId)
          .build(activity)

Customise components with Fragment builder

A delegate can be passed to customise the components.

Features

Usage

1. Create your own activity

2. Use any component from UIKit as a fragment

UIKit will insert the default option menus of the component if a toolbar is available in your activity

Features

Usage

Start an activity

val intent = Intent(this, AmityPostTargetPickerActivity::class.java)
startActivity(intent)

Create Fragment

AmityPostTargetPickerFragment.newInstance().build(postCreationType: String)

Custom Event Handler

UIKit emits events that can be intercepted and processed by custom logic.

For example, you might want to know when a user taps a user avatar. You can intercept onClickUserAvatarevent and define your desired behavior.

Supported events

When a user clicks on the user profile avatar at the post creator area, UIKit will open User profile page

However, you can intercept the event and define your own logic following the example below.

Usage

When you create a Fragment via a Builder, you can add your own logic via onClickUserAvatar method.

EkoGlobalFeedFragment
        .Builder()
        .onClickUserAvatar(object : IAvatarClickListener {
            override fun onClickUserAvatar(user: EkoUser) {
                // your custom logic
            }
        })
        .build(this)

In the FOLLOWING page, you will see the list of other users that you're following. In the FOLLOWERS page, you will see a list of users who are following you.

Features

Usage

Start an Activity

val intent = AmityEditUserProfileActivity.newIntent(this)
startActivity(intent)

Create a Fragment

AmityUserProfileEditorFragment.newInstance().build()

Features

Usage

Create a Fragment

class MainActivity : AppCompatActivity(), IRecentChatItemClickListener {

   override fun onCreate(savedInstanceState: Bundle?) {
       super.onCreate(savedInstanceState)
       setContentView(R.layout.activity_main)

      val recentChatFragment = AmityRecentChatFragment.newInstance()
      /**
         * set the listener to override recentItem click event
         * No Need to implement [IRecentChatClickListener] if you don't want to override click event
         */
      .recentChatItemClickListener(this)
      .build(this)
        val transaction = supportFragmentManager.beginTransaction()
        transaction.replace(R.id.fragmentContainer, recentChatFragment)
        transaction.addToBackStack(null)
        transaction.commit()
   }
}

Message List Page Header

Message List

Message bubble - Text message bubble

Message bubble - Image message bubble

Image Preview Page

Message Bubble - Audio Message Bubble

Audio message recorder

Edit Text Message Page

Usage

Start an Activity

If you don’t need to do any customisation other than global theme customisation, you can use our AmityMessageListActivity. Use the intent to move from one activity to the AmityChatHomePageActivity as follows:

//replace "channelId" with actual channelID
val messageIntent = AmityMessageListActivity.newIntent(this, "channelId")
startActivity(messageIntent)

Create a Fragment

If you need to customize the user interface, you can use our AmityChatRoomFragment.

class MainActivity : AppCompatActivity() {

   override fun onCreate(savedInstanceState: Bundle?) {
       super.onCreate(savedInstanceState)
       setContentView(R.layout.activity_main)

        val chatRoomFragment = AmityChatRoomFragment
                                .newInstance("channelId")
                                .composeBar(AmityChatRoomComposeBar.TEXT)
                                .enableChatToolbar(boolean)
                                .enableConnectionBar(boolean)
                                .build(activity)
       
        val transaction = supportFragmentManager.beginTransaction()
        transaction.replace(R.id.fragmentContainer, chatRoomFragment)
        transaction.addToBackStack(null)
        transaction.commit()
   }
}

Toolbar Option

We provide an ability to enable or disable Chatroom's toolbar by using enableChatToolbar(boolean) when initializing a fragment instance.

By default the UIKit comes with toolbar enabled.

AmityChatRoomFragment.newInstance(channelId)
            .enableChatToolbar(boolean)
            .build(this)

Connection Bar Option

We provide an ability to enable or disable Chatroom's connection bar by using enableConnectionBar(boolean) when initializing a fragment instance.

By default the UIKit comes with connection bar enabled.

AmityChatRoomFragment.newInstance(channelId)
            .enableConnectionBar(boolean)
            .build(this)

Compose bar Option

There are two compose bar options avaialble in the UIKit.

1. AmityChatRoomComposeBar.DEFAULT - has full functionalities including text, audio, and image message sending

2. AmityChatRoomComposeBar.TEXT - has simple functionalities which are only limited to text message sending

By default the UIKit comes with AmityChatRoomComposeBar.DEFAULT.

AmityChatRoomFragment.newInstance(channelId)
            .composeBar(AmityChatRoomComposeBar.TEXT)
            .build(this)

Our community group functionality within UIKit allows you to explore social features and see how they will look in your app.

Compatibility

We are always working to enhance our existing UIKit. As a result, the minimum compatibility may vary for our previous version releases. Below is the compatibility list for our latest release. For a complete compatibility history of any given UIKit version, you may refer to our changelogs.

• Amity-Social-Cloud-SDK - 5.14.0

• Glide - 4.12.0

• OKHTTP3 - 4.9.0

• Retrofit2 - 2.50

• Android Paging Data Library - 3.0.1

• Room - 2.4.0-alpha04

• RxJava2 - 2.3.10

• Gson - 2.8.10

• Kotlin-std-lib - 1.5.10

• Kotlin-coroutines - 1.5.0

• Exo Player - 2.12.1

• HiveMQ mqtt client - 1.2.2

Initialize the SDK

Before using the SDK, you need to initialize the SDK with your API key. Please find your account API key in Amity Social Cloud Console.

After logging in Console:

1. Click Settings to expand the menu.

2. Select Security.

3. In the Security page, you can find the API key in the Keys section.

class SimpleApp : Application() {

    override fun onCreate() {
        super.onCreate()

        AmityCoreClient.setup(
            apiKey = "apiKey", 
            httpEndpoint = AmityRegionalEndpoint.EU,  // optional param, defaulted as SG region 
            socketEndpoint = AmityRegionalEndpoint.EU // optional param, defaulted as SG region 
        )
    }
}

Specify Endpoints Manually (Optional)

You can specify endpoints manually via optional parameters. API endpoints for each data center are different so you need to adjust the endpoint accordingly.

We currently support multi-data center capabilities for the following regions:

Authentication

You must first register the current device with a userId. A device registered with a userId will be permanently tied to that userId until you deliberately unregister the device, or until the device has been inactive for more than 90 days. A device registered with a specific userId will receive all messages belonging to that user.

Usage

Start an Activity

val intent = Intent(this, AmityCommunityHomePageActivity::class.java)
startActivity(intent)

Create a Fragment

class MyCommunityHomeActivity: AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_my_community_home)
        if(savedInstanceState == null) {
            val fragmentManager = supportFragmentManager
            val fragmentTransaction = fragmentManager.beginTransaction()
            val fragment = createCommunityHomeFragment()
            fragmentTransaction.replace(R.id.fragmentContainer, fragment)
            fragmentTransaction.commit()
        }
    }

    private fun createCommunityHomeFragment(): Fragment {
        return AmityCommunityHomePageFragment.Builder().build(activity)
    }
}

Introduction

Our Chat UIKit and Social UIKit for Amity Social Cloud is a development kit with a user interface to enable fast integration of standard Amity Chat and Amity Social features into new or existing applications. Themes allow you to apply your style through colors and fonts.

We have now open sourced Amity UIKit so you will have complete control of the visual style of your Chat and Social application with endless customizations. Amity UIKit open source is now available in our Github repository.

To customize Amity UIKit open source, download the source code and apply the customizations in the forked source code. Once you fork our UIKit source code separately, you basically own the product so you are free to customize and build it for your specific use cases.

We recommend that you use Amity UIKit open source when:

1. The standard UIKit is not applicable to your use case .

2. You want to use an Amity Chat or Social SDK feature which is not yet supported in our standard UIKit.

Please note that we will extend only a limited support once you customize our UIKit open source since we won’t be able to fully know your code once you fork it.

Documentation

We are using the Amity UIKit open source wiki for any documentation related to Amity UIKit open source.

For our standard UIKit, you can refer to the documentation here.

Community guidelines

If you would like to suggest improvements on the source code, you can submit a pull request. If you find bugs or would like to request features, you can create an issue. Please note that not all changes and requests will be approved but they will be assessed in due course.

For more information on these guidelines, you may refer to the Amity UIKit open source wiki or you may go directly to these related pages:

• Customizing Amity UIKit Open Source

• Contributing to Amity UIKit Open Source

• Submitting fixes and feature requests

Benefits

• Easy Installation

• Fully-featured chat experience with minimal coding

• Customize targeted UX flows, specific views and respond to user interactions to tailor a user experience for just your application

Components

Usage

Create a Fragment

Features

Usage

Create a Fragment

You can use either of these two methods:

1. build - the posts will be ranked in chronological order. Below is the sample code.

Features

Usage

Create a Fragment

AmityRecommendedCommunityFragment.newInstance().build()

Components

• My Community

• Global feed

Usage

Create a Fragment

AmityNewsFeedFragment.newInstance().build()

Features

Usage

Start an Activity

val intent = Intent(this, AmityCategoryListActivity::class.java)
startActivity(intent)

Create a Fragment

AmityCategoryListFragment.newInstance().build(activity)

Features

Usage

Create a Fragment

AmityTrendingCommunityFragment.newInstance().build()

Features

Usage

AmityMyCommunityFragment
    .newInstance()
    .enableSearch(true) // seach view to search community
    .showOptionsMenu(true) // option menu to create community in toolbar
    .build()

Features

Usage

Create a Fragment

AmityCategoryPreviewFragment.newInstance().build()

Features

Usage

Start an Activity

val intent = AmityCategoryCommunityListActivity.newIntent( this, category)
startActivity(intent)

Create a Fragment

AmityCategoryCommunityListFragment
            .newInstance()
            .category(category)
            .build()

Features

Usage

Create a Fragment

AmityPostEditorFragment()
        .newInstance(postId)
        .build()

Features

Usage

Create a Fragment

AmityCommunityEditorFragment
    .newInstance(community or communityId)
    .build(activity)

Components

• Community feed

Features

Usage

Create a Fragment

AmityCommunityPageFragment()
          .newInstance(communityId)
          .build(activity)

Feature and Component

Usage

Start an Activity

val intent =  Intent(this, AmityCommunityCreatorActivity::class.java)
startActivity(intent)

Create a Fragment

AmityCommunityCreatorFragment.newInstance().build()

Types of Post Creations:

Text

Text and Images

User can select images from 2 sources.

Device Camera

Device Image Gallery

Text and Files

Text and Videos

Polls

Livestream

To create a live stream post and for a detailed discussion on the live stream features, refer to Livestream post documentation.

Features

Usage

Create a Fragment

User can create a post either on a community feed or user's own feed.

Attachment options

We currently support three types of attachment option when creating a post. These are:

1. AmityPostAttachmentItem.PHOTO

2. AmityPostAttachmentItem.VIDEO

3. AmityPostAttachmentItem.FILE .

You can optionally choose to allow these attachment options by using the method allowPostAttchments. By default the fragment includes all attachment options.

Create a post on community feed

//for text, image, file, video post
AmityPostCreatorFragment.newInstance()
    .onCommunityFeed(community or communityId)
     //optional
     .allowPostAttachments(
           listOf(
                   AmityPostAttachmentOptionItem.PHOTO,
                   AmityPostAttachmentOptionItem.VIDEO,
                   AmityPostAttachmentOptionItem.FILE
               )
           )
    .build()
    
//for poll post    
AmityPollPostCreatorFragment.newInstance()
    .onCommunityFeed(community or communityId)
    .build()

Create a post on user's own feed

//for text, image, file, video post
AmityPostCreatorFragment.newInstance()
     .onMyFeed()
     //optional
     .allowPostAttachments(
           listOf(
                   AmityPostAttachmentOptionItem.PHOTO,
                   AmityPostAttachmentOptionItem.VIDEO,
                   AmityPostAttachmentOptionItem.FILE
               )
           )
     .build()
   
//for poll post      
AmityPollPostCreatorFragment.newInstance()
     .onMyFeed()
     .build()

Features

Default User Feed

This view allows user to view and interact with the feed content normally. This also applies when the Privacy setting is Public.

Private User Feed

This view block any user to see the target user feed content. This view only exist if the Private setting is Private.

Features

Usage

Create a Fragment

AmityUserFeedFragment
                .newInstance(user or userId)
                .build(activity)

In this page, user can see all the follow request he has received. He can either accept or decline the request as well.

Components

Usage

Create a Fragment

Customize Components with Fragment Builder

A delegate can be passed to customize the components.

Features

Usage

Create a Fragment

AmityMemberPickerFragment
            .newInstance()
            .selectedMembers(memberList)
            .build()

Usage

Chat home page

Chat home page shows a list of the most recent chats.

Start an Activity

val chatIntent  = Intent(this, AmityChatHomePageActivity::class.java)
startActivity(chatIntent)

Create a Fragment

class MainActivity : AppCompatActivity(), IRecentChatItemClickListener {

   override fun onCreate(savedInstanceState: Bundle?) {
       super.onCreate(savedInstanceState)
       setContentView(R.layout.activity_main)

       val chatHomeFragment = AmityChatHomePageFragment.Builder()
       /**
         * set the listener to override recentItem click event
         * No Need to implement [IRecentChatClickListener] if you don't want to override click event
         */
       .recentChatItemClickListener(this)
       .build(this)
       
        val transaction = supportFragmentManager.beginTransaction()
        transaction.replace(R.id.fragmentContainer, chatHomeFragment)
        transaction.addToBackStack(null)
        transaction.commit()
   }
}

Text Message Bubble

Image Massage Bubble

Audio Message Bubble

Usage

To customize message bubble, implement AmityMessageListAdapter.CustomViewHolder and pass a custom ViewHolder for the corresponding message type.

class MainActivity : AppCompatActivity(), AmityMessageListAdapter.CustomViewHolder {

   override fun onCreate(savedInstanceState: Bundle?) {
       super.onCreate(savedInstanceState)
       setContentView(R.layout.activity_main)
       
        /**
         * Implement [AmityMessageListAdapter.CustomViewHolder] if customization is required for messageViews
         * set the customView listener using [AmityChatRoomFragment] instance
         */
       val chatRoomFragment = AmityChatRoomFragment
                                .newInstance("channelId")
                                .enableChatToolbar(boolean)
                                .customViewHolder(this)
                                .build(this)
        
        val transaction = supportFragmentManager.beginTransaction()
        transaction.replace(R.id.fragmentContainer, messageListFragment)
        transaction.addToBackStack(null)
        transaction.commit()
   }
}

Override method getViewHolder() to pass a custom ViewHolder

override fun getViewHolder(
        inflater: LayoutInflater,
        parent: ViewGroup,
        viewType: Int
    ): AmityChatMessageBaseViewHolder? {
        return when(viewType) {
            MessageType.MESSAGE_ID_TEXT_RECEIVER -> TextReceiverViewHolder(
                inflater.inflate(R.layout.custom_item_text_receiver, parent, false), EkoChatMessageBaseViewModel())
            MessageType.MESSAGE_ID_TEXT_SENDER -> TextSenderViewHolder(
                inflater.inflate(R.layout.custom_item_text_sender, parent, false), EkoChatMessageBaseViewModel()
            )
            //pass null for all the types where no customisation is required
            //Default UIKIT Ui will be rendered for all those types
            else -> null
        }
    }