Study class

Inheritance
Implemented types
Annotations
  • @JsonSerializable.new()

Constructors

Study(String id, String userId)
Study.fromInvitePreviewJson(Map<String, dynamic> json)
Creates the metadata needed to display an invite before the study is configured for enrollment.
factory
Study.fromJson(Map<String, dynamic> json)
factory
Study.withId(String userId)

Properties

activeSubjectCount ↔ int
getter/setter pair
collaboratorEmails ↔ List<String>
getter/setter pair
getter/setter pair
contact ↔ Contact
getter/setter pair
createdAt ↔ DateTime?
getter/setter pair
description ↔ String?
getter/setter pair
eligibilityCriteria ↔ List<EligibilityCriterion>
getter/setter pair
endedCount ↔ int
getter/setter pair
fitbitCredentials ↔ StudyFitbitCredentials?
getter/setter pair
hasConsentCheck → bool
no setter
hasEligibilityCheck → bool
no setter
hashCode → int
The hash code for this object.
no setterinherited
iconName ↔ String
getter/setter pair
id ↔ String
getter/setter pair
interventions ↔ List<Intervention>
getter/setter pair
invites ↔ List<StudyInvite>?
getter/setter pair
isClosed → bool
no setter
isDraft → bool
no setter
isRunning → bool
no setter
missedDays ↔ List<int>
getter/setter pair
observations ↔ List<Observation>
getter/setter pair
participantCount ↔ int
getter/setter pair
participants ↔ List<StudySubject>?
getter/setter pair
participantsProgress ↔ List<SubjectProgress>?
getter/setter pair
participation ↔ Participation
getter/setter pair
percentageMissedDays → double
no setter
primaryKeys → Map<String, Object>
no setteroverride
published ↔ bool
getter/setter pair
questionnaire ↔ StudyUQuestionnaire
getter/setter pair
registryPublished ↔ bool
getter/setter pair
repo ↔ Repo?
getter/setter pair
reportSpecification ↔ ReportSpecification
getter/setter pair
results ↔ List<StudyResult>
getter/setter pair
resultSharing ↔ ResultSharing
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
schedule ↔ StudySchedule
getter/setter pair
status ↔ StudyStatus
getter/setter pair
studyLength → int
no setter
title ↔ String?
getter/setter pair
totalMissedDays → int
no setter
userId ↔ String
getter/setter pair

Methods

canEdit(User? user) → bool
compareTo(Study other) → int
Compares this object to another object.
override
delete() → Future<Study>
inherited
isEditor(User? user) → bool
isOwner(User? user) → bool
isReadonly(User user) → bool
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
save({bool onlyUpdate = false}) → Future<Study>
Save the object to the database. By default, this will upsert the object, i.e. insert it if it does not exist, or update it if it does. If onlyUpdate is set to true, the object has to exist in the database, otherwise the result will be empty.
inherited
toJson() → Map<String, dynamic>
override
toString() → String
A string representation of this object.
inherited

Operators

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

Static Methods

fetchById(String studyId) → Future<Study?>
Fetches a study by its ID. Returns null if not found.
fetchByInviteCode(String code, {bool previewOnly = false}) → Future<(StudyInvite?, Study?)>
Fetches a study by invite code using the RPC function.
fetchResultsCSVTable(String studyId) → Future<String>
getResearcherDashboardStudies() → Future<List<Study>>
publishedPublicStudies() → Future<ExtractionResult<Study>>

Constants

baselineID → const String
tableName → const String