GeigerApiConnector class Null safety


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


currentDeviceId String?
read / write
currentUserId String?
read / write
exceptionHandler Function?
read / write
handledEvents List<MessageType>
read / write
hashCode int
The hash code for this object.
read-only, inherited
isPluginListenerRegistered bool
read / write
isStorageListenerRegistered bool
read / write
pluginApi GeigerApi?
read / write
pluginId String
read / write
pluginListener PluginEventListener?
read / write
pluginName String
read / write
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
storageController StorageController?
read / write
storageListener StorageEventListener?
read / write


addDeviceSensorNode(SensorDataModel sensorDataModel) Future<bool>
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
isDeviceRecommendationExist(String deviceRecommendationId) Future<bool>
isNodeExist(String nodePath) Future<bool>
Verify if a node exist
isUserRecommendationExist(String userRecommendationId) Future<bool>
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
prepareRoot(List<String> rootPath, String? owner) Future<bool>
Prepare a root node with given path
readGeigerValueOfDeviceSensor(String pluginId, String sensorId) Future<String?>
Read a value of device sensor
readGeigerValueOfUserSensor(String pluginId, String sensorId) Future<String?>
Read a value of user sensor
registerPluginListener() Future<bool>
registerStorageListener({String? searchPath, Function? storageEventhandler}) Future<bool>
Register the storage listener
resolveDeviceRecommendation(String recommendationId, String geigerValue) Future<bool>
resolveUserRecommendation(String recommendationId, String geigerValue) Future<bool>
sendDataNode(String nodeId, String nodePath, List<String> keys, List<String> values, String? owner) Future<bool>
Send a data node which include creating a new node and write the data
sendDeviceRecommendation(RecommendationNodeModel recommendationNodeModel) Future<bool>
sendDeviceSensorData(String sensorId, String value) 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
sendUserRecommendation(RecommendationNodeModel recommendationNodeModel) Future<bool>
sendUserSensorData(String sensorId, String value) Future<bool>
Send some user sensor data to GeigerToolbox
showAllPluginEvents() String
showAllStorageEvents() String
toString() String
A string representation of this object.
updateCurrentIds() Future<bool>
updatePluginInfo(String pluginId, String companyName, String description) Future<bool>
Update the information of the external plugin


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

Static Properties

geigerAPIVersion String
read / write
geigerLocalStorageVersion String
read / write
version String
read / write