bridge-client/org.sagebionetworks.bridge.kmm.shared.models/Timeline

Timeline

@Serializable

data class Timeline(val duration: DateTimePeriod, val schedule: List<ScheduledSession>? = null, val assessments: List<AssessmentInfo>? = null, val sessions: List<SessionInfo>? = null, val studyBursts: List<StudyBurstInfo>? = null, val totalMinutes: Int? = null, val totalNotifications: Int? = null, val type: String? = null)

A detailed description of when a participant should perform specific sessions and assessments as part of a study, along with the metadata to show UI to the participant before loading and executing code for the assessments.

Parameters

duration

The length of time of the study’s protocol, after which the participant has completed the study. Events in the timeline will not extend past this duration in time.

schedule

assessments

sessions

studyBursts

totalMinutes

The total number of minutes to perform all the sessions in the timeline. This information is provided for informational purposes to schedule designers.

totalNotifications

The total number of notifications that could be shown to the participant (if all possible notifications are shown; fewer notifications may be shown since the participant may complete sessions before all reminders are shown for the session). This information is provided for informational purposes to schedule designers.

type

Timeline

Constructors

Timeline

constructor(duration: DateTimePeriod, schedule: List<ScheduledSession>? = null, assessments: List<AssessmentInfo>? = null, sessions: List<SessionInfo>? = null, studyBursts: List<StudyBurstInfo>? = null, totalMinutes: Int? = null, totalNotifications: Int? = null, type: String? = null)