List channels

val intent = ChannelListActivity.newIntent(context)
startActivity(intent)
Create a fragment
Copy link
Feedback
ChannelListActivity allows you to create a basic ChannelListFragment through UIKitFragmentFactory and ChannelListFragment.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 ChannelListFragment. To see all APIs of ChannelListFragment.Builder, refer to the API reference page.
KotlinJava
val fragment = ChannelListFragment.Builder().build()
Note: To use UIKit's fragments as a nested fragment, refer to the Android Developer Documentation's Nested Fragments.
Implement push notifications
Copy link
Feedback
You can also implement push notifications so users can access ChannelListActivity from other activities in the client app. Users should be able to access ChannelListActivity from a channel that they entered upon tapping on a push notification. The unique URL of the channel must be passed as an argument to a parameter when creating intent.
KotlinJava
val intent = ChannelListActivity.newRedirectToChannelIntent(context, CHANNEL_URL).apply {
    addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP)
val pendingIntent = if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
    PendingIntent.getActivity(context, channelUrl.hashCode(), intent, PendingIntent.FLAG_IMMUTABLE)
} else {
    PendingIntent.getActivity(context, channelUrl.hashCode(), intent, PendingIntent.FLAG_UPDATE_CURRENT)
Customization
Copy link
Feedback
In the list channel key function, you can customize ChannelListFragment to change different aspects of the screen. The ChannelListFragment.Builder class allows you to create and customize the basic ChannelListFragment 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 ChannelListFragment to display and customize the channel list screen.
Fragment
Module
Component
Style
RecyclerView
ChannelListFragment
ChannelListModule
HeaderComponent

ChannelListComponent

StatusComponent
Module.ChannelList
ChannelListAdapter
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 Customizations overview page for further details.
Note: The links to the Customization page provide an example of how to customize classes related to ChannelFragment. In order to make changes to the channel list, you must use the correct classes.
Our products on YouTubeDeveloper resources on GitHub
© 2024 Sendbird, Inc.
On this page
Channel list screen
HeaderChannel listChannel list status
Usage
Start an activityCreate a fragmentImplement push notifications
Customization
Sample app