DeploymentService class abstract

Application service which allows deploying study protocols to participants and retrieving PrimaryDeviceDeployment's for participating primary devices as defined in the protocol.

Constructors

DeploymentService()

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

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.

deviceDeployed(String studyDeploymentId, String primaryDeviceRoleName, 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.

getDeviceDeploymentFor(String studyDeploymentId, String primaryDeviceRoleName) → Future<PrimaryDeviceDeployment?>

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

getStudyDeploymentStatus(String studyDeploymentId) → Future<StudyDeploymentStatus?>

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

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

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

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.

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

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

stop(String studyDeploymentId) → Future<StudyDeploymentStatus?>

Permanently stop the study deployment with the specified studyDeploymentId.

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.

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

API_VERSION → const String