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.

Configure open channel settings

You can configure the settings of each open channel. Customizable settings include channel name and cover image. You can also delete the channel or check the number of channel participants.


Open channel settings screen

An open channel settings screen is composed of four components: header, channel information, and settings menu.

Header

The header component shows the title of the open channel settings screen, which says channel information by default. 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, a dialog appears asking if the user would like to change the channel's cover image and name. The view of the header is created and customized in the OpenChannelSettingsHeaderComponent of the OpenChannelSettingsModule.

Channel information

The channel information component shows the channel's cover image and name by default. The view of the channel information is created and customized in the OpenChannelSettingsInfoComponent of the OpenChannelSettingsModule.

Settings menu

The settings menu shows different configuration options and features of the channel that you can set. The menu includes leave channel and view list of participants. The settings menu view is created and customized in the OpenChannelSettingsMenuComponent of the OpenChannelSettingsModule.


Usage

UIKit for Android provides both activity and fragment to create an open channel settings 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 open channel settings screen through OpenChannelSettingsActivity, which uses UIKitFragmentFactory to create views.

Start an activity

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

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

Create a fragment

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

OpenChannelSettingsFragment fragment = new OpenChannelSettingsFragment.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 configure open channel settings key function, you can customize OpenChannelSettingsFragment to change different aspects of the screen. The OpenChannelSettingsFragment.Builder class allows you to create and customize the basic OpenChannelSettingsFragment 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 OpenChannelSettingsFragment to display and customize the open channel settings screen.

FragmentModuleComponentStyle

OpenChannelSettingsFragment

OpenChannelSettingsModule

OpenChannelSettingsHeaderComponent

OpenChannelSettingsInfoComponent

OpenChannelSettingsMenuComponent

Module.OpenChannelSettings

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 open channel settings, you must use the correct classes.