stream-chat-android-ui-components/io.getstream.chat.android.ui.viewmodel.pinned/PinnedMessageListViewModel

PinnedMessageListViewModel

class PinnedMessageListViewModel(cid: String) : ViewModel

ViewModel responsible for providing pinned messages in the channel. Pinned messages are provided in a descending order based on Message.pinnedAt. Can be bound to the view using PinnedMessageListViewModel.bindView function.

Parameters

cid

The full channel id. ie messaging:123.

Constructors

PinnedMessageListViewModel

constructor(cid: String)

Types

State

data class State(val canLoadMore: Boolean, val results: List<Message>, val isLoading: Boolean, val nextDate: Date)

Represents the pinned messages state, used to render the required UI.

Properties

errorEvents

val errorEvents: LiveData<Event<Unit>>

One shot error events when query fails.

state

val state: LiveData<PinnedMessageListViewModel.State>

The current pinned messages' state.

Functions

loadMore

fun loadMore()

Loads more data when requested.

Inherited functions

addCloseable

open fun addCloseable(closeable: AutoCloseable)

fun addCloseable(key: String, closeable: AutoCloseable)

bindView

@JvmName(name = "bind")

fun PinnedMessageListViewModel.bindView(view: PinnedMessageListView, lifecycleOwner: LifecycleOwner)

Binds PinnedMessageListView with PinnedMessageListViewModel, updating the view's state based on data provided by the ViewModel and propagating view events to the ViewModel as needed.

getCloseable

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