stream-chat-android-compose/io.getstream.chat.android.compose.viewmodel.channels/ChannelListViewModel

ChannelListViewModel

class ChannelListViewModel(val chatClient: ChatClient, initialSort: QuerySorter<Channel> = QuerySortByField.descByName("last_updated"), initialFilters: FilterObject? = null, channelLimit: Int = DEFAULT_CHANNEL_LIMIT, memberLimit: Int? = null, messageLimit: Int? = null, chatEventHandlerFactory: ChatEventHandlerFactory = ChatEventHandlerFactory(chatClient.clientState), searchDebounceMs: Long = SEARCH_DEBOUNCE_MS, draftMessagesEnabled: Boolean = true, messageSearchSort: QuerySorter<Message>? = null, globalState: Flow<GlobalState> = chatClient.globalStateFlow) : ViewModel

A state store that represents all the information required to query, filter, show and react to Channel items in a list.

Parameters

chatClient

Used to connect to the API.

initialSort

The initial sort used for Channels.

initialFilters

The current data filter. Users can change this state using setFilters to impact which data is shown on the UI.

channelLimit

How many channels we fetch per page.

memberLimit

How many members are fetched for each channel item when loading channels. When null, the server-side default is used.

messageLimit

How many messages are fetched for each channel item when loading channels. When null, the server-side default is used.

chatEventHandlerFactory

The instance of ChatEventHandlerFactory used to create ChatEventHandler.

searchDebounceMs

The debounce time for search queries.

draftMessagesEnabled

If the draft message feature is enabled.

messageSearchSort

Sorting for message search results. When null, the server-side default is used.

globalState

A flow emitting the current GlobalState.

Constructors

ChannelListViewModel

constructor(chatClient: ChatClient, initialSort: QuerySorter<Channel> = QuerySortByField.descByName("last_updated"), initialFilters: FilterObject? = null, channelLimit: Int = DEFAULT_CHANNEL_LIMIT, memberLimit: Int? = null, messageLimit: Int? = null, chatEventHandlerFactory: ChatEventHandlerFactory = ChatEventHandlerFactory(chatClient.clientState), searchDebounceMs: Long = SEARCH_DEBOUNCE_MS, draftMessagesEnabled: Boolean = true, messageSearchSort: QuerySorter<Message>? = null, globalState: Flow<GlobalState> = chatClient.globalStateFlow)

Properties

activeChannelAction

var activeChannelAction: ChannelAction?

Currently active channel action, if any. Used to show a dialog for deleting or leaving a channel/conversation.

val channelMutes: StateFlow<List<ChannelMute>>

Gives us the information about the list of channels mutes by the current user.

var channelsState: ChannelsState

The current state of the channels screen. It holds all the information required to render the UI.

val chatClient: ChatClient

connectionState

val connectionState: StateFlow<ConnectionState>

The state of our network connection - if we're online, connecting or offline.

val searchQuery: SearchQuery

The current search query.

selectedChannel

var selectedChannel: MutableState<Channel?>

Currently selected channel, if any. Used to show the bottom drawer information when long tapping on a list item.

val user: StateFlow<User?>

The state of the currently logged in user.

Functions

open fun addCloseable(closeable: AutoCloseable)

fun addCloseable(key: String, closeable: AutoCloseable)

fun archiveChannel(channel: Channel)

fun blockUser(userId: String)

Blocks a user (used for DM channels).

confirmPendingAction

fun confirmPendingAction()

Executes the currently pending activeChannelAction after user confirmation and dismisses it from the UI.

deleteConversation

fun deleteConversation(channel: Channel)

Deletes a channel, after the user chooses the delete ChannelAction. It also removes the activeChannelAction, to remove the dialog from the UI.

dismissChannelAction

fun dismissChannelAction()

Dismisses the activeChannelAction and removes it from the UI.

executeOrConfirm

fun executeOrConfirm(action: ChannelAction)

Executes the given ChannelAction immediately if it doesn't require confirmation, or stores it as activeChannelAction to show a confirmation dialog.

fun <T : AutoCloseable> getCloseable(key: String): T?

fun isChannelMuted(cid: String): Boolean

Checks if the channel is muted for the current user.

fun isUserBlocked(userId: String): Boolean

Checks if a user is blocked by the current user.

fun isUserMuted(userId: String): Boolean

Checks if a user is muted by the current user.

fun leaveGroup(channel: Channel)

Leaves a channel, after the user chooses the leave ChannelAction. It also removes the activeChannelAction, to remove the dialog from the UI.

Loads more data when the user reaches the end of the channels list.

fun muteChannel(channel: Channel)

Mutes a channel.

fun muteUser(userId: String)

Mutes a user (used for DM channels).

fun pinChannel(channel: Channel)

Pins a channel.

Refreshes either channels or search results.

fun selectChannel(channel: Channel?)

Changes the currently selected channel state. This updates the UI state and allows us to observe the state change.

fun setFilters(newFilters: FilterObject)

Allows for the change of filters used for channel queries.

fun setQuerySort(querySort: QuerySorter<Channel>)

Allows for the change of the query sort used for channel queries.

fun setSearchQuery(searchQuery: SearchQuery)

Changes the current query state. This updates the data flow and triggers another query operation.

unarchiveChannel

fun unarchiveChannel(channel: Channel)

fun unblockUser(userId: String)

Unblocks a user (used for DM channels).

fun unmuteChannel(channel: Channel)

Unmutes a channel.

fun unmuteUser(userId: String)

Unmutes a user (used for DM channels).

fun unpinChannel(channel: Channel)

Unpins a channel.