ActiveParticipationInvitation class

An invitation to participate in an active study deployment using the assignedDevices.

Returned by ParticipationService.getActiveParticipationInvitations. A participant app shows these to let the user pick a study, and then creates a Study from studyDeploymentId and deviceRoleName. 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.

Annotations
  • @JsonSerializable.new(includeIfNull: false, explicitToJson: true)

Constructors

ActiveParticipationInvitation(Participation participation, StudyInvitation invitation)
ActiveParticipationInvitation.fromJson(Map<String, dynamic> json)
factory

Properties

assignedDevices ↔ List<AssignedPrimaryDevice>?
The primary devices the participant is invited to use.
getter/setter pair
deviceRoleName → String?
The role name of the first assigned device; null if assignedDevices is null. Throws a StateError if the list is empty.
no setter
hashCode → int
The hash code for this object.
no setterinherited
invitation ↔ StudyInvitation
The study description shown to the participant.
getter/setter pair
participantId → String
The ID of the participant.
no setter
participantRoleName → String?
The first role name of the participant; null if assigned to all roles.
no setter
participation ↔ Participation
Who participates in which study deployment.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
studyDeploymentId → String
The study deployment ID.
no setter
studyDescription → String?
The study description.
no setter
studyId → String?
The ID of the study; null if not available.
no setter
studyName → String?
The study name.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
toString() → String
A string representation of this object.
override

Operators

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