UIKit Android v3
UIKit Android
UIKit
Android
Home
/
UIKit
/
Android
This is the new Docs for UIKit v3 beta for Android. To see the previous Docs, click here.

List banned members

A banned member list is a complete list of users that are banned from the channel. Only an operator of the channel can ban users. The banned member list is created through BannedUserListActivity or BannedUserListFragment.


Banned member list screen

A banned member list screen is composed of three components: header, banned member list, and banned member list status.

Header

The header component shows the default title of the banned member list screen as banned members. It also has a button on the left corner of the header. When the left button is tapped, the finish() method of the activity is called to exit the current screen. The view of the header is created and customized in the HeaderComponent of the BannedUserListModule.

Banned member list

The banned member list component shows a list of profile images and names of all banned members from the channel. The view of the banned member list is created and customized in the BannedUserListComponent of the BannedUserListModule. You can also customize each item in the list view using BannedUserListAdapter.

Banned member list status

The banned member list status component shows the result of the data request for a banned member list. The StatusComponent exists in the BannedUserListModule and lets the user know if the list is loading or if the list could not be called.


Usage

UIKit for Android provides both activity and fragment to create a banned member list screen. You can choose which one to build your app with and you may solely use activity instead of fragment if you wish to. You can build a banned member list screen through BannedUserListActivity, which uses UIKitFragmentFactory to create views.

Start an activity

You can start an activity by using intent to move from one activity to BannedUserListActivity as shown below:

Intent intent = BannedUserListActivity.newIntent(context, "channel_url");
startActivity(intent);

Create a fragment

BannedUserListActivity allows you to create a basic BannedUserListFragment through UIKitFragmentFactory and BannedUserListFragment.Builder. UIKitFragmentFactory has a set of methods that build each fragment, whereas the builder class provides APIs to customize the UI of the data and event handlers used in BannedUserListFragment. To see all APIs of BannedUserListFragment.Builder, refer to the API reference page.

BannedUserListFragment fragment = new BannedUserListFragment.Builder("channel_url").build();

Note: To use UIKit's fragments as a nested fragment, refer to the Android Developer Documentation's Nested Fragments.


Customization

In the list banned members key function, you can customize BannedUserListFragment to change different parts of the screen. The BannedUserListFragment.Builder class allows you to create and customize the basic BannedUserListFragment that UIKit provides but you can only change its own APIs, such as setting a layout. If you wish to customize the fragment beyond using the APIs provided in the builder, you must inherit new customization methods.

The following table shows the main classes used in BannedUserListFragment to display and customize the banned member list screen.

FragmentModuleComponentStyleRecyclerView

BannedUserListFragment

BannedUserListModule

HeaderComponent

BannedUserListComponent

StatusComponent

Module.BannedUserList

BannedUserListAdapter

Depending on the UI or the feature you wish to customize in the fragment, you can change the classes mentioned in the table. To learn how to customize the fragment, follow the links to Customization listed below:

Note: The links to the above customization pages provide an example of how to customize classes related to ChannelFragment. In order to make changes to the banned member list, you must use the correct classes.