```
public final class ChannelListViewModel
extends ViewModel
                    
```
ViewModel class for ChannelListView. Responsible for keeping the channels list up to date. Can be bound to the view using ChannelListViewModel.bindView function.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`ChannelListViewModel.State`	Described the state of the list of channels.
`public final class`	`ChannelListViewModel.PaginationState`	Describes the pagination state.
`public class`	`ChannelListViewModel.Action`	Describes the available actions that can be taken.
`public class`	`ChannelListViewModel.ErrorEvent`	Describes the actions that were taken.
`public class`	`ChannelListViewModel.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final LiveData<ChannelListViewModel.State>`	`state`
`private final LiveData<Map<String, TypingEvent>>`	`typingEvents`
`private final LiveData<Map<String, DraftMessage>>`	`draftMessages`
`private final LiveData<ChannelListViewModel.PaginationState>`	`paginationState`
`private final LiveData<Event<ChannelListViewModel.ErrorEvent>>`	`errorEvents`

Constructor Summary

Constructors
Constructor	Description
`ChannelListViewModel(FilterObject filter, QuerySorter<Channel> sort, Integer limit, Integer messageLimit, Integer memberLimit, Boolean isDraftMessagesEnabled, ChatEventHandlerFactory chatEventHandlerFactory, ChatClient chatClient, Flow<GlobalState> globalState)`	Creates a view model that queries channels by an explicit filter and sort.
`ChannelListViewModel(String predefinedFilterName, Map<String, Object> filterValues, Map<String, Object> sortValues, Integer limit, Integer messageLimit, Integer memberLimit, Boolean isDraftMessagesEnabled, ChatEventHandlerFactory chatEventHandlerFactory, ChatClient chatClient, Flow<GlobalState> globalState)`	Creates a view model that queries channels using a predefined filter resolved by the server.
`ChannelListViewModel(FilterObject filter, QuerySorter<Channel> sort, Integer limit, Integer messageLimit, Integer memberLimit, Boolean isDraftMessagesEnabled, ChatEventHandlerFactory chatEventHandlerFactory, ChatClient chatClient, GlobalState globalState)`	ViewModel class for ChannelListView.

Method Summary

Modifier and Type	Method	Description
`final LiveData<ChannelListViewModel.State>`	`getState()`	Represents the current state containing channel list information.
`final LiveData<Map<String, TypingEvent>>`	`getTypingEvents()`	Updates about currently typing users in active channels.
`final LiveData<Map<String, DraftMessage>>`	`getDraftMessages()`	Draft messages for channels.
`final LiveData<ChannelListViewModel.PaginationState>`	`getPaginationState()`	Represents the current pagination state by containing information about the loading state and if we have reached the end of all available channels.
`final LiveData<Event<ChannelListViewModel.ErrorEvent>>`	`getErrorEvents()`	Emits error events.
`final Unit`	`onAction(ChannelListViewModel.Action action)`	Checks against available actions and creates side-effects accordingly.
`final Unit`	`leaveChannel(Channel channel)`	Removes the current user from the channel.
`final Unit`	`deleteChannel(Channel channel)`	Deletes a channel.
`final Unit`	`hideChannel(Channel channel)`	Hides the given channel.
`final Unit`	`markAllRead()`	Marks all of the channels as read.
`final Unit`	`setFilters(FilterObject filterObject)`	Allows us to change the filter based on our requirements.

Methods inherited from class io.getstream.chat.android.ui.viewmodel.channels.ChannelListViewModel
addCloseable, addCloseable, addCloseable, getCloseable
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ChannelListViewModel
```
ChannelListViewModel(FilterObject filter, QuerySorter<Channel> sort, Integer limit, Integer messageLimit, Integer memberLimit, Boolean isDraftMessagesEnabled, ChatEventHandlerFactory chatEventHandlerFactory, ChatClient chatClient, Flow<GlobalState> globalState)
```
    Creates a view model that queries channels by an explicit filter and sort.
    
    Parameters:
    
    filter - Filter for querying channels.
    
    sort - Defines the ordering of the channels.
  - ChannelListViewModel
```
ChannelListViewModel(String predefinedFilterName, Map<String, Object> filterValues, Map<String, Object> sortValues, Integer limit, Integer messageLimit, Integer memberLimit, Boolean isDraftMessagesEnabled, ChatEventHandlerFactory chatEventHandlerFactory, ChatClient chatClient, Flow<GlobalState> globalState)
```
    Creates a view model that queries channels using a predefined filter resolved by the server.
    
    Parameters:
    
    predefinedFilterName - The name of the predefined filter registered on the backend.
    
    filterValues - Optional values interpolated into the predefined filter template.
    
    sortValues - Optional values interpolated into the predefined sort template.
  - ChannelListViewModel
```
ChannelListViewModel(FilterObject filter, QuerySorter<Channel> sort, Integer limit, Integer messageLimit, Integer memberLimit, Boolean isDraftMessagesEnabled, ChatEventHandlerFactory chatEventHandlerFactory, ChatClient chatClient, GlobalState globalState)
```
    ViewModel class for ChannelListView.
    
    Parameters:
    
    globalState - The current GlobalState.
- Method Detail
  - getState
```
 final LiveData<ChannelListViewModel.State> getState()
```
    Represents the current state containing channel list information.
  - getTypingEvents
```
 final LiveData<Map<String, TypingEvent>> getTypingEvents()
```
    Updates about currently typing users in active channels.
  - getDraftMessages
```
 final LiveData<Map<String, DraftMessage>> getDraftMessages()
```
    Draft messages for channels.
  - getPaginationState
```
 final LiveData<ChannelListViewModel.PaginationState> getPaginationState()
```
    Represents the current pagination state by containing information about the loading state and if we have reached the end of all available channels.
  - getErrorEvents
```
 final LiveData<Event<ChannelListViewModel.ErrorEvent>> getErrorEvents()
```
    Emits error events.
  - onAction
```
 final Unit onAction(ChannelListViewModel.Action action)
```
    Checks against available actions and creates side-effects accordingly.
    
    Parameters:
    
    action - The action to process.
  - leaveChannel
```
 final Unit leaveChannel(Channel channel)
```
    Removes the current user from the channel.
    
    Parameters:
    
    channel - The channel that the current user will leave.
  - deleteChannel
```
 final Unit deleteChannel(Channel channel)
```
    Deletes a channel.
    
    Parameters:
    
    channel - Channel to be deleted.
  - hideChannel
```
 final Unit hideChannel(Channel channel)
```
    Hides the given channel.
  - markAllRead
```
 final Unit markAllRead()
```
    Marks all of the channels as read.
  - setFilters
```
 final Unit setFilters(FilterObject filterObject)
```
    Allows us to change the filter based on our requirements.
    Has no effect on view models constructed for a predefined-filter query — the predefined identity is fixed at construction. A warning is logged in that case.
    
    Parameters:
    
    filterObject - The new filter to be applied to the query which lets us fetch different data.

Class ChannelListViewModel

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class io.getstream.chat.android.ui.viewmodel.channels.ChannelListViewModel

Methods inherited from class java.lang.Object

Constructor Detail

ChannelListViewModel

ChannelListViewModel

ChannelListViewModel

Method Detail

getState

getTypingEvents

getDraftMessages

getPaginationState

getErrorEvents

onAction

leaveChannel

deleteChannel

hideChannel

markAllRead

setFilters