DeviceRegistration class
Identifies the physical device that fills a DeviceConfiguration role in a deployment.
A registration is sent to the DeploymentService with
registerDevice when a device joins a study deployment.
Treat this as an abstract base class. If a simple device registration is
needed, use a DefaultDeviceRegistration.
- Inheritance
-
- Object
- Serializable
- DeviceRegistration
- Implementers
- Annotations
-
- @JsonSerializable.new(includeIfNull: false, explicitToJson: true)
Constructors
- DeviceRegistration({String? deviceId, String? deviceDisplayName, DateTime? registrationCreatedOn})
-
DeviceRegistration.fromJson(Map<
String, dynamic> json) -
factory
Properties
- $type ↔ String?
-
The type name written to
__typein JSON; set tojsonTypeon creation.getter/setter pairinherited - deviceDisplayName ↔ String?
-
An optional concise textual representation for display purposes describing
the key specifications of the device.
E.g., device manufacturer, name, and operating system version.
getter/setter pair
- deviceId ↔ String
-
An ID for the device, used to disambiguate between devices of the same type,
as provided by the device itself.
It is up to specific types of devices to guarantee uniqueness across all
devices of the same type. A random UUID (v4) if not specified.
getter/setter pair
- 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 setteroverride - registrationCreatedOn ↔ DateTime
-
The registration time in UTC. Defaults to the time of creation.
getter/setter pair
- 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
-
toJson(
) → Map< String, dynamic> -
Returns a JSON map of this object, including the
__typeproperty.override -
toString(
) → String -
A string representation of this object.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited