stream-chat-android-ui-components/io.getstream.chat.android.ui.viewmodel.channels/ChannelListViewModelFactory

ChannelListViewModelFactory

class ChannelListViewModelFactory : ViewModelProvider.Factory

Creates a channels view model factory.

A ChannelListViewModel serves one user at a time: when the user disconnects or another user connects, it drops the loaded channels and reloads once the next user is connected. The default filter follows the connected user. A filter that contains a user id doesn't: set the next user's filter with ChannelListViewModel.setFilters before the list reloads, for example when clientState.user changes. Predefined filter values can't be changed, so a different user needs a new view model.

Parameters

limit

How many channels to return.

memberLimit

The number of members per channel. When null, the server-side default is used.

messageLimit

The number of messages to fetch for each channel. When null, the server-side default is used.

isDraftMessagesEnabled

Enables or disables draft messages.

chatEventHandlerFactory

The instance of ChatEventHandlerFactory that will be used to create ChatEventHandler.

Constructors

ChannelListViewModelFactory

@JvmOverloads

constructor(filter: FilterObject? = null, sort: QuerySorter<Channel> = ChannelListViewModel.DEFAULT_SORT, limit: Int = ChannelListViewModel.DEFAULT_CHANNEL_LIMIT, messageLimit: Int? = null, memberLimit: Int? = null, isDraftMessagesEnabled: Boolean = ChatUI.draftMessagesEnabled, chatEventHandlerFactory: ChatEventHandlerFactory = ChatEventHandlerFactory())

Builds a factory for a ChannelListViewModel that queries channels by an explicit filter and sort.

@JvmOverloads

constructor(predefinedFilterName: String, filterValues: Map<String, Any>? = null, sortValues: Map<String, Any>? = null, limit: Int = ChannelListViewModel.DEFAULT_CHANNEL_LIMIT, messageLimit: Int? = null, memberLimit: Int? = null, isDraftMessagesEnabled: Boolean = ChatUI.draftMessagesEnabled, chatEventHandlerFactory: ChatEventHandlerFactory = ChatEventHandlerFactory())

Builds a factory for a ChannelListViewModel that queries channels using a predefined filter resolved by the server.

Types

Builder

class Builder

Functions

create

open fun <T : ViewModel> create(modelClass: Class<T>, extras: CreationExtras): T

open fun <T : ViewModel> create(modelClass: KClass<T>, extras: CreationExtras): T

open override fun <T : ViewModel> create(modelClass: Class<T>): T

Returns an instance of ChannelListViewModel.

ChannelListViewModelFactory

Parameters

See also

Constructors

Types

Functions