SmartphoneClient class - carp_core_client library

Constructors

deploymentService → DeploymentService?: The application service through which study deployments, to be run on this client, can be managed and retrieved.
no setterinherited
deviceController → DeviceDataCollectorFactory?: The controller of connected devices used to collect data locally on this primary device. Also works as a factory which is used to create DeviceDataCollector instances for connected devices.
no setterinherited
hashCode → int: The hash code for this object.
no setterinherited
isConfigured → bool: Determines whether a DeviceRegistration has been configured for this client, which is necessary to start adding StudyRuntimes.
no setterinherited
registration ↔ DeviceRegistration?: The registration of this client.
getter/setter pairinherited
repository ↔ Map<String, StudyRuntime<DeviceRegistration>>: Repository of StudyRuntime mapped to the study deployment ID.
getter/setter pairinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
studies ↔ Map<String, Study>: All studies added to this client mapped to the study deployment ID.
getter/setter pairinherited

addStudy(Study study) → Future<Study>: Add a study which needs to be executed on this client. This involves registering this device for the specified study deployment.
inherited
configure({required DeploymentService deploymentService, required DeviceDataCollectorFactory deviceController, DeviceRegistration? registration}) → Future<void>: Configure this ClientManager by specifying:
inherited
getStudyRuntime(String studyDeploymentId) → StudyRuntime<DeviceRegistration>?: Get the StudyRuntime for a studyDeploymentId.
inherited
getStudyStatusList() → List<StudyStatus>: Get the status for the studies which run on this client device.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
removeStudy(String studyDeploymentId) → Future<void>: Remove the study with studyDeploymentId from this client manager.
inherited
stopStudy(String studyDeploymentId) → Future<void>: Permanently stop collecting data for study and mark it as stopped.
inherited
toString() → String: A string representation of this object.
inherited
tryDeployment(String studyDeploymentId) → Future<StudyStatus>: Verifies whether the device is ready for deployment of the study runtime identified by study, and in case it is, deploys. In case already deployed, nothing happens and the status of the deployment is returned.
inherited