CarpDeploymentService class
A DeploymentService
that talks to the CARP backend server(s).
- Inheritance
-
- Object
- CarpBaseService
- CarpDeploymentService
Constructors
- CarpDeploymentService()
-
Returns the singleton default instance of the CarpDeploymentService.
Before this instance can be used, it must be configured using the configure method.
factory
Properties
- app → CarpApp?
-
The CARP app associated with the CARP Web Service.
Returns
null
if this service has not yet been congfigured via the configure method.no setterinherited - currentUser → CarpUser?
-
Gets the current user.
Returns
null
if no user is authenticated.no setterinherited - hashCode → int
-
The hash code for this object.
no setterinherited
-
headers
→ Map<
String, String> -
The headers for any authenticated HTTP REST call to a CarpBaseService.
no setterinherited
- isConfigured → bool
-
Has this service been configured?
no setterinherited
- rpcEndpointName → String
-
The endpoint name for this service at CARP.
no setteroverride
- rpcEndpointUri → String
-
The URL for this service's endpoint at CARP.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
configure(
CarpApp app) → void -
Configure the this instance of a Carp Service.
inherited
-
configureFrom(
CarpBaseService service) → void -
Configure from another
service
which has alreay been configured and potentially authenticated.inherited -
createStudyDeployment(
StudyProtocol protocol, [String? studyDeploymentId]) → Future< StudyDeploymentStatus> -
Create a new deployment in CANS based on a
StudyProtocol
. ThestudyDeploymentId
is ignored, since CANS generated its own study deployment id.override -
deployment(
[String? studyDeploymentId]) → DeploymentReference -
Gets a DeploymentReference for a
studyDeploymentId
. If thestudyDeploymentId
is not provided, the study deployment id specified in the CarpApp is used. -
deploymentSuccessfulFor(
String studyDeploymentId, String masterDeviceRoleName, DateTime deviceDeploymentLastUpdateDate) → Future< StudyDeploymentStatus> -
Indicate to stakeholders in the study deployment with
studyDeploymentId
that the device withmasterDeviceRoleName
was deployed successfully, using the deployment with the specifieddeviceDeploymentLastUpdateDate
, i.e., that the study deployment was loaded on the device and that the necessary runtime is available to run it.override -
getDeviceDeploymentFor(
String studyDeploymentId, String masterDeviceRoleName) → Future< MasterDeviceDeployment> -
Get the deployment configuration for the master device with
masterDeviceRoleName
in the study deployment withstudyDeploymentId
.override -
getStudyDeploymentStatus(
String studyDeploymentId) → Future< StudyDeploymentStatus> -
Get the status for a study deployment with the given
studyDeploymentId
.override -
getStudyDeploymentStatusList(
List< String> studyDeploymentIds) → Future<List< StudyDeploymentStatus> > -
Get the statuses for a set of deployments with the specified
studyDeploymentIds
.override -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerDevice(
String studyDeploymentId, String deviceRoleName, DeviceRegistration registration) → Future< StudyDeploymentStatus> -
Register the device with the specified
deviceRoleName
for the study deployment withstudyDeploymentId
.override -
removeStudyDeployments(
Set< String> studyDeploymentIds) → Future<Set< String> > -
Remove study deployments with the given
studyDeploymentIds
.override -
stop(
String studyDeploymentId) → Future< StudyDeploymentStatus> -
Permanently stop the study deployment with the specified
studyDeploymentId
. No further changes to this deployment will be allowed and no more data will be collected.override -
toString(
) → String -
A string representation of this object.
inherited
-
unregisterDevice(
String studyDeploymentId, String deviceRoleName) → Future< StudyDeploymentStatus> -
Unregister the device with the specified
deviceRoleName
for the study deployment withstudyDeploymentId
.override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited