DeploymentReference class

Provide a deployment endpoint reference to a CARP web service.

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 associated 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


deployment MasterDeviceDeployment
The deployment for this master device, once fetched from the server.
hashCode int
The hash code for this object. [...]
read-only, inherited
headers Future<Map<String, String>>
read-only, inherited
registeredDeviceId String
A unique id for this device as registered at CARP. [...]
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
service CarpService
read / write, inherited
status StudyDeploymentStatus
The deployment status for this master device, once fetched from the server.
studyDeploymentId String
The CARP study deployment ID.


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 non-existent method or property is accessed. [...]
registerDevice({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
Returns a string representation of this object.
unRegisterDevice({String deviceRoleName}) Future<StudyDeploymentStatus>
Unregister a device for this deployment at the CARP server. [...]


operator ==(Object other) bool
The equality operator. [...]