List operators in group channel
An operator list is a complete list of operators of a group channel. The operator list is created through OperatorListActivity
or OperatorListFragment
.
Operator list screen
An operator list screen is composed of three components: header, operator list, and operator list status.
Header
The header component shows the default title of the operator list screen as Operators
. It also has a button on the right corner of the header. When 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 OperatorListModule
.
Operator list
The operator list component shows a list of profile images and names of the channel operators. The view of the operator list in a group channel is created and customized in the OperatorListComponent
of the OperatorListModule
. You can also customize each item in the list view using OperatorListAdapter
.
Operator list status
The operator list status component shows the result of the data request for an operator list. The StatusComponent
exists in the OperatorListModule
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 an operator 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 an operator list screen through OperatorListActivity
, which uses UIKitFragmentFactory
to create views.
Start an activity
You can start an activity by using intent
to move from one activity to OperatorListActivity
as shown below:
Create a fragment
OperatorListActivity
allows you to create a basic OperatorListFragment
through UIKitFragmentFactory
and OperatorListFragment.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 OperatorListFragment
. To see all APIs of OperatorListFragment.Builder
, refer to the API reference page.
Note: To use UIKit's fragments as a nested fragment, refer to the Android Developer Documentation's Nested Fragments.
Customization
In the list operators in group channel key function, you can customize OperatorListFragment
to change different parts of the screen. The OperatorListFragment.Builder
class allows you to create and customize the basic OperatorListFragment
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 OperatorListFragment
to display and customize the operator list screen.
Fragment | Module | Component | Style | RecyclerView |
---|---|---|---|---|
OperatorListFragment | OperatorListModule | HeaderComponent | Module.OperatorList | OperatorListAdapter |
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, see the Customization overview page for further details.
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 operator list, you must use the correct classes.