DeploymentReference class

Provides a reference to the deployment endpoint in a CARP web service that can handle a specific MasterDeviceDeployment.

According to CARP core, the protocol for using the deployment sub-system is:

  • status() - get the study deployment status of this deployment.
  • registerDevice() - register this device - and connected devices - in this deployment
  • get() - get the deployment for this master device
  • success() - report the deployment as successful
  • unRegisterDevice() - unregister this - or other - device if no longer used
Inheritance

Properties

deployment → MasterDeviceDeployment?
The deployment for this master device, once fetched from the server. Returns null if the deployment is not yet fetched.
no setter
hashCode → int
The hash code for this object.
no setterinherited
headers → Map<String, String>
no setterinherited
registeredDeviceId → String
A unique id for this device as registered at CARP.
no setter
rpcEndpointUri → String
The URL for the deployment endpoint.
no setteroverride
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
service ↔ CarpBaseService
getter/setter pairinherited
status → StudyDeploymentStatus?
The latest deployment status for this master device fetched from the server. Returns null if status is not yet fetched.
no setter
studyDeploymentId ↔ String
The CARP study deployment ID.
getter/setter pair

Methods

get() → Future<MasterDeviceDeployment>
Get the deployment for this DeploymentReference for the specified masterDeviceRoleName. If masterDeviceRoleName is not specified, the previously used name is used.
getStatus() → Future<StudyDeploymentStatus>
Get the deployment status for this DeploymentReference.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerDevice({required String deviceRoleName, String? deviceId}) → Future<StudyDeploymentStatus>
Register a device for this deployment at the CARP server.
registerMasterDevice({String? deviceId}) → Future<StudyDeploymentStatus>
Register this device as the master device for this deployment at the CARP server.
success() → Future<StudyDeploymentStatus>
Mark this deployment as a success on the server.
toString() → String
A string representation of this object.
inherited
unRegisterDevice({required String deviceRoleName}) → Future<StudyDeploymentStatus>
Unregister a device for this deployment at the CARP server.

Operators

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