FlutterCombainSDK class abstract
Constructors
Properties
-
bluetoothPipeResult
→ ValueNotifier<
FlutterBluetoothPipeResult?> -
no setter
-
currentLocation
↔ ValueNotifier<
FlutterCombainLocation?> -
The current location determined by sdk. This will update after each new scan
The value can be used directly with ValueNotifier.value
You can either attach a on change listener like this:
Example:
getter/setter pair
-
currentMode
→ ValueNotifier<
FlutterModeType> -
Current detected user activity mode
no setter
-
currentModelConfidence
→ ValueNotifier<
int> -
The confidence of the current model, when this is below MODEL_KEEP_SCORE_THRESHOLD
no setter
-
currentModelId
→ ValueNotifier<
int?> -
no setter
- currentRoute → IndoorNavigationRoute?
-
The current route if being routed
no setter
-
getModelEvaluationResult
→ ValueNotifier<
List< FlutterModelEvaluationResult> > -
no setter
-
gpsLocation
→ ValueNotifier<
FlutterGPSLocation?> -
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
-
localLookupPipeResult
→ ValueNotifier<
FlutterLocalLookupPipeResult?> -
Pipes:
The latest pipe result.
Updated after each scan
Null if no scan has been done yet
no setter
-
locationSource
→ ValueNotifier<
FlutterLocationSource> -
no setter
-
lookupFails
→ ValueNotifier<
int> -
no setter
-
nextScanTime
→ ValueNotifier<
DateTime> -
The time when the next scan will be done
This is updated after each scan is done
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
state
→ ValueNotifier<
FlutterSDKInitializationState> -
The current state of the SDK
Use this to track the SDK lifecycle: idle, initializing, initialized, running, failed, closed
no setter
-
wifiPipeResult
→ ValueNotifier<
FlutterWifiPipeResult?> -
no setter
Methods
-
clearData(
) → Future< void> - Clears all stored data, both database and ANN models
-
getAllPlaces(
) → Future< List< FlutterPlace> > -
getFeatureModelNodes(
List< FlutterNodeFloorIndex> ids) → Future<List< FlutterFeatureModelNode> > -
getLastSyncTime(
) → Future< DateTime?> -
getLocalLookupDebugData(
int buildingId) → Future< LocalLookupDebugData> -
getModelByPlace(
FlutterPlace place) → Future< FlutterPositioningModel> -
getPermissionManager(
) → FlutterPermissionManager - The permission manager Useful to check if permissions are granted and ask for permissions
-
getPlace(
int buildingId) → Future< FlutterPlace?> - Fetches the Place entity from local DB Query by buildingId
-
getRoutingProvider(
) → FlutterRoutingProvider - The routing provider
-
getSdkVersion(
) → Future< String> -
getTableData(
String tableName) → Future< List< Map< >String?, String?> > - Gets table data for database inspection
-
initializeSDK(
CombainSDKConfig config) → Future< void> - Initializes the SDK with the provided configuration Must be called after create
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
reSync(
) → Future< void> - Clears all local data and re-syncs everything from the server
-
snapLocationToGraph(
FlutterCombainLocation location) → Future< FlutterPointLLA> -
snapToFeatureModel(
FlutterCombainLocation location, {double maxDistance = 10.0}) → Future< FlutterPointLLA?> -
Snaps the given location to the nearest feature model point within the max distance
Returns null if no point is found within the max distance or no model exists
locationThe location to snapmaxDistanceThe maximum distance in meters to snap to a feature model point (default is 10.0) -
start(
) → Future< void> - Start the location provider This will start the location updates If permission dialog has not been shown it will be shown now If the user has permanently denied the permission this will not work see getPermissionManager for more info
-
stop(
) → Future< void> - Stop the location provider Can be started again with start see start
-
stopRoutingUpdates(
) → Future - Stops receiving routing updates, call this when you are done with routing for performance
-
syncData(
int from) → Future< void> - Syncs the data from the server to the local database This is done automatically depending on syncingInterval defined in the config NativeCombainSDKConfig
-
toString(
) → String -
A string representation of this object.
inherited
-
updateScanningConfig(
FlutterScanningConfig newConfig) → Future< void>
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
-
syncProgress
↔ ValueNotifier<
double> -
A double that represents the progress of the syncing
0.0 is not started
1.0 is done
getter/setter pair
Static Methods
-
create(
{required dynamic constructorConfig}) → Future< FlutterCombainSDK> - Creates a new SDK instance with constructor configuration This must be called before initializeSDK