FlutterCombainSDKConfig class
Configuration for the Combain SDK This class holds all the necessary parameters to initialize the SDK
- Implementers
- Available extensions
Constructors
-
FlutterCombainSDKConfig({required String apiKey, required String settingsKey, required FlutterAppInfo appInfo, String? placeAPI, FlutterLocationProvider? locationProvider, bool? enableAutomaticMode, FlutterRoutingConfig? routingConfig, FlutterSyncingInterval? syncingInterval, String? language, String? brokerUrl, FlutterWifiScanMode? wifiScanMode, bool? bluetoothEnabled, List<
String?> ? beaconUUIDs, FlutterModeManagerConfig? modeManagerConfig})
Properties
- apiKey ↔ String
-
The API key for the Combain SDK. This is used for billing for requests.
getter/setter pair
- appInfo ↔ FlutterAppInfo
-
Application information (package name, version name, version code)
getter/setter pair
-
beaconUUIDs
↔ List<
String?> ? -
List of beacon UUIDs to scan for
getter/setter pair
- bluetoothEnabled ↔ bool?
-
Whether Bluetooth scanning is enabled
getter/setter pair
- brokerUrl ↔ String?
-
The MQTT broker URL to connect to
getter/setter pair
- enableAutomaticMode ↔ bool?
-
Whether to enable automatic mode for the SDK
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setteroverride
- language ↔ String?
-
Language code for translations (e.g., "en" for English)
getter/setter pair
- locationProvider ↔ FlutterLocationProvider?
-
The location provider to use (default is SLAM)
getter/setter pair
- modeManagerConfig ↔ FlutterModeManagerConfig?
-
Custom mode manager configuration
If null, uses default mode manager with standard settings
getter/setter pair
- placeAPI ↔ String?
-
The Place API URL (e.g., "https://indoor.combain.com:3000")
getter/setter pair
- routingConfig ↔ FlutterRoutingConfig?
-
Configuration for routing
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- settingsKey ↔ String
-
The settings key for the Combain SDK. This is used to identify the device and its settings.
getter/setter pair
- syncingInterval ↔ FlutterSyncingInterval?
-
Interval for syncing data (default is OnStart)
getter/setter pair
- wifiScanMode ↔ FlutterWifiScanMode?
-
WiFi scanning mode configuration
getter/setter pair
Methods
-
encode(
) → Object -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
toStringPretty(
) → String -
Available on FlutterCombainSDKConfig, provided by the FlutterCombainSDKConfigExtension extension
Operators
-
operator ==(
Object other) → bool -
The equality operator.
override
Static Methods
-
decode(
Object result) → FlutterCombainSDKConfig