SdkConfig class

Configures SDK initialization.

This is the main package configuration object. It defines the base URL, response contract, output normalization, authentication settings, interceptors, and the concrete stores or transport implementations to use.

Constructors

SdkConfig.new({required String baseUrl, required SdkProfile profile, required SdkContract contract, required OutputOptions output, HttpClient? httpOverride, TokenStore? tokenStoreOverride, AuthOptions? auth, CacheStore? cacheStoreOverride, QueueStore? queueStoreOverride, List<SdkInterceptor>? interceptors, bool offlineQueueEnabled = true})
Creates SDK initialization settings.
const

Properties

auth → AuthOptions?
Enables the built-in login and refresh helpers when provided.
final
baseUrl → String
Base URL passed to the default DioHttpClient.
final
cacheStoreOverride → CacheStore?
Overrides the cache store used for offline GET fallbacks.
final
contract → SdkContract
Contract used to evaluate backend success and extract response data.
final
hashCode → int
The hash code for this object.
no setterinherited
httpOverride → HttpClient?
Overrides the built-in HTTP client.
final
interceptors → List<SdkInterceptor>
Interceptors executed in registration order.
final
offlineQueueEnabled → bool
Additional queue feature flag for consumers and custom integrations.
final
output → OutputOptions
Output normalization settings applied to transport responses.
final
profile → SdkProfile
Runtime profile controlling offline cache and queue behavior.
final
queueStoreOverride → QueueStore?
Overrides the queue store used for offline write persistence.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tokenStoreOverride → TokenStore?
Overrides the token store used by the built-in authentication manager.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited