carp_deployment/carp_core_deployment library
Maps the information specified in a study protocol to runtime configurations used by the 'clients' subsystem to run the protocol on concrete devices (e.g., a smartphone) and allow researchers to monitor their state. To start collecting data, participants need to be invited, devices need to be registered, and consent needs to be given to collect the requested data.
Contains the core deployment classes like MasterDeviceDeployment, StudyDeployment, ParticipantData, and DeploymentService.
See the carp.deployments
definition in Kotlin.
Classes
- AccountIdentity
-
Identifies an
Account. - ActiveParticipationInvitation
- An invitation to participate in an active study deployment using the specified master devices. Some of the devices which the participant is invited to might already be registered. If the participant wants to use a different device, they will need to unregister the existing device first.
- CreateStudyDeployment
- A request for creating a deployment based on the protocol.
- DataEndPoint
- Specify an endpoint where a DataManager can upload data.
- DataEndPointTypes
- A enumeration of known (but not necessarily implemented) endpoint API types.
- DeploymentService
- Application service which allows deploying StudyProtocols and retrieving MasterDeviceDeployments for participating master devices as defined in the protocol.
- DeploymentServiceRequest
- A DeploymentServiceRequest and all its sub-classes contain the data for sending a RPC request to the CARP web service.
- DeploymentSuccessful
- A request for reporting this deployment as successful.
- DeviceDeploymentStatus
- A DeviceDeploymentStatus represents the status of a device in a deployment.
- DeviceInvitation
- Holds device invitation details.
- DeviceRegistration
- A DeviceRegistration configures a DeviceDescriptor as part of the deployment of a StudyProtocol.
- EmailAccountIdentity
- Identifies an AccountIdentity using an email adress.
- GetActiveParticipationInvitations
- A request for getting the deployment invitations for an account id.
- GetDeviceDeploymentFor
- A request for getting the deployment for this master device.
- GetParticipantData
- A request for getting the status of a study deployment.
- GetParticipantDataList
- A request for getting the list of participation data for this a list of studyDeploymentIds.
- GetStudyDeploymentStatus
- A request for getting the status of a study deployment.
- GetStudyDeploymentStatusList
- A request for getting the status of a list of study deployment.
- MasterDeviceDeployment
- Contains the entire description and configuration for how a single master device participates in running a study.
- ParticipantData
- Expected participant data for all participants in a study deployment with studyDeploymentId.
- Participation
- Uniquely identifies the participation of an account in a study deployment.
- ParticipationService
- Application service which allows inviting participants, retrieving participations for study deployments, and managing data related to participants which is input by users.
- ParticipationServiceRequest
- A ParticipationServiceRequest and its sub-classes contain the data for sending a participant request to the CARP web service.
- RegisterDevice
- A request for registering this device.
- SetParticipantData
- A request for adding data for a participant.
- Stop
- A request for permanently stopping a study deployment.
- StudyDeployment
- A single instantiation of a StudyProtocol, taking care of common concerns related to devices when 'running' a study.
- StudyDeploymentStatus
- A StudyDeploymentStatus represents the status of a deployment as returned from the CARP web service.
- StudyInvitation
- A description of a study, shared with participants once they are invited to a study.
- UnregisterDevice
- A request for unregistering this device.
Enums
- DeviceDeploymentStatusTypes
- The types of device deployment status.
- StudyDeploymentStatusTypes
- The types of study deployment status.