AppSettingsBuilder class
Builder class for AppSettings.
Allows step-by-step creation of an AppSettings object.
Constructors
- AppSettingsBuilder()
-
Default constructor for
AppSettingsBuilder.
Properties
- adminHost ↔ String?
-
Hostname for the admin server.
getter/setter pair
- autoEstablishSocketConnection ↔ bool
-
Flag to establish socket connection automatically, set to true by default.
getter/setter pair
- clientHost ↔ String?
-
Hostname for the client server.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- isAutoJoinEnabled ↔ bool
-
Flag indicating if auto join is enabled (deprecated, defaults to true).
Android Reference:
AppSettingsBuilder.isAutoJoinEnabledgetter/setter pair - loggerConfig ↔ LoggerConfig?
-
Logger configuration (optional, disabled by default).
getter/setter pair
- maxReconnectionAttempts ↔ int?
-
Maximum reconnection attempts (optional, null = unlimited).
getter/setter pair
- presenceEnabled ↔ bool
-
Whether presence update processing is enabled (default: true).
getter/setter pair
- readReceiptsEnabled ↔ bool
-
Whether read receipt processing is enabled (default: true).
getter/setter pair
- region ↔ String?
-
Region of the application.
getter/setter pair
-
roles
↔ List<
String> ? -
List of roles in the application.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- subscriptionType ↔ String?
-
Type of the application subscription.
getter/setter pair
- typingIndicatorsEnabled ↔ bool
-
Whether typing indicator processing is enabled (default: true).
getter/setter pair
- webSocketHost ↔ String?
-
WebSocket host (optional).
getter/setter pair
- webSocketPort ↔ String?
-
WebSocket port (optional).
getter/setter pair
- webSocketTimeout ↔ int?
-
WebSocket connection timeout in seconds (optional, defaults to 5).
getter/setter pair
Methods
-
build(
) → AppSettings -
Builds and returns an
AppSettingsobject. -
disablePresence(
) → AppSettingsBuilder - Disables presence update processing. When disabled, presence events from the WebSocket are silently dropped.
-
disableReadReceipts(
) → AppSettingsBuilder - Disables read receipt processing. When disabled, receipt events from the WebSocket are silently dropped.
-
disableTypingIndicators(
) → AppSettingsBuilder - Disables typing indicator processing. When disabled, typing events from the WebSocket are silently dropped, reducing CPU overhead.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
overrideAdminHost(
String adminHost) → AppSettingsBuilder -
Overrides the admin host URL.
Android Reference:
AppSettingsBuilder.overrideAdminHost(String) -
overrideClientHost(
String clientHost) → AppSettingsBuilder -
Overrides the client host URL.
Android Reference:
AppSettingsBuilder.overrideClientHost(String) -
setAutoEstablishSocketConnection(
bool autoEstablishSocketConnection) → AppSettingsBuilder -
Sets the auto establish socket connection flag.
Android Reference:
AppSettingsBuilder.setAutoEstablishSocketConnection(bool) -
setAutoJoinEnabled(
bool isAutoJoinEnabled) → AppSettingsBuilder -
Sets the auto join enabled flag (deprecated).
Android Reference:
AppSettingsBuilder.setAutoJoinEnabled(bool) -
setLoggerConfig(
LoggerConfig loggerConfig) → AppSettingsBuilder - Sets the logger configuration.
-
setMaxReconnectionAttempts(
int maxReconnectionAttempts) → AppSettingsBuilder -
Sets the maximum reconnection attempts.
Android Reference:
AppSettingsBuilder.setMaxReconnectionAttempts(int) -
setRegion(
String region) → AppSettingsBuilder -
Sets the region.
Android Reference:
AppSettingsBuilder.setRegion(String region) -
setWebSocketHost(
String webSocketHost) → AppSettingsBuilder -
Sets the WebSocket host.
Android Reference:
AppSettingsBuilder.setWebSocketHost(String) -
setWebSocketPort(
String webSocketPort) → AppSettingsBuilder -
Sets the WebSocket port.
Android Reference:
AppSettingsBuilder.setWebSocketPort(String) -
setWebSocketTimeout(
int webSocketTimeout) → AppSettingsBuilder -
Sets the WebSocket connection timeout in seconds.
Android Reference:
AppSettingsBuilder.setWebSocketTimeout(int) -
subscribePresenceForAllUsers(
) → AppSettingsBuilder -
Sets presence subscription to all users.
Android Reference:
AppSettingsBuilder.subscribePresenceForAllUsers() -
subscribePresenceForFriends(
) → AppSettingsBuilder -
Sets presence subscription to friends.
Android Reference:
AppSettingsBuilder.subscribePresenceForFriends() -
subscribePresenceForRoles(
List< String> roles) → AppSettingsBuilder -
Sets presence subscription to specific roles.
Android Reference:
AppSettingsBuilder.subscribePresenceForRoles(List<String> roles) -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited