stream-chat-android-client/io.getstream.chat.android.client.channel.state/ChannelState

ChannelState

interface ChannelState

State container with reactive data of a channel.

Properties

abstract val channelConfig: StateFlow<Config>

Channel config data

abstract val channelData: StateFlow<ChannelData>

StateFlow object with the channel data.

abstract val channelId: String

Id of this channel.

abstract val channelType: String

Type of this channel.

abstract val cid: String

CID of this channel. It's 'channelType:channelId'.

endOfNewerMessages

abstract val endOfNewerMessages: StateFlow<Boolean>

If there are no more newer messages to load.

endOfOlderMessages

abstract val endOfOlderMessages: StateFlow<Boolean>

If there are no more older messages to load.

abstract val hidden: StateFlow<Boolean>

If the channel is currently hidden.

abstract val insideSearch: StateFlow<Boolean>

lastSentMessageDate

abstract val lastSentMessageDate: StateFlow<Date?>

The date of the last message sent by the current user.

abstract val loading: StateFlow<Boolean>

If we are currently loading.

loadingNewerMessages

abstract val loadingNewerMessages: StateFlow<Boolean>

If we are currently loading newer messages.

loadingOlderMessages

abstract val loadingOlderMessages: StateFlow<Boolean>

If we are currently loading older messages.

abstract val members: StateFlow<List<Member>>

The list of members of this channel.

abstract val membersCount: StateFlow<Int>

Number of all members of this channel.

abstract val messages: StateFlow<List<Message>>

The message collection of this channel.

abstract val messagesState: StateFlow<MessagesState>

Strong typed state of message collection of this channel. See MessagesState for more details.

abstract val muted: StateFlow<Boolean>

If the channel is currently muted.

abstract val oldMessages: StateFlow<List<Message>>

The collection of messages from previous pages of data.

abstract val pinnedMessages: StateFlow<List<Message>>

The pinned message collection of this channel.

quotedMessagesMap

abstract val quotedMessagesMap: StateFlow<Map<String, List<String>>>

A map containing all the ids that quoted a message. Using the id of a message you can get the IDs of the messages that quoted it. This can be used to reflected changes of the original message to the messages that quoted it.

abstract val read: StateFlow<ChannelUserRead?>

Read status for the current user.

abstract val reads: StateFlow<List<ChannelUserRead>>

How far every user in this channel has read.

abstract val recoveryNeeded: Boolean

If we need to recover state when connection established again.

abstract val repliedMessage: StateFlow<Message?>

A replied message state in this channel. By default is null. There is a value if you're replying some message.

abstract val typing: StateFlow<TypingEvent>

Who is currently typing. Current user is excluded from this.

abstract val unreadCount: StateFlow<Int>

Unread count for this channel, calculated based on read state. This works even if you're offline.

abstract val watcherCount: StateFlow<Int>

The number of people currently watching the channel.

abstract val watchers: StateFlow<List<User>>

The list of users currently watching this channel.

Functions

abstract fun getMessageById(id: String): Message?

Gets message using the ID. This is a more performatic way to request one message than request the whole list of messages

abstract fun toChannel(): Channel

Function that builds a channel based on data from StateFlows.