StudyDescription class

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.new(includeIfNull: false, explicitToJson: true)

Constructors

StudyDescription({required String title, String? description, String? purpose, String? studyDescriptionUrl, String? privacyPolicyUrl, StudyResponsible? responsible})
StudyDescription.fromJson(Map<String, dynamic> json)
factory

Properties

$type ↔ String?
The type name written to __type in JSON; set to jsonType on creation.
getter/setter pairinherited
description ↔ String?
The description of this study.
getter/setter pair
fromJsonFunction → Function
The generated function that converts a JSON map to an object of this type.
no setteroverride
hashCode → int
The hash code for this object.
no setterinherited
jsonType → String
The __type used for JSON serialization of this class.
no setterinherited
privacyPolicyUrl ↔ String?
The URL pointing to a web page with the privacy policy of this study.
getter/setter pair
purpose ↔ String?
The purpose of the study. To be used to inform the user about this study and its purpose.
getter/setter pair
responsible ↔ StudyResponsible?
The principal investigator (PI) responsible for this study.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
studyDescriptionUrl ↔ String?
The URL pointing to a web page description of this study.
getter/setter pair
title ↔ String
A longer printer-friendly title for this study.
getter/setter pair

Methods

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

Operators

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