RecruitmentService

interface RecruitmentService : ApplicationService<RecruitmentService, RecruitmentService.Event>

Application service which allows setting recruitment goals, adding participants to studies, and creating deployments for them.

Types

Event

sealed class Event : IntegrationEvent<RecruitmentService>

Functions

addParticipant

abstract suspend fun addParticipant(studyId: UUID, email: EmailAddress): Participant

Add a Participant to the study with the specified studyId, identified by the specified email address. In case the email was already added before, the same Participant is returned.

getParticipant

abstract suspend fun getParticipant(studyId: UUID, participantId: UUID): Participant

Returns a participant of a study with the specified studyId, identified by participantId.

getParticipantGroupStatusList

abstract suspend fun getParticipantGroupStatusList(studyId: UUID): List<ParticipantGroupStatus>

Get the status of all deployed participant groups in the study with the specified studyId.

getParticipants

abstract suspend fun getParticipants(studyId: UUID): List<Participant>

Get all Participants for the study with the specified studyId.

inviteNewParticipantGroup

abstract suspend fun inviteNewParticipantGroup(studyId: UUID, group: Set<AssignParticipantDevices>): ParticipantGroupStatus

Create a new participant group of previously added participants and instantly send out invitations to participate in the study with the given studyId.

stopParticipantGroup

abstract suspend fun stopParticipantGroup(studyId: UUID, groupId: UUID): ParticipantGroupStatus

Stop the study deployment in the study with the given studyId of the participant group with the specified groupId (equivalent to the studyDeploymentId). No further changes to this deployment will be allowed and no more data will be collected.

Inheritors

RecruitmentServiceHost