GeigerApi class abstract
The API provided by all communicator interfaces.
- Implementers
Constructors
Properties
- declaration → Declaration
-
Data sharing Declaration.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- id → String
-
Identifier of plugin.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- storage → StorageController
-
StorageController
to access the master storage.no setter
Methods
-
activatePlugin(
) → Future< void> -
Mark this plugin as active on the master.
inherited
-
Authorize the plugin.
inherited
-
close(
) → Future< void> - Release all resources.
-
deactivatePlugin(
) → Future< void> -
Mark this plugin as deactivated on the master.
inherited
-
deregisterListener(
List< MessageType> ? events, PluginListener listener) → void -
Remove the
listener
from specificevents
locally. -
deregisterMenu(
→ Future< )void> -
Removing a menu entry
menuId
from th toolbox core.inherited -
deregisterPlugin(
) → Future< void> -
Unregisters an already registered plugin in the toolbox.
inherited
-
disableMenu(
→ Future< )void> -
Disable a previously registered
menuId
.inherited -
enableMenu(
→ Future< )void> -
Enable a previously registered
menuId
.inherited -
getMenuList(
) → List< MenuItem> -
Get a list of all registered
MenuItem
s. -
getRegisteredPlugins(
[String? startId]) → Future< List< PluginInformation> > -
Get the PluginInformation of all registered plugins.
inherited
-
getStorage(
) → StorageController -
Retrieve the
StorageController
to access the master storage. -
initialize(
) → Future< void> - Initialize asynchronous parts of the plugin.
-
Notify plugin about a MenuItem with a specific
url
being pressed. -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerListener(
List< MessageType> events, PluginListener listener) → void -
Register the
listener
for specificevents
locally. -
registerMenu(
→ Future< )void> -
Register a menu entry
menu
in the toolbox core.inherited -
registerPlugin(
) → Future< void> -
Registers the plugin to the toolbox framework.
inherited
-
scanButtonPressed(
) → Future< void> - Notify all plugins that the scan button was pressed.
-
sendMessage(
Message message, [String? pluginId, PluginInformation? plugin]) → Future< void> -
Send a
message
to a anotherplugin
. -
toString(
) → String -
A string representation of this object.
inherited
-
zapState(
) → Future< void> - Reset the GeigerApi by removing all registered plugins and MenuItems.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
- logger → Logger
-
final
- masterExecutor ↔ String
-
getter/setter pair
- masterUniversalLink ↔ String
-
getter/setter pair