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

ScheduledSession

@Serializable

data class ScheduledSession(val refGuid: String, val instanceGuid: String, val startEventId: String? = null, var startTime: LocalTime, val delayTime: String? = null, val expiration: DateTimePeriod, val persistent: Boolean = false, val studyBurstId: String? = null, val studyBurstNum: Int? = null, val timeWindowGuid: String? = null, val assessments: List<ScheduledAssessment>, val startDate: LocalDate, val endDate: LocalDate, val type: String? = null)

An individual session instance the participant should perform as part of the study. The refGuid property will refer to a session in the list of sessions in this timeline. The instanceGuid is a unique GUID to identify any data that is generated from the execution of this scheduled session. This allows scientists to contextualize data based on when it was gathered in the execution of the study’s schedule. Further details about how a client should interpret a timeline can be found at the Bridge developer portal.

Parameters

refGuid

instanceGuid

startEventId

An event ID for this scheduled session. The event ID may be mapped to a timestamp for a user. If the event ID does not exist for the user, the client should ignore this scheduled session. Otherwise, it should be shown to the user according to the scheduling information.

startDay

endDay

startTime

delayTime

expiration

persistent

studyBurstId

studyBurstNum

timeWindowGuid

assessments

type

ScheduledSession

Constructors

ScheduledSession

constructor(refGuid: String, instanceGuid: String, startEventId: String? = null, startTime: LocalTime, delayTime: String? = null, expiration: DateTimePeriod, persistent: Boolean = false, studyBurstId: String? = null, studyBurstNum: Int? = null, timeWindowGuid: String? = null, assessments: List<ScheduledAssessment>, startDate: LocalDate, endDate: LocalDate, type: String? = null)