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

Builder

Constructors

constructor()

Functions

fun build(): ViewModelProvider.Factory

Builds ChannelListViewModelFactory instance.

chatEventHandlerFactory

fun chatEventHandlerFactory(chatEventHandlerFactory: ChatEventHandlerFactory): ChannelListViewModelFactory.Builder

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

fun filter(filter: FilterObject): ChannelListViewModelFactory.Builder

Sets the way to filter the channels. Mutually exclusive with predefinedFilter.

fun filterValues(values: Map<String, Any>): ChannelListViewModelFactory.Builder

Sets the values interpolated into the predefined filter template. Has no effect unless predefinedFilter was called.

isDraftMessagesEnabled

fun isDraftMessagesEnabled(isDraftMessagesEnabled: Boolean): ChannelListViewModelFactory.Builder

Enables or disables draft messages.

fun limit(limit: Int): ChannelListViewModelFactory.Builder

Sets the number of channels to return.

fun memberLimit(memberLimit: Int?): ChannelListViewModelFactory.Builder

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

fun messageLimit(messageLimit: Int?): ChannelListViewModelFactory.Builder

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

predefinedFilter

fun predefinedFilter(name: String): ChannelListViewModelFactory.Builder

Configures the factory to query channels via a predefined filter resolved by the server. Mutually exclusive with filter.

fun sort(sort: QuerySorter<Channel>): ChannelListViewModelFactory.Builder

Sets the way to sort the channels, defaults to last_updated.

fun sortValues(values: Map<String, Any>): ChannelListViewModelFactory.Builder

Sets the values interpolated into the predefined sort template. Has no effect unless predefinedFilter was called.