ParticipationReference class

Provide a participation endpoint reference to a CARP web service.

According to CARP core, the protocol for using the deployment sub-system is:

Also contains convenient methods for setting, getting, and deleting an informed consent document as participant data.

Inheritance

Properties

hashCode → int
The hash code for this object.
no setterinherited
headers → Map<String, String>
no setterinherited
rpcEndpointUri → String
The URL for the participation endpoint.
no setteroverride
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
service ↔ CarpBaseService
getter/setter pairinherited
studyDeploymentId → String
The CARP study deployment ID.
no setter

Methods

getInformedConsent() → Future<Map<String, InformedConsentInput?>>
Get informed consent data for all participants (by role name) in this study deployment with studyDeploymentId. Informed consent which is not set equals null.
getInformedConsentByRole([String? roleName]) → Future<InformedConsentInput?>
Get the informed consent uploaded by a participant with roleName in this study deployment with studyDeploymentId.
getParticipantData() → Future<ParticipantData>
Get currently set data for all expected participant data in this study deployment with studyDeploymentId. Data which is not set equals null.
getParticipantRoleName(String? roleName) → String
Resolve role name of a participant.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
removeInformedConsent([String? inputByParticipantRole]) → Future<void>
Remove the informed for the given inputByParticipantRole in this study deployment. If inputByParticipantRole is not specified, the role of the participant in the current deployment is used.
setInformedConsent(InformedConsentInput consent, [String? inputByParticipantRole]) → Future<void>
Set informed consent for the given inputByParticipantRole in this study deployment. If inputByParticipantRole is not specified, the role of the participant in the current deployment is used.
setParticipantData(Map<String, Data> data, [String? inputByParticipantRole]) → Future<ParticipantData>
Set participant data for the given inputByParticipantRole in this study deployment. If inputByParticipantRole is null, all roles can set it.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited