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.

Components

• My Community

• Global feed

Usage

Create a Fragment

AmityNewsFeedFragment.newInstance().build()

Features

Usage

Create a Fragment

AmityMyCommunityPreviewFragment.newInstance().build()

Components

Usage

Create a Fragment

AmityCommunityHomePageFragment
           .newInstance()
           .build()

Components

Usage

Create a Fragment

AmityExploreFragment.newInstance().build()

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.

   Copy

   AmityGlobalFeedFragment.newInstance().build()

2. <newCustomPostRankingmethod> - the posts will be ranked according to a score-sorting mechanism. Refer to Custom Post Ranking for more information about this feature. You can retrieve your global feed sorted by ranking score with this code.

   Copy

   let viewController = AmityGlobalFeedViewController.makeCustomPostRanking()

Features

Usage

Create a Fragment

AmityRecommendedCommunityFragment.newInstance().build()

Features

Usage

Create a Fragment

AmityTrendingCommunityFragment.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

AmityCategoryPreviewFragment.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

Start an Activity

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

Create a Fragment

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

Features

Usage

Create a Fragment

AmityCommunityEditorFragment
    .newInstance(community or 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()

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

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

Features

Features

Features

Usage

Create a Fragment

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

Components

• Community feed

Features

Usage

Create a Fragment

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

Features

Features

Usage

Create a Fragment

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

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)

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()

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.

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.

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.

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)

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

Usage

Start an Activity

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

Create a Fragment

AmityUserProfileEditorFragment.newInstance().build()

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

Features

Usage

Create a Fragment

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

Features

Usage

Start an activity

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

Create Fragment

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

Features

How to use

AmityCommunityMemberSettingsFragment
          .newInstance(communutyId)
          .build()