GeigerApiConnector class

Constructors

GeigerApiConnector({required String pluginId, required String pluginName, Function? exceptionHandler})

Properties

currentDeviceId String?
getter/setter pair
currentUserId String?
getter/setter pair
deviceSensorDataRootPath String?
getter/setter pair
exceptionHandler Function?
getter/setter pair
handledEvents List<MessageType>
getter/setter pair
hashCode int
The hash code for this object.
no setterinherited
isPluginListenerRegistered bool
getter/setter pair
isStorageListenerRegistered bool
getter/setter pair
pluginApi GeigerApi?
getter/setter pair
pluginId String
getter/setter pair
pluginListener PluginEventListener?
getter/setter pair
pluginName String
getter/setter pair
recommendationRootPath String?
getter/setter pair
recommendationStatusRootPath String?
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
storageController ↔ StorageController?
getter/setter pair
storageListener StorageEventListener?
getter/setter pair
userSensorDataRootPath String?
getter/setter pair

Methods

addDeviceSensorNode(SensorDataModel sensorDataModel) Future<bool>
addMultilingualValues(Node node, String key, List<MultilingualValues> description) Future<void>
addPluginEventhandler(MessageType type, Function handler) → void
Dynamically define the handler for each plugin event
addUserSensorNode(SensorDataModel sensorDataModel) Future<bool>
callExternalPlugin(String externalPluginId) Future<bool>
Return control - call to open an external plugin by its id
close() Future<void>
Close the geiger api properly
connectToGeigerAPI({String? pluginExecutor, String? masterExecutor}) Future<bool>
Get an instance of GeigerApi, to be able to start working with GeigerToolbox
connectToLocalStorage() Future<bool>
Get an instance of GeigerStorage to read/write data
dumpLocalStorage(String? path) Future<String>
Dump local storage value into terminal
getAllPluginEvents() List<Message>
Get the list of all plugin events
getAllStorageEvents() List<EventChange>
Get all storage change event from Storage Listener
getPluginListenerStats() String
Show some statistics of Listener
getUUID(dynamic key) Future
Get UUID of user or device
isNodeExist(String nodePath) Future<bool>
Verify if a node exist
isRecommendationExist(String rootType, String sensorId) Future<bool>
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
openGeigerToolbox() Future<bool>
Open the Geiger Toolbox
prepareDataRoot() Future<bool>
Prepare some basic data root path
prepareRoot(List<String> rootPath) Future<bool>
Prepare a root node with given path
readDeviceSensorData(String pluginId, String sensorId, String key) Future<String?>
Read a value of device sensor
readUserSensorData(String pluginId, String sensorId, String key) Future<String?>
Read a value of user sensor
registerPluginListener() Future<bool>
registerStorageListener({String? searchPath, Function? storageEventhandler}) Future<bool>
Register the storage listener
resolveRecommendation(String rootType, String sensorId, String geigerValue) Future<bool>
Resolve a recommendation
sendDataNode(String nodeId, String nodePath, List<String> keys, List<String> values) Future<bool>
Send a data node which include creating a new node and write the data
sendDeviceSensorData(String sensorId, String value, {List<MultilingualValues>? description, String? urgency}) Future<bool>
Send some device sensor data to GeigerToolbox
sendPluginEventType(MessageType messageType) Future<bool>
Send a simple Plugin Event which contain only the message type to the GeigerToolbox
sendPluginEventWithPayload(MessageType messageType, String payload) Future<bool>
Send a plugin event with payload
sendRecommendation(String rootType, RecommendationNodeModel recommendationNodeModel) Future<bool>
Add a new recommendation
sendUserSensorData(String sensorId, String value, {List<MultilingualValues>? description, String? urgency}) Future<bool>
Send some user sensor data to GeigerToolbox
showAllPluginEvents() String
showAllStorageEvents() String
toString() String
A string representation of this object.
inherited
updateCurrentIds() Future<bool>
updateMultilingualValues(Node node, String key, List<MultilingualValues> description) Future<void>
updateNodeValue(String nodePath, String key, String value) Future<bool>
Update a node value
updatePluginInfo(String pluginId, String companyName, List<MultilingualValues> description) Future<bool>
Update the information of the external plugin

Operators

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

Static Properties

geigerAPIVersion String
getter/setter pair
geigerLocalStorageVersion String
getter/setter pair
version String
getter/setter pair