GlobalMutableState

All Implemented Interfaces:

io.getstream.chat.android.offline.plugin.state.global.GlobalState , io.getstream.chat.android.offline.plugin.state.global.internal.MutableGlobalState
```
public final class GlobalMutableState
 implements MutableGlobalState
                    
```

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`GlobalMutableState.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final StateFlow<User>`	`user`
`private final StateFlow<Boolean>`	`initialized`
`private final StateFlow<ConnectionState>`	`connectionState`
`private final StateFlow<Integer>`	`totalUnreadCount`
`private final StateFlow<Integer>`	`channelUnreadCount`
`private final StateFlow<Event<ChatError>>`	`errorEvents`
`private final StateFlow<List<Mute>>`	`muted`
`private final StateFlow<List<ChannelMute>>`	`channelMutes`
`private final StateFlow<Boolean>`	`banned`
`private final StateFlow<TypingEvent>`	`typingUpdates`
`private final StateFlow<Map<String, TypingEvent>>`	`typingChannels`
`private final ClientState`	`clientState`

Method Summary

Modifier and Type	Method	Description
`StateFlow<User>`	`getUser()`	The current user in the OfflinePlugin state.
`StateFlow<Boolean>`	`getInitialized()`	If the client connection has been initialized.
`StateFlow<ConnectionState>`	`getConnectionState()`	StateFlow<ConnectionState> that indicates if we are currently online, connecting of offline.
`StateFlow<Integer>`	`getTotalUnreadCount()`	The total unread message count for the current user.
`StateFlow<Integer>`	`getChannelUnreadCount()`	the number of unread channels for the current user.
`StateFlow<Event<ChatError>>`	`getErrorEvents()`	The error event state flow object is triggered when errors in the underlying components occur.
`StateFlow<List<Mute>>`	`getMuted()`	list of users that you've muted.
`StateFlow<List<ChannelMute>>`	`getChannelMutes()`	List of channels you've muted.
`StateFlow<Boolean>`	`getBanned()`	if the current user is banned or not.
`StateFlow<TypingEvent>`	`getTypingUpdates()`	Updates about currently typing users in active channels.
`StateFlow<Map<String, TypingEvent>>`	`getTypingChannels()`	Map of typing users in all active channel.
`ClientState`	`getClientState()`
`Boolean`	`isOnline()`	If the user is online or not.
`Boolean`	`isOffline()`	If the user is offline or not.
`Boolean`	`isConnecting()`	If connection is in connecting state.
`Boolean`	`isInitialized()`	If domain state is initialized or not.
`Unit`	`clearState()`	Clears the state of GlobalState.
`Unit`	`setErrorEvent(Event<ChatError> errorEvent)`
`Unit`	`setTotalUnreadCount(Integer totalUnreadCount)`
`Unit`	`setChannelUnreadCount(Integer channelUnreadCount)`
`Unit`	`setBanned(Boolean banned)`
`Unit`	`setChannelMutes(List<ChannelMute> channelMutes)`
`Unit`	`setMutedUsers(List<Mute> mutedUsers)`
`Unit`	`tryEmitTypingEvent(String cid, TypingEvent typingEvent)`	Tries emit typing event for a particular channel.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getUser
```
 StateFlow<User> getUser()
```
    The current user in the OfflinePlugin state.
  - getInitialized
```
 StateFlow<Boolean> getInitialized()
```
    If the client connection has been initialized.
  - getConnectionState
```
 StateFlow<ConnectionState> getConnectionState()
```
    StateFlow<ConnectionState> that indicates if we are currently online, connecting of offline.
  - getTotalUnreadCount
```
 StateFlow<Integer> getTotalUnreadCount()
```
    The total unread message count for the current user. Depending on your app you'll want to show this or the channelUnreadCount.
  - getChannelUnreadCount
```
 StateFlow<Integer> getChannelUnreadCount()
```
    the number of unread channels for the current user.
  - getErrorEvents
```
 StateFlow<Event<ChatError>> getErrorEvents()
```
    The error event state flow object is triggered when errors in the underlying components occur. The following example shows how to observe these errors
    repo.errorEvent.collect { // create a toast }
  - getMuted
```
 StateFlow<List<Mute>> getMuted()
```
    list of users that you've muted.
  - getChannelMutes
```
 StateFlow<List<ChannelMute>> getChannelMutes()
```
    List of channels you've muted.
  - getBanned
```
 StateFlow<Boolean> getBanned()
```
    if the current user is banned or not.
  - getTypingUpdates
```
 StateFlow<TypingEvent> getTypingUpdates()
```
    Updates about currently typing users in active channels. See TypingEvent.
  - getTypingChannels
```
 StateFlow<Map<String, TypingEvent>> getTypingChannels()
```
    Map of typing users in all active channel. Use io.getstream.chat.android.client.models.Channel.cid to access events for a particular channel.
  - getClientState
```
 ClientState getClientState()
```
  - isOnline
```
 Boolean isOnline()
```
    If the user is online or not.
  - isOffline
```
 Boolean isOffline()
```
    If the user is offline or not.
  - isConnecting
```
 Boolean isConnecting()
```
    If connection is in connecting state.
  - isInitialized
```
 Boolean isInitialized()
```
    If domain state is initialized or not.
  - clearState
```
 Unit clearState()
```
    Clears the state of GlobalState.
  - setErrorEvent
```
 Unit setErrorEvent(Event<ChatError> errorEvent)
```
  - setTotalUnreadCount
```
 Unit setTotalUnreadCount(Integer totalUnreadCount)
```
  - setChannelUnreadCount
```
 Unit setChannelUnreadCount(Integer channelUnreadCount)
```
  - setBanned
```
 Unit setBanned(Boolean banned)
```
  - setChannelMutes
```
 Unit setChannelMutes(List<ChannelMute> channelMutes)
```
  - setMutedUsers
```
 Unit setMutedUsers(List<Mute> mutedUsers)
```
  - tryEmitTypingEvent
```
 Unit tryEmitTypingEvent(String cid, TypingEvent typingEvent)
```
    Tries emit typing event for a particular channel.
    
    Parameters:
    
    cid - The full channel id, i.e.
    
    typingEvent - TypingEvent with information about typing users.

Class GlobalMutableState

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getUser

getInitialized

getConnectionState

getTotalUnreadCount

getChannelUnreadCount

getErrorEvents

getMuted

getChannelMutes

getBanned

getTypingUpdates

getTypingChannels

getClientState

isOnline

isOffline

isConnecting

isInitialized

clearState

setErrorEvent

setTotalUnreadCount

setChannelUnreadCount

setBanned

setChannelMutes

setMutedUsers

tryEmitTypingEvent