Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Feature
Description
Search communities
Input the name of the community you want to search. Clicking the community from the returned list will take you to the community's profile page.
There are many components that you can use and integrate into your existing application.
Amity UIKit provides already built UI elements on a single page. You can change the appearance such as color and typography in the global settings. However, the UIKit does not allow you to replace these small components with other views. In addition, you cannot modify the view hierarchy inside the page.
Show community feeds, search, or create new communities
The community section consists of three components:
Explore recommended and trending communities
This page consists of three components:
Feature
Description
Global feed
Scroll vertically to see a list of posts in your global feed
Custom post ranking
The posts will be ranked according to a score-sorting mechanism.
Refer to Custom Post Ranking for more information about this feature.
Feature | Description |
Recommended Community list | A visual list of communities with the highest member count. The communities in the list are those where you are not a member yet. |
Navigation to Community profile |
Select a community to go to its
Feature
Description
Top trending
Community list
Visual list of communities with the highest number of members. It can be a combination of communities where you may or may not be a member of.
Navigation to Community profile
Select a community to go to its Community Profile page.
Feature
Description
Category list
You can see categories sorted in alphabetical order. Clicking the < > navigation buttons will let you explore the entire categories list.
Navigation to Community list by category
Select a category to see all the communities listed under the selected category
Feature | Description |
My Community list | Scroll vertically to see a list of communities that you joined sorted in alphabetical order. |
Navigation to Community profile page |
Community creation |
Select a community to go to the
Click Create Community and the pop-up will show so you can input the details of the community that you will create
Community creation
Create a community by providing information in the required fields. Click Create to submit.
Feature
Description
Community list by category
List of all communities that belong to the selected category sorted in alphabetical order
Navigation to Community Profile page
Select a community to go to the Community Profile page
Feature
Description
Edit profile page
Access to the Community Profile Edit page
Community Members page
Access to the Community member page
Permissions page
Access to the Permissions page
Navigation to Community Profile
Navigates back to the community profile page
Note:
Please note that navigating back does not automatically save changes. You must manually save your edits using the Save button.
This section provides a form for post creation
Creating a text and image post
After posting a text and image post
Creating a text and file post
After posting a text and file post
Creating a text and video post
After posting a text and video post
Default poll creation page
Poll post
Poll voting
Mention users in a poll post
You can create a live stream post in the console.
You cannot create a live stream post via Web UIKit but you can view live stream videos using Web UIKit's live stream viewer. Refer to our Live Stream post documentation for details on how to view a live stream post.
Mention users in a livestream post
See community interaction as it happens
Out Web 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 viewing feature in detail. Refer to our Livestream documentation to create a livestream in console.
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 can be done in Console. There are two parts before you can create the livestream post. First, create the livestream. You need to have a third-party software installed such as OBS or any livestreaming tool. Then, create the post.
In Console, go to Livestream menu.
In Streaming management page, click .
In Create new stream pop-up, provide the title, description, and thumbnail.
Click OK to submit.
In Streaming management list, select the stream that you created.
In Streaming details page, copy the Server URL. Paste it in your livestreaming software and start the livestream.
In Console, go to Posts menu.
In Create livestream post pop-up, provide the Target type, Target ID, and Stream ID.
Target type - can be Content, Community, or User
Target ID - community ID or user ID of the community or User where you want to post the livestream
Stream ID - search for the streamId
value in the stream's Raw model in Streaming details
Click OK to submit.
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.
The LIVE indicator on the upper left corner of the video indicates that the video is currently streaming while you are watching it.
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.
When the playback video is already available for viewing, a RECORDED indicator is shown on the video post.
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.
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.
In Post Management page, click and select Livestream Post in the dropdown selection.
Feature
Description
Post creation
Create post by adding content such as text, image, file, and video.
Mention users in post
Mention users in a post by typing @ to activate the mention suggestion and selecting their name in the suggestion list. You can mention up to 30 users per post.
An alert will be shown if character count is greater than 50000 or mentions count is greater than 30.
Post review list
List of posts from community members that the moderator needs to approve.
Members list
List of all the members of the community. You can perform the following actions on each member: 1. Report user 2. Promote to moderator 3. Remove from community
Moderators list
List of all the community moderators. You can perform the following actions on each moderator: 1. Report user 2. Dismiss moderator 3. Remove from community
Add Members
Add members to the community
Feature
Description
Community profile update
Update community information such as avatar, community name, description, category, and permission. The community's profile will be updated after clicking the Save button.
Closing community
Click Close to close the community. When you close the community, the community page and all its content will be removed
Feature
Description
Text editing
Allows you to edit the post
Image removal
Allows you to remove images from the post
File removal
Allows you to remove files from the post
This feature allows the transfer of moderator roles and blocks the last moderator to leave a community without transferring the role to other members, giving continuity to groups and creating a clear assignment to future moderators.
When a moderator leaves the community and there are no other moderators left, a pop-up will show that the moderator needs to nominate other members before leaving the community.
The moderator needs to promote a member to a moderator to transfer the moderator role to that member.
After a new moderator is selected, the moderator who wishes to leave can now leave the community.
Description |
---|
Feature | Description |
Gallery | Scroll vertically to see images and videos from posts in a community feed |
Media Filter | Filters according to media type (Photos and Videos). Click the corresponding tabs to see the filtered posts. |
Comment creation | Create comment by adding desired text in the compose bar and clicking Add comment. |
Mention in comment | Mention users in comment by typing @ to activate mention suggestion and selecting their names in the suggestion list. Up to 30 users can be mentioned per post. An alert will be shown if character count is greater than 50000 or mentions count is greater than 30. |
Edit comment | Edit comment by clicking ... and selecting Edit comment from the pop-up. Click Save to submit changes. |
Delete comment | Delete the comment by clicking ... and selecting Delete comment from the pop-up. Click Delete in the Delete comment confirmation message to confirm deletion. Otherwise, press Cancel. |
Feature | Description |
User Profile | View user display name and description |
Post creation |
User profile Edit |
Feature | Description |
Becoming a member | Click Join to join a community |
Post creation |
Community profile update |
Community Settings |
Promote a community member to a moderator |
Leave Community | Click to leave the community. If you are the last remaining moderator in the community you need to transfer your moderator role to other members. |
Feature
Data Type
Description
targetType
enum
for community feed it should be PostTargetType.CommunityFeed
feedType
enum
possible values FeedType.Published
, FeedType.Declined
, FeedType.Reviewing
targetId
string
for community feed it should be <communityId>
className
string
custom style classes to be applied to feed
showPostCreator
boolean
show creator of the post
readonly
boolean
make feed readonly
Feature | Description |
Members list |
Moderators list | List of community moderators |
Navigation to user profile page | View user's profile by selecting the member from the list |
Click Post to on your timeline
Click Edit profile to open and update your profile
Click Post to
List of community members. You can perform the following actions for each member: 1. Report user 2. 3. Remove from community
In this section, you can see all your pending follow requests. You can either Accept or Decline a request.
If a user in your pending list has withdrawn the request, the system error below will show when you accept or decline the user's follow request.
When a user withdraws a follow request, that user will not be automatically removed from your pending list. You need to accept/decline the request first.
Feature
Description
Accept Follow request
If you accept another user's follow request, the system will create a relationship and the user will be removed from your pending list.
Decline Follow request
If you decline another user's follow request, the system will invalidate the request and the user will be removed from your pending list.
Gallery
Scroll vertically to see images and videos from posts in a user feed
Media Filter
Filters according to media type (Photos and Videos). Click the corresponding tabs to see the filtered posts.
fThis section shows the user feed of a specific user.
In the Followings page you can see the list of users you are following.
In the Followers page you can see the list of users who follow you.
Feature
Description
User profile update
Update your profile information such as avatar, display name, and description. Profile will be updated upon clicking Save.
Feature
Description
User feed
Scroll vertically to see a list of posts from a user's feed
Private feed
You cannot see the feed of a user whose privacy setting is private and you're not connected to.
Feature | Description |
Report/undo report user | Report/undo reporting of a user |
Remove user from follower list | Remove a user from your Following list |
Redirect user to user profile page | Click a user in the list to go to the user's profile page |