stream-chat-android-client/io.getstream.chat.android.client.api.state/StateRegistry

StateRegistry

class StateRegistry @JvmOverloads constructor(userStateFlow: StateFlow<User?>, latestUsers: StateFlow<Map<String, User>>, activeLiveLocations: StateFlow<List<Location>>, job: Job, now: () -> Long, scope: CoroutineScope, messageLimitConfig: MessageLimitConfig, mutedUsers: StateFlow<List<Mute>> = MutableStateFlow(emptyList()), useLegacyChannelState: Boolean = true)

Registry of all state objects exposed in the offline plugin. This class should have only one instance for the SDK.

Parameters

userStateFlow

The state flow that provides the user once it is set.

latestUsers

Latest users of the SDK.

activeLiveLocations

Latest live locations of the SDK.

job

A background job cancelled after calling clear.

scope

A scope for new coroutines.

messageLimitConfig

Configuration for message limits.

mutedUsers

The current list of muted users.

useLegacyChannelState

Whether to use the legacy channel state implementation.

Constructors

StateRegistry

@JvmOverloads

constructor(userStateFlow: StateFlow<User?>, latestUsers: StateFlow<Map<String, User>>, activeLiveLocations: StateFlow<List<Location>>, job: Job, now: () -> Long, scope: CoroutineScope, messageLimitConfig: MessageLimitConfig, mutedUsers: StateFlow<List<Mute>> = MutableStateFlow(emptyList()), useLegacyChannelState: Boolean = true)

Functions

channel

fun channel(channelType: String, channelId: String): ChannelState

Returns the ChannelState for the given channel.

clear

fun clear()

Clear state of all state objects.

queryChannels

fun queryChannels(identifier: QueryChannelsIdentifier): QueryChannelsState

Returns QueryChannelsState associated with the given identifier. Canonical lookup that works for both standard and predefined-filter queries. For predefined queries the resulting state starts with placeholder filter/sort that get replaced via applyResolvedSpec once the server response (or a previously persisted DB row) provides the resolved values.

fun queryChannels(filter: FilterObject, sort: QuerySorter<Channel>): QueryChannelsState

Returns QueryChannelsState associated with particular filter and sort.

thread

fun thread(messageId: String): ThreadState

Returns ThreadState of thread replies with parent message that has id equal to messageId.