SideEffectApi class abstract interface

The api given to SideEffects to create their state.

New methods may be added to this interface on any new minor release (minor in terms of semver).

Annotations
  • @experimental

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

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild([void sideEffectMutation(void cancelRebuild())?]) → void
Triggers a rebuild in the supplied capsule.
registerDispose(SideEffectApiCallback callback) → void
Registers the given SideEffectApiCallback to be called on capsule disposal.
runTransaction(void sideEffectTransaction()) → void
Executes the supplied sideEffectTransaction, which simply updates the state of some side effects within a singular rebuild call, rebuilding all appropriate capsules at the conclusion of the transaction.
toString() String
A string representation of this object.
inherited
unregisterDispose(SideEffectApiCallback callback) → void
Unregisters the given SideEffectApiCallback from being called on capsule disposal.

Operators

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