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

Moderate group channels and members

In group channels, you can moderate channels and members through the ModerationActivity or ModerationFragment class. Using the moderation menu, you can retrieve a list of operators, muted members, and banned users in a channel, as well as freeze the channel. In order to use this feature, a channel must have at least one operator.


Group channel moderation screen

A group channel moderation screen is composed of two components: header and moderation list.

Header

The header component shows the default title of the group channel moderation screen as Moderations. It also has two buttons on the left corner of the header. When the left button is tapped, the finish() method of the activity is called to exit the screen. The view of the header is created and customized in the HeaderComponent of the ModerationModule.

Moderation list

The moderation list shows all items of the moderation menu, which includes a list of operators, muted members, banned members, and the option to freeze the channel. The view of the moderation list is created and customized in the ModerationListComponent of the ModerationModule.


Usage

UIKit for Android provides both activity and fragment to create a moderation 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 group channel moderation screen through ModerationActivity, which uses UIKitFragmentFactory to create views.

Start an activity

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

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

Create a fragment

ModerationActivity allows you to create a basic ModerationFragment through UIKitFragmentFactory and ModerationFragment.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 ModerationFragment. To see all APIs of ModerationFragment.Builder, refer to the API reference page.

ModerationFragment fragment = new ModerationFragment.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 moderate channels and members key function, you can customize ModerationFragment to change different parts of the screen. The ModerationFragment.Builder class allows you to create and customize the basic ModerationFragment 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 ModerationFragment to display and customize the group channel moderation screen.

FragmentModuleComponentStyle

ModerationFragment

ModerationModule

HeaderComponent

ModerationListComponent

Module.Moderation

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 group channel moderation screen, you must use the correct classes.