OneTimeTrigger class

A trigger that triggers only once during a deployment.

In contrast to ImmediateTrigger, which triggers every time the app is (re)started, this OneTimeTrigger only triggers once during the life-time of a deployment. Useful for triggering e.g., a demographic survey or collecting device information.

Inheritance
  • Object
  • Serializable
  • TriggerConfiguration
  • OneTimeTrigger
Annotations
  • @JsonSerializable.new(includeIfNull: false, explicitToJson: true)

Constructors

OneTimeTrigger()
Create a trigger that triggers once during a deployment.
OneTimeTrigger.fromJson(Map<String, dynamic> json)
factory

Properties

$type ↔ String?
The runtime class name (type) of this object. Used for deserialization from JSON objects.
getter/setter pairinherited
fromJsonFunction → Function
The function which can convert a JSON string to an object of this type.
no setteroverride
hasBeenTriggered → bool
Has this trigger been triggered?
no setter
hashCode → int
The hash code for this object.
no setterinherited
jsonType → String
Return the __type to be used for JSON serialization of this class. Default is runtimeType. Only specify this if you need another type.
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.
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
triggerTimestamp ↔ DateTime?
The timestamp of when this trigger was triggered.
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
Return a JSON encoding of this object.
override
toString() → String
A string representation of this object.
inherited

Operators

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