Package 

Interface GlobalState

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      abstract Boolean isOnline() If the user is online or not.
      abstract Boolean isOffline() If the user is offline or not.
      abstract Boolean isConnecting() If connection is in connecting state.
      abstract Boolean isInitialized() If domain state is initialized or not.
      abstract Unit clearState() Clears the state of GlobalState.
      abstract StateFlow<User> getUser() The current user in the OfflinePlugin state.
      abstract StateFlow<Boolean> getInitialized() If the client connection has been initialized.
      abstract StateFlow<ConnectionState> getConnectionState() StateFlow<ConnectionState> that indicates if we are currently online, connecting of offline.
      abstract StateFlow<Integer> getTotalUnreadCount() The total unread message count for the current user.
      abstract StateFlow<Integer> getChannelUnreadCount() the number of unread channels for the current user.
      abstract StateFlow<Event<ChatError>> getErrorEvents() The error event state flow object is triggered when errors in the underlying components occur.
      abstract StateFlow<List<Mute>> getMuted() list of users that you've muted.
      abstract StateFlow<List<ChannelMute>> getChannelMutes() List of channels you've muted.
      abstract StateFlow<Boolean> getBanned() if the current user is banned or not.
      abstract StateFlow<Map<String, TypingEvent>> getTypingChannels() Map of typing users in all active channel.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • isOnline

        @Deprecated(message = "Use ClientState.isOnline() instead.", replaceWith = @ReplaceWith(imports = {"io.getstream.chat.android.client.ChatClient", "io.getstream.chat.android.offline.extensions.clientState"}, expression = "ChatClient.instance().clientState.isOnline"), level = DeprecationLevel.ERROR) abstract Boolean isOnline()

        If the user is online or not.

      • isOffline

        @Deprecated(message = "Use ClientState.isOffline() instead.", replaceWith = @ReplaceWith(imports = {"io.getstream.chat.android.client.ChatClient", "io.getstream.chat.android.offline.extensions.clientState"}, expression = "ChatClient.instance().clientState.isOffline"), level = DeprecationLevel.ERROR) abstract Boolean isOffline()

        If the user is offline or not.

      • isConnecting

        @Deprecated(message = "Use ClientState.isConnecting() instead.", replaceWith = @ReplaceWith(imports = {"io.getstream.chat.android.client.ChatClient", "io.getstream.chat.android.offline.extensions.clientState"}, expression = "ChatClient.instance().clientState.isConnecting"), level = DeprecationLevel.ERROR) abstract Boolean isConnecting()

        If connection is in connecting state.

      • isInitialized

        @Deprecated(message = "Use ClientState.isInitialized() instead.", replaceWith = @ReplaceWith(imports = {"io.getstream.chat.android.client.ChatClient", "io.getstream.chat.android.offline.extensions.clientState"}, expression = "ChatClient.instance().clientState.isInitialized"), level = DeprecationLevel.ERROR) abstract Boolean isInitialized()

        If domain state is initialized or not.

      • getUser

         abstract StateFlow<User> getUser()

        The current user in the OfflinePlugin state.

      • getInitialized

         abstract StateFlow<Boolean> getInitialized()

        If the client connection has been initialized.

      • getConnectionState

         abstract StateFlow<ConnectionState> getConnectionState()

        StateFlow<ConnectionState> that indicates if we are currently online, connecting of offline.

      • getTotalUnreadCount

         abstract 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.

      • getErrorEvents

         abstract 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

         abstract StateFlow<List<Mute>> getMuted()

        list of users that you've muted.

      • getChannelMutes

         abstract StateFlow<List<ChannelMute>> getChannelMutes()

        List of channels you've muted.

      • getBanned

         abstract StateFlow<Boolean> getBanned()

        if the current user is banned or not.

      • getTypingChannels

         abstract 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.