StudyDescription

A human-readable description of a study: title, purpose, and who runs it.

Stored as SmartphoneStudyProtocol.studyDescription and copied to each SmartphoneDeployment, so the app can show it to the participant.

Inheritance

• Object
• Serializable
• StudyDescription

Annotations

• @JsonSerializable(includeIfNull: false, explicitToJson: true)

Constructors

StudyDescription.fromJson

StudyDescription.fromJson(

1. Map<String, dynamic> json

)

StudyDescription

StudyDescription({

1. required String title,
2. String? description,
3. String? purpose,
4. String? studyDescriptionUrl,
5. String? privacyPolicyUrl,
6. StudyResponsible? responsible,

})

Properties

description

String? description

getter/setter pair

The description of this study.

fromJsonFunction

1. @override

Function get fromJsonFunction

override

The function which can convert a JSON string to an object of this type.

privacyPolicyUrl

String? privacyPolicyUrl

getter/setter pair

The URL pointing to a web page with the privacy policy of this study.

purpose

String? purpose

getter/setter pair

The purpose of the study. To be used to inform the user about this study and its purpose.

responsible

StudyResponsible? responsible

getter/setter pair

The principal investigator (PI) responsible for this study.

studyDescriptionUrl

String? studyDescriptionUrl

getter/setter pair

The URL pointing to a web page description of this study.

title

String title

getter/setter pair

A longer printer-friendly title for this study.

Methods

toJson

1. @override

Map<String, dynamic> toJson()

override

Return a JSON encoding of this object.

toString

1. @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.