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.

Register participants as operators

Operators can register other channel participants as operators through the OpenChannelRegisterOperatorActivity or OpenChannelRegisterOperatorFragment. All channel participants are listed through pagination and participants who are already an operator can't be registered.


Register participants as operators screen

A register participants as operators screen is composed of three components: header, user list, and user list status.

Header

The header component shows the default title of the register participants as operators screen as Register as operator. It also has two buttons on the left and right corner of the header. When the left button is tapped, the finish() method of the activity is called to exit the current screen. When the right button is tapped, the selected members are registered to be operators of the channel. The view of the header is created and customized in the SelectUserHeaderComponent of the OpenChannelRegisterOperatorModule.

User list

The user list component shows a list of channel members' profile images, names, and selectable checkboxes. By default, all channel members are retrieved in the list. However, members that are already an operator of the channel can't be selected from the list. The view of the user list is created and customized in the OpenChannelRegisterOperatorListComponent of the OpenChannelRegisterOperatorModule. You can also customize each item in the list view using OpenChannelRegisterOperatorListAdapter.

User list status

The user list status component shows the result of the data request for a channel member list. The StatusComponent exists in the OpenChannelRegisterOperatorModule 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 register participants as operators 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 register participants as operators screen through OpenChannelRegisterOperatorActivity, which uses UIKitFragmentFactory to create views.

Start an activity

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

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

Create a fragment

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

OpenChannelRegisterOperatorFragment fragment = new OpenChannelRegisterOperatorFragment.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 register participants as operators key function, you can customize OpenChannelRegisterOperatorFragment to change different aspects of the screen. The OpenChannelRegisterOperatorFragment.Builder class allows you to create and customize the basic OpenChannelRegisterOperatorFragment 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 OpenChannelRegisterOperatorFragment to display and customize the register participants as operators screen.

FragmentModuleComponentStyleRecyclerView

OpenChannelRegisterOperatorFragment

OpenChannelRegisterOperatorModule

SelectUserHeaderComponent

OpenChannelRegisterOperatorListComponent

StatusComponent

Module.OpenChannelRegisterOperator

OpenChannelRegisterOperatorListAdapter

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:

Customize the layout of the view Customize style of the view Bind event handlers to the view Add new APIs to the fragment Update or change an item in a list

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 register participants as operators screen, you must use the correct classes.