StudyDeploymentStatus class

The status of a study deployment and of its devices and participants.

Returned by most DeploymentService calls and kept in Study.deploymentStatus on the client. A client reads deviceStatusList to see what is needed before its device can be deployed.

See StudyDeploymentStatus.kt.

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

Constructors

StudyDeploymentStatus({required String studyDeploymentId, List<DeviceDeploymentStatus> deviceStatusList = const []})
StudyDeploymentStatus.fromJson(Map<String, dynamic> json)
factory

Properties

$type ↔ String?
The type name written to __type in JSON; set to jsonType on creation.
getter/setter pairinherited
createdOn ↔ DateTime
The time when the deployment was created.
getter/setter pair
deviceStatusList ↔ List<DeviceDeploymentStatus>
The list of all devices part of this study deployment and their status.
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 __type used for JSON serialization of this class.
no setteroverride
participantStatusList ↔ List<ParticipantStatus>
The list of all participants and their status in this study deployment.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
startedOn ↔ DateTime?
The time when the study deployment was ready for the first time (all devices deployed); null otherwise.
getter/setter pair
status ↔ StudyDeploymentStatusTypes?
The status of this study deployment:
getter/setter pair
studyDeploymentId ↔ String
The CARP study deployment ID.
getter/setter pair

Methods

getDeviceStatus(DeviceConfiguration<DeviceRegistration> device) → DeviceDeploymentStatus
Get the status of a device in this study deployment.
getDeviceStatusByRoleName(String roleName) → DeviceDeploymentStatus
Get the status of a device with the given roleName in this study deployment.
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 __type property.
override
toString() → String
A string representation of this object.
override

Operators

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