CustomDynamicEntityDataProvider class abstract

Defines a provider of CustomDynamicEntityDataEvents.

Extend this class to supply custom dynamic entity data to a CustomDynamicEntityDataSource.

The provider methods are tied to the CustomDynamicEntityDataSource lifecycle:

  • onLoad: Called when the data source is loaded. Returns a DynamicEntityDataSourceInfo containing information about the data source. This is required before connecting.
  • onConnect: Called when the data source is connected.
  • onDisconnect: Called when the data source is disconnected.

Constructors

CustomDynamicEntityDataProvider()

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

handleEntityDataEvent(CustomDynamicEntityDataEvent event) → void
Handle a CustomDynamicEntityDataEvent emitted by the provider.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onConnect() Future<void>
Called when the associated CustomDynamicEntityDataSource is connected.
onDisconnect() Future<void>
Called when the associated CustomDynamicEntityDataSource is disconnected. When completed cleanup of resources can be performed.
onLoad() Future<DynamicEntityDataSourceInfo>
Called when the associated CustomDynamicEntityDataSource is loaded. Returns a DynamicEntityDataSourceInfo containing information about the data source. This is required to complete before connecting.
toString() String
A string representation of this object.
inherited

Operators

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