AppLifecycleTrigger class
A trigger that triggers when the life cycle of an app changes.
The state changes that triggers are specified in states. If not specified (default) this trigger will trigger on all AppLifecycleState changes.
Typically used to make sure to collect measures when the app life cycle is changing, e.g., moved to the background or foreground. Some measures - like audio, bluetooth, and health - can only be collected when the app is in the foreground.
- Inheritance
-
- Object
- Serializable
- TriggerConfiguration
- AppLifecycleTrigger
- Annotations
-
- @JsonSerializable.new(includeIfNull: false, explicitToJson: true)
Constructors
-
AppLifecycleTrigger([Set<
AppLifecycleState> ? states]) -
Creates an AppLifecycleTrigger that triggers whenever the app state changes.
If
statesis not specified, it will trigger on all state change events. -
AppLifecycleTrigger.fromJson(Map<
String, dynamic> json) -
factory
Properties
- $type ↔ String?
-
The type name written to
__typein JSON; set tojsonTypeon creation.getter/setter pairinherited - fromJsonFunction → Function
-
The generated function that converts a JSON map to an object of this type.
no setteroverride
- hashCode → int
-
The hash code for this object.
no setterinherited
- jsonType → String
-
The
__typeused for JSON serialization of this class.no setterinherited - requiresPrimaryDevice ↔ bool?
-
Determines whether the trigger needs to be evaluated on a primary
device (
PrimaryDeviceConfiguration). For example, this is the case when the trigger is time bound and needs to be evaluated by a task scheduler running on a primary device. Not serialized.getter/setter pairinherited - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- sourceDeviceRoleName ↔ String?
-
The device role name from which the trigger originates.
getter/setter pairinherited
-
states
↔ Set<
AppLifecycleState> -
The app life cycle states that fire this trigger.
getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> -
Returns a JSON map of this object, including the
__typeproperty.override -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited