StudyDeploymentStatus class

A StudyDeploymentStatus represents the status of a deployment as returned from the CARP web service.

See StudyDeploymentStatus.kt.

Inheritance
  • Object
  • Serializable
  • StudyDeploymentStatus
Annotations
  • @JsonSerializable(fieldRename: FieldRename.none, includeIfNull: false)

Constructors

StudyDeploymentStatus({required String studyDeploymentId, List<DeviceDeploymentStatus> deviceStatusList = const []})
StudyDeploymentStatus.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
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 function which can convert a JSON string to an object of this type.
no setteroverride
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 setteroverride
participantStatusList List<ParticipantStatus>
The list of all participants and their status in this study deployment.
getter/setter pair
primaryDeviceStatus DeviceDeploymentStatus?
The DeviceDeploymentStatus for the primary device of this deployment, which is typically this phone.
no setter
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 device 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.
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.
override

Operators

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