StudyInvitation

A description of a study, shared with participants once they are invited to a study.

Part of a ParticipantInvitation and an ActiveParticipationInvitation.

Annotations

@JsonSerializable(includeIfNull: false, explicitToJson: true)

Constructors

StudyInvitation.fromJson

StudyInvitation.fromJson(

Map<String, dynamic> json

)

StudyInvitation

StudyInvitation(

String name, [
String? description,
dynamic applicationData

])

Properties

applicationData

dynamic applicationData

getter/setter pair

Application-specific data to be shared with clients when they are invited to a study.

This can be used by infrastructures or concrete applications which require exchanging additional data between the study and client subsystems, outside of scope or not yet supported by CARP core. The CARP web services put the study id here, either as a plain string or as a JSON map with a studyId key; see ActiveParticipationInvitation.studyId.

description

String? description

getter/setter pair

A description of the study clarifying to participants what it is about.

name

String name

getter/setter pair

A descriptive name for the study to be shown to participants.

Methods

toJson

Map<String, dynamic> toJson()

toString

@override

String toString()

override

A string representation of this object.

Some classes have a default textual representation, often paired with a static parse function (like int.parse). These classes will provide the textual representation as their string representation.

Other classes have no meaningful textual representation that a program will care about. Such classes will typically override toString to provide useful information when inspecting the object, mainly for debugging or logging.