CarpDeploymentService class

A DeploymentService that talks to the CARP Web Services.

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.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

headers → Map<String, String>

The headers for any authenticated HTTP REST call to a CarpBaseService.

no setter, inherited

isConfigured → bool

Has this service been configured?

no setter, inherited

rpcEndpointName → String

The endpoint name for this service at CARP.

no setter, override

rpcEndpointUri → String

The URL for this service's endpoint at CARP.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

study ↔ SmartphoneStudy?

The study associated with this service, if available. Can be set directly or as part of the configure methods.

getter/setter pair, inherited

Methods

configure(CarpApp app, [SmartphoneStudy? study]) → void

Configure the this instance of a Carp Service.

inherited

configureFrom(CarpBaseService service) → void

Configure from another service which has already been configured.

inherited

createStudyDeployment(StudyProtocol protocol, [List<ParticipantInvitation> invitations = const [], String? id, Map<String, DeviceRegistration>? connectedDevicePreregistrations]) → Future<StudyDeploymentStatus>

Instantiate a study deployment for a given StudyProtocol with participants defined in invitations.

override

deployment([String? studyDeploymentId]) → DeploymentReference

Gets a DeploymentReference for a studyDeploymentId. studyDeploymentId can be omitted if specified as part of this service's study.

deviceDeployed(String studyDeploymentId, String masterDeviceRoleName, DateTime deviceDeploymentLastUpdatedOn) → Future<StudyDeploymentStatus>

Indicate to stakeholders in the study deployment with studyDeploymentId that the device with primaryDeviceRoleName was deployed successfully, using the deployment with the specified deviceDeploymentLastUpdatedOn, 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 primaryDeviceRoleName) → Future<SmartphoneDeployment>

Get the deployment configuration for the primary device with primaryDeviceRoleName in the study deployment with studyDeploymentId. Returns null if studyDeploymentId is not found.

override

getStudyDeploymentId(String? studyDeploymentId) → String

Resolve study deployment ID.

inherited

getStudyDeploymentStatus(String studyDeploymentId) → Future<StudyDeploymentStatus>

Get the status for a study deployment with the given studyDeploymentId. Returns null if studyDeploymentId is not found.

override

getStudyDeploymentStatusList(List<String> studyDeploymentIds) → Future<List<StudyDeploymentStatus>>

Get the statuses for a set of deployments with the specified studyDeploymentIds.

override

getStudyId(String? studyId) → String

Resolve study ID.

inherited

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 with studyDeploymentId.

override

removeStudyDeployments(Set<String> studyDeploymentIds) → Future<Set<String>>

Remove study deployments with the given studyDeploymentIds. This also removes all data related to the study deployments.

override

stop(String studyDeploymentId) → Future<StudyDeploymentStatus>

Permanently stop the study deployment with the specified studyDeploymentId.

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 with studyDeploymentId. Returns null if studyDeploymentId is not found.

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited