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.

List muted members

A muted member list is a complete list of members that are muted in a group channel. Only an operator of the channel can mute members. The muted member list is created through MutedMemberListActivity or MutedMemberListFragment.


Muted member list screen

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

Header

The header component shows the default title of the muted member list screen as Muted 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 screen. The view of the header is created and customized in the HeaderComponent of the MutedMemberListModule.

Muted member list

The muted member list component shows a list of profile images and names of all muted members in the channel. The view of the muted member list is created and customized in the MutedMemberListComponent of the MutedMemberListModule. You can also customize each item in the list view using MutedMemberListAdapter.

Muted member list status

The muted member list status component shows the result of the data request for a muted member list. The StatusComponent exists in the MutedMemberListModule 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 muted 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 muted member list screen through MutedMemberListActivity, which uses UIKitFragmentFactory to create views.

Start an activity

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

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

Create a fragment

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

MutedMemberListFragment fragment = new MutedMemberListFragment.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 muted members key function, you can customize MutedMemberListFragment to change different parts of the screen. The MutedMemberListFragment.Builder class allows you to create and customize the basic MutedMemberListFragment 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 MutedMemberListFragment to display and customize the muted member list screen.

FragmentModuleComponentStyleRecyclerView

MutedMemberListFragment

MutedMemberListModule

HeaderComponent

MutedMemberListComponent

StatusComponent

Module.MutedMemberList

MutedMemberListAdapter

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 muted member list, you must use the correct classes.