CarpParticipationService class

A ParticipationService that talks to the CARP backend server(s).

Inheritance

• Object
• CarpBaseService
• CarpParticipationService

Constructors

CarpParticipationService()

Returns the singleton default instance of the CarpParticipationService. 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. Returns null if this service has not yet been configured via the configure method.

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

Methods

configure(CarpApp app) → void

Configure the this instance of a Carp Service.

inherited

configureFrom(CarpBaseService service) → void

Configure from another service which has already been configured and potentially authenticated.

inherited

getActiveParticipationInvitations([String? accountId]) → Future<List<ActiveParticipationInvitation>>

Get the list of active participation invitations for an accountId. This will return all deployments that this account (user) is invited to.

override

getParticipantData(String studyDeploymentId) → Future<ParticipantData>

Get currently set data for all expected participant data in the study deployment with studyDeploymentId. Data which is not set equals null.

override

getParticipantDataList(List<String> studyDeploymentIds) → Future<List<ParticipantData>>

Get currently set data for all expected participant data for a set of study deployments with studyDeploymentIds. Data which is not set equals null.

override

getStudyInvitation(BuildContext context, {bool showInvitations = true, bool allowClose = false}) → Future<ActiveParticipationInvitation?>

Get a study invitation from CARP by allowing the user to select from multiple invitations (if more than one is available).

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

participation([String? studyDeploymentId]) → ParticipationReference

Gets a ParticipationReference for a studyDeploymentId. If the studyDeploymentId is not provided, the study deployment id specified in the CarpApp is used.

setParticipantData(String studyDeploymentId, Map<String, Data> data, [String? inputByParticipantRole]) → Future<ParticipantData>

Set data that was inputByParticipantRole in the study deployment with studyDeploymentId.

override

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited