All Implemented Interfaces:
```
public final class MessageListViewModel
extends ViewModel
                    
```
View model class for MessageListView. Responsible for updating the list of messages. Can be bound to the view using MessageListViewModel.bindView function.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`MessageListViewModel.State`	The current state of the message list.
`public class`	`MessageListViewModel.Event`	Represents events coming from the View class.

Field Summary

Fields
Modifier and Type	Field	Description
`private final StateFlow<ChannelState>`	`channelState`
`private final LiveData<Channel>`	`channel`
`private final LiveData<Set<String>>`	`ownCapabilities`
`private final LiveData<Boolean>`	`showSystemMessagesState`
`private final LiveData<MessageFooterVisibility>`	`messageFooterVisibilityState`
`private final LiveData<DeletedMessageVisibility>`	`deletedMessageVisibility`
`private final LiveData<MessageListViewModel.State>`	`state`
`private final LiveData<MessageMode>`	`mode`
`private final LiveData<Boolean>`	`loadMoreLiveData`
`private final LiveData<Message>`	`targetMessage`
`private final LiveData<Event<MessageListController.ErrorEvent>>`	`errorEvents`
`private final LiveData<User>`	`user`
`private final LiveData<Integer>`	`unreadCount`
`private final LiveData<Boolean>`	`insideSearch`
`private final LiveData<MessageListController.UnreadLabel>`	`unreadLabel`

Constructor Summary

Constructors
Constructor	Description
`MessageListViewModel(MessageListController messageListController, ChatClient chatClient)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final StateFlow<ChannelState>`	`getChannelState()`	Holds information about the current channel and is actively updated.
`final LiveData<Channel>`	`getChannel()`	The current channel used to load the message list data.
`final LiveData<Set<String>>`	`getOwnCapabilities()`	Holds information about the abilities the current user is able to exercise in the given channel.
`final LiveData<Boolean>`	`getShowSystemMessagesState()`	Determines whether we should show system messages or not.
`final LiveData<MessageFooterVisibility>`	`getMessageFooterVisibilityState()`	Regulates the message footer visibility.
`final LiveData<DeletedMessageVisibility>`	`getDeletedMessageVisibility()`	Regulates the visibility of deleted messages.
`final LiveData<MessageListViewModel.State>`	`getState()`	Current message list state.
`final LiveData<MessageMode>`	`getMode()`	Whether the user is viewing a thread.
`final LiveData<Boolean>`	`getLoadMoreLiveData()`	Emits true if we should are loading more older messages.
`final LiveData<Message>`	`getTargetMessage()`	The target message that the list should scroll to.
`final LiveData<Event<MessageListController.ErrorEvent>>`	`getErrorEvents()`	Emits error events.
`final LiveData<User>`	`getUser()`	The currently logged in user.
`final LiveData<Integer>`	`getUnreadCount()`	Unread count of the channel or thread depending on MessageMode.
`final LiveData<Boolean>`	`getInsideSearch()`	Emits the status of searching situation.
`final LiveData<MessageListController.UnreadLabel>`	`getUnreadLabel()`	Emits the current unread label state.
`final Unit`	`onEvent(MessageListViewModel.Event event)`	Handles an Event coming from the View layer.
`final Message`	`getMessageById(String messageId)`	Returns a message with the given ID from the messages list.
`final Unit`	`scrollToBottom(Integer messageLimit, Function0<Unit> scrollToBottom)`	When the user clicks the scroll to bottom button we need to take the user to the bottom of the newest messages.
`final Unit`	`setDateSeparatorHandler(DateSeparatorHandler dateSeparatorHandler)`	Sets the date separator handler which determines when to add date separators.
`final Unit`	`setThreadDateSeparatorHandler(DateSeparatorHandler threadDateSeparatorHandler)`	Sets thread date separator handler which determines when to add date separators inside the thread.
`final Unit`	`setMessagePositionHandler(MessagePositionHandler messagePositionHandler)`	Sets a handler which determines the position of a message inside a group.
`final Unit`	`setDeletedMessageVisibility(DeletedMessageVisibility deletedMessageVisibility)`	Sets the value used to filter deleted messages.
`final Unit`	`setMessageFooterVisibility(MessageFooterVisibility messageFooterVisibility)`	Sets the value used to determine if message footer content is shown.
`final Unit`	`setAreSystemMessagesVisible(Boolean showSystemMessages)`	Sets whether the system messages should be visible.

Methods inherited from class androidx.lifecycle.ViewModel
addCloseable
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MessageListViewModel
```
MessageListViewModel(MessageListController messageListController, ChatClient chatClient)
```
    Parameters:
    
    messageListController - Controller used to relay the logic and fetch the state.
- Method Detail
  - getChannelState
```
 final StateFlow<ChannelState> getChannelState()
```
    Holds information about the current channel and is actively updated.
  - getChannel
```
 final LiveData<Channel> getChannel()
```
    The current channel used to load the message list data.
  - getOwnCapabilities
```
 final LiveData<Set<String>> getOwnCapabilities()
```
    Holds information about the abilities the current user is able to exercise in the given channel.
    e.g. send messages, delete messages, etc... For a full list @see ChannelCapabilities.
  - getShowSystemMessagesState
```
 final LiveData<Boolean> getShowSystemMessagesState()
```
    Determines whether we should show system messages or not.
  - getMessageFooterVisibilityState
```
 final LiveData<MessageFooterVisibility> getMessageFooterVisibilityState()
```
    Regulates the message footer visibility.
  - getDeletedMessageVisibility
```
 final LiveData<DeletedMessageVisibility> getDeletedMessageVisibility()
```
    Regulates the visibility of deleted messages.
  - getState
```
 final LiveData<MessageListViewModel.State> getState()
```
    Current message list state.
  - getMode
```
 final LiveData<MessageMode> getMode()
```
    Whether the user is viewing a thread.
  - getLoadMoreLiveData
```
 final LiveData<Boolean> getLoadMoreLiveData()
```
    Emits true if we should are loading more older messages.
  - getTargetMessage
```
 final LiveData<Message> getTargetMessage()
```
    The target message that the list should scroll to. Used when scrolling to a pinned message, a message opened from a push notification or similar.
  - getErrorEvents
```
 final LiveData<Event<MessageListController.ErrorEvent>> getErrorEvents()
```
    Emits error events.
  - getUser
```
 final LiveData<User> getUser()
```
    The currently logged in user.
  - getUnreadCount
```
 final LiveData<Integer> getUnreadCount()
```
    Unread count of the channel or thread depending on MessageMode.
  - getInsideSearch
```
 final LiveData<Boolean> getInsideSearch()
```
    Emits the status of searching situation. True when inside a search and false otherwise.
  - getUnreadLabel
```
 final LiveData<MessageListController.UnreadLabel> getUnreadLabel()
```
    Emits the current unread label state.
  - onEvent
```
 final Unit onEvent(MessageListViewModel.Event event)
```
    Handles an Event coming from the View layer.
  - getMessageById
```
 final Message getMessageById(String messageId)
```
    Returns a message with the given ID from the messages list.
    
    Parameters:
    
    messageId - The ID of the selected message.
    
    Returns:
    
    The Message with the ID, if it exists.
  - scrollToBottom
```
 final Unit scrollToBottom(Integer messageLimit, Function0<Unit> scrollToBottom)
```
    When the user clicks the scroll to bottom button we need to take the user to the bottom of the newest messages. If the messages are not loaded we need to load them first and then scroll to the bottom of the list.
    
    Parameters:
    
    messageLimit - The limit of messages to load when loading newest messages.
    
    scrollToBottom - The handler that notifies when the data has been loaded to scroll to the bottom.
  - setDateSeparatorHandler
```
 final Unit setDateSeparatorHandler(DateSeparatorHandler dateSeparatorHandler)
```
    Sets the date separator handler which determines when to add date separators. By default, a date separator will be added if the difference between two messages' dates is greater than 4h.
    
    Parameters:
    
    dateSeparatorHandler - The handler to use.
  - setThreadDateSeparatorHandler
```
 final Unit setThreadDateSeparatorHandler(DateSeparatorHandler threadDateSeparatorHandler)
```
    Sets thread date separator handler which determines when to add date separators inside the thread.
    
    Parameters:
    
    threadDateSeparatorHandler - The handler to use.
  - setMessagePositionHandler
```
 final Unit setMessagePositionHandler(MessagePositionHandler messagePositionHandler)
```
    Sets a handler which determines the position of a message inside a group.
    
    Parameters:
    
    messagePositionHandler - The handler to use.
  - setDeletedMessageVisibility
```
 final Unit setDeletedMessageVisibility(DeletedMessageVisibility deletedMessageVisibility)
```
    Sets the value used to filter deleted messages.
    
    Parameters:
    
    deletedMessageVisibility - Determines the visibility of deleted messages.
  - setMessageFooterVisibility
```
 final Unit setMessageFooterVisibility(MessageFooterVisibility messageFooterVisibility)
```
    Sets the value used to determine if message footer content is shown.
    
    Parameters:
    
    messageFooterVisibility - Determines the visibility of message footers.
  - setAreSystemMessagesVisible
```
 final Unit setAreSystemMessagesVisible(Boolean showSystemMessages)
```
    Sets whether the system messages should be visible.
    
    Parameters:
    
    showSystemMessages - Whether system messages should be visible or not.

Class MessageListViewModel

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class androidx.lifecycle.ViewModel

Methods inherited from class java.lang.Object

Constructor Detail

MessageListViewModel

Method Detail

getChannelState

getChannel

getOwnCapabilities

getShowSystemMessagesState

getMessageFooterVisibilityState

getDeletedMessageVisibility

getState

getMode

getLoadMoreLiveData

getTargetMessage

getErrorEvents

getUser

getUnreadCount

getInsideSearch

getUnreadLabel

onEvent

getMessageById

scrollToBottom

setDateSeparatorHandler

setThreadDateSeparatorHandler

setMessagePositionHandler

setDeletedMessageVisibility

setMessageFooterVisibility

setAreSystemMessagesVisible