-
public final class ChatClientConfigProvides a configuration for the ChatClient behavior.
-
-
Field Summary
Fields Modifier and Type Field Description private final BooleanofflineEnabledprivate final Set<String>ignoredOfflineChannelTypesprivate final BooleanuserPresenceprivate final BooleanisAutomaticSyncOnReconnectEnabledprivate final TimeDurationsyncMaxThresholdprivate final Function0<Long>nowprivate final MessageLimitConfigmessageLimitConfigprivate final BooleanuseLegacyChannelLogicprivate final BooleanfastEventParsingprivate final StreamCacheConfigcacheConfigprivate final BooleanisLocalUnreadCountEnabled
-
Constructor Summary
Constructors Constructor Description ChatClientConfig(Boolean offlineEnabled, Set<String> ignoredOfflineChannelTypes, Boolean userPresence, Boolean isAutomaticSyncOnReconnectEnabled, TimeDuration syncMaxThreshold, Function0<Long> now, MessageLimitConfig messageLimitConfig, Boolean useLegacyChannelLogic, Boolean fastEventParsing, StreamCacheConfig cacheConfig, Boolean isLocalUnreadCountEnabled)ChatClientConfig(Boolean offlineEnabled, Set<String> ignoredOfflineChannelTypes, Boolean userPresence, Boolean isAutomaticSyncOnReconnectEnabled, TimeDuration syncMaxThreshold, Function0<Long> now, MessageLimitConfig messageLimitConfig, Boolean useLegacyChannelLogic, Boolean fastEventParsing, StreamCacheConfig cacheConfig)ChatClientConfig(Boolean offlineEnabled, Set<String> ignoredOfflineChannelTypes, Boolean userPresence, Boolean isAutomaticSyncOnReconnectEnabled, TimeDuration syncMaxThreshold, Function0<Long> now, MessageLimitConfig messageLimitConfig, Boolean useLegacyChannelLogic, Boolean fastEventParsing)ChatClientConfig(Boolean offlineEnabled, Set<String> ignoredOfflineChannelTypes, Boolean userPresence, Boolean isAutomaticSyncOnReconnectEnabled, TimeDuration syncMaxThreshold, Function0<Long> now, MessageLimitConfig messageLimitConfig, Boolean useLegacyChannelLogic)ChatClientConfig(Boolean offlineEnabled, Set<String> ignoredOfflineChannelTypes, Boolean userPresence, Boolean isAutomaticSyncOnReconnectEnabled, TimeDuration syncMaxThreshold, Function0<Long> now, MessageLimitConfig messageLimitConfig)ChatClientConfig(Boolean offlineEnabled, Set<String> ignoredOfflineChannelTypes, Boolean userPresence, Boolean isAutomaticSyncOnReconnectEnabled, TimeDuration syncMaxThreshold, Function0<Long> now)ChatClientConfig(Boolean offlineEnabled, Set<String> ignoredOfflineChannelTypes, Boolean userPresence, Boolean isAutomaticSyncOnReconnectEnabled, TimeDuration syncMaxThreshold)ChatClientConfig(Boolean offlineEnabled, Set<String> ignoredOfflineChannelTypes, Boolean userPresence, Boolean isAutomaticSyncOnReconnectEnabled)ChatClientConfig(Boolean offlineEnabled, Set<String> ignoredOfflineChannelTypes, Boolean userPresence)ChatClientConfig(Boolean offlineEnabled, Set<String> ignoredOfflineChannelTypes)ChatClientConfig(Boolean offlineEnabled)ChatClientConfig()
-
Method Summary
Modifier and Type Method Description final BooleangetOfflineEnabled()final Set<String>getIgnoredOfflineChannelTypes()final BooleangetUserPresence()final BooleangetIsAutomaticSyncOnReconnectEnabled()final TimeDurationgetSyncMaxThreshold()final Function0<Long>getNow()final MessageLimitConfiggetMessageLimitConfig()final BooleangetUseLegacyChannelLogic()final BooleangetFastEventParsing()final StreamCacheConfiggetCacheConfig()final BooleangetIsLocalUnreadCountEnabled()-
-
Constructor Detail
-
ChatClientConfig
ChatClientConfig(Boolean offlineEnabled, Set<String> ignoredOfflineChannelTypes, Boolean userPresence, Boolean isAutomaticSyncOnReconnectEnabled, TimeDuration syncMaxThreshold, Function0<Long> now, MessageLimitConfig messageLimitConfig, Boolean useLegacyChannelLogic, Boolean fastEventParsing, StreamCacheConfig cacheConfig, Boolean isLocalUnreadCountEnabled)
- Parameters:
offlineEnabled- Flag to enable or disable offline support.ignoredOfflineChannelTypes- Set of channel types to be ignored by offline support.userPresence- Controls whether the SDK subscribes to and processes user presence events (online/offline status, last active time).isAutomaticSyncOnReconnectEnabled- Specifies if local data is updated with subscribing to web-socket events after reconnection.syncMaxThreshold- The maximum age threshold for pending local operations (channels, messages, reactions) before they are considered too old to retry and are discarded.now- A function that provides the current time in milliseconds since epoch (Unix timestamp).messageLimitConfig- Configuration that controls the maximum number of messages kept in memory for different channel types.useLegacyChannelLogic- When set to true, the SDK uses the legacy channel state management logic for handling channel updates and events.fastEventParsing- Enables the fast event-parsing path for incoming WebSocket events.cacheConfig- Configuration for the SDK's user-configurable on-disk caches.isLocalUnreadCountEnabled- When enabled, the per-channel unread count is tracked on-device for channels where server-side read events are disabled (io.getstream.chat.android.models.Config.readEventsEnabled isfalse, typical for livestream channels): incoming messages increment a local counter and marking the channel as read resets it without a network request.
-
ChatClientConfig
ChatClientConfig(Boolean offlineEnabled, Set<String> ignoredOfflineChannelTypes, Boolean userPresence, Boolean isAutomaticSyncOnReconnectEnabled, TimeDuration syncMaxThreshold, Function0<Long> now, MessageLimitConfig messageLimitConfig, Boolean useLegacyChannelLogic, Boolean fastEventParsing, StreamCacheConfig cacheConfig)
- Parameters:
offlineEnabled- Flag to enable or disable offline support.ignoredOfflineChannelTypes- Set of channel types to be ignored by offline support.userPresence- Controls whether the SDK subscribes to and processes user presence events (online/offline status, last active time).isAutomaticSyncOnReconnectEnabled- Specifies if local data is updated with subscribing to web-socket events after reconnection.syncMaxThreshold- The maximum age threshold for pending local operations (channels, messages, reactions) before they are considered too old to retry and are discarded.now- A function that provides the current time in milliseconds since epoch (Unix timestamp).messageLimitConfig- Configuration that controls the maximum number of messages kept in memory for different channel types.useLegacyChannelLogic- When set to true, the SDK uses the legacy channel state management logic for handling channel updates and events.fastEventParsing- Enables the fast event-parsing path for incoming WebSocket events.cacheConfig- Configuration for the SDK's user-configurable on-disk caches.
-
ChatClientConfig
ChatClientConfig(Boolean offlineEnabled, Set<String> ignoredOfflineChannelTypes, Boolean userPresence, Boolean isAutomaticSyncOnReconnectEnabled, TimeDuration syncMaxThreshold, Function0<Long> now, MessageLimitConfig messageLimitConfig, Boolean useLegacyChannelLogic, Boolean fastEventParsing)
- Parameters:
offlineEnabled- Flag to enable or disable offline support.ignoredOfflineChannelTypes- Set of channel types to be ignored by offline support.userPresence- Controls whether the SDK subscribes to and processes user presence events (online/offline status, last active time).isAutomaticSyncOnReconnectEnabled- Specifies if local data is updated with subscribing to web-socket events after reconnection.syncMaxThreshold- The maximum age threshold for pending local operations (channels, messages, reactions) before they are considered too old to retry and are discarded.now- A function that provides the current time in milliseconds since epoch (Unix timestamp).messageLimitConfig- Configuration that controls the maximum number of messages kept in memory for different channel types.useLegacyChannelLogic- When set to true, the SDK uses the legacy channel state management logic for handling channel updates and events.fastEventParsing- Enables the fast event-parsing path for incoming WebSocket events.
-
ChatClientConfig
ChatClientConfig(Boolean offlineEnabled, Set<String> ignoredOfflineChannelTypes, Boolean userPresence, Boolean isAutomaticSyncOnReconnectEnabled, TimeDuration syncMaxThreshold, Function0<Long> now, MessageLimitConfig messageLimitConfig, Boolean useLegacyChannelLogic)
- Parameters:
offlineEnabled- Flag to enable or disable offline support.ignoredOfflineChannelTypes- Set of channel types to be ignored by offline support.userPresence- Controls whether the SDK subscribes to and processes user presence events (online/offline status, last active time).isAutomaticSyncOnReconnectEnabled- Specifies if local data is updated with subscribing to web-socket events after reconnection.syncMaxThreshold- The maximum age threshold for pending local operations (channels, messages, reactions) before they are considered too old to retry and are discarded.now- A function that provides the current time in milliseconds since epoch (Unix timestamp).messageLimitConfig- Configuration that controls the maximum number of messages kept in memory for different channel types.useLegacyChannelLogic- When set to true, the SDK uses the legacy channel state management logic for handling channel updates and events.
-
ChatClientConfig
ChatClientConfig(Boolean offlineEnabled, Set<String> ignoredOfflineChannelTypes, Boolean userPresence, Boolean isAutomaticSyncOnReconnectEnabled, TimeDuration syncMaxThreshold, Function0<Long> now, MessageLimitConfig messageLimitConfig)
- Parameters:
offlineEnabled- Flag to enable or disable offline support.ignoredOfflineChannelTypes- Set of channel types to be ignored by offline support.userPresence- Controls whether the SDK subscribes to and processes user presence events (online/offline status, last active time).isAutomaticSyncOnReconnectEnabled- Specifies if local data is updated with subscribing to web-socket events after reconnection.syncMaxThreshold- The maximum age threshold for pending local operations (channels, messages, reactions) before they are considered too old to retry and are discarded.now- A function that provides the current time in milliseconds since epoch (Unix timestamp).messageLimitConfig- Configuration that controls the maximum number of messages kept in memory for different channel types.
-
ChatClientConfig
ChatClientConfig(Boolean offlineEnabled, Set<String> ignoredOfflineChannelTypes, Boolean userPresence, Boolean isAutomaticSyncOnReconnectEnabled, TimeDuration syncMaxThreshold, Function0<Long> now)
- Parameters:
offlineEnabled- Flag to enable or disable offline support.ignoredOfflineChannelTypes- Set of channel types to be ignored by offline support.userPresence- Controls whether the SDK subscribes to and processes user presence events (online/offline status, last active time).isAutomaticSyncOnReconnectEnabled- Specifies if local data is updated with subscribing to web-socket events after reconnection.syncMaxThreshold- The maximum age threshold for pending local operations (channels, messages, reactions) before they are considered too old to retry and are discarded.now- A function that provides the current time in milliseconds since epoch (Unix timestamp).
-
ChatClientConfig
ChatClientConfig(Boolean offlineEnabled, Set<String> ignoredOfflineChannelTypes, Boolean userPresence, Boolean isAutomaticSyncOnReconnectEnabled, TimeDuration syncMaxThreshold)
- Parameters:
offlineEnabled- Flag to enable or disable offline support.ignoredOfflineChannelTypes- Set of channel types to be ignored by offline support.userPresence- Controls whether the SDK subscribes to and processes user presence events (online/offline status, last active time).isAutomaticSyncOnReconnectEnabled- Specifies if local data is updated with subscribing to web-socket events after reconnection.syncMaxThreshold- The maximum age threshold for pending local operations (channels, messages, reactions) before they are considered too old to retry and are discarded.
-
ChatClientConfig
ChatClientConfig(Boolean offlineEnabled, Set<String> ignoredOfflineChannelTypes, Boolean userPresence, Boolean isAutomaticSyncOnReconnectEnabled)
- Parameters:
offlineEnabled- Flag to enable or disable offline support.ignoredOfflineChannelTypes- Set of channel types to be ignored by offline support.userPresence- Controls whether the SDK subscribes to and processes user presence events (online/offline status, last active time).isAutomaticSyncOnReconnectEnabled- Specifies if local data is updated with subscribing to web-socket events after reconnection.
-
ChatClientConfig
ChatClientConfig(Boolean offlineEnabled, Set<String> ignoredOfflineChannelTypes, Boolean userPresence)
- Parameters:
offlineEnabled- Flag to enable or disable offline support.ignoredOfflineChannelTypes- Set of channel types to be ignored by offline support.userPresence- Controls whether the SDK subscribes to and processes user presence events (online/offline status, last active time).
-
ChatClientConfig
ChatClientConfig(Boolean offlineEnabled, Set<String> ignoredOfflineChannelTypes)
- Parameters:
offlineEnabled- Flag to enable or disable offline support.ignoredOfflineChannelTypes- Set of channel types to be ignored by offline support.
-
ChatClientConfig
ChatClientConfig(Boolean offlineEnabled)
- Parameters:
offlineEnabled- Flag to enable or disable offline support.
-
ChatClientConfig
ChatClientConfig()
-
-
Method Detail
-
getOfflineEnabled
final Boolean getOfflineEnabled()
-
getIgnoredOfflineChannelTypes
final Set<String> getIgnoredOfflineChannelTypes()
-
getUserPresence
final Boolean getUserPresence()
-
getIsAutomaticSyncOnReconnectEnabled
final Boolean getIsAutomaticSyncOnReconnectEnabled()
-
getSyncMaxThreshold
final TimeDuration getSyncMaxThreshold()
-
getMessageLimitConfig
final MessageLimitConfig getMessageLimitConfig()
-
getUseLegacyChannelLogic
final Boolean getUseLegacyChannelLogic()
-
getFastEventParsing
final Boolean getFastEventParsing()
-
getCacheConfig
final StreamCacheConfig getCacheConfig()
-
getIsLocalUnreadCountEnabled
final Boolean getIsLocalUnreadCountEnabled()
-
-
-
-