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

StudyInfo

@Serializable
data class StudyInfo(val identifier: String? = null, val name: String? = null, val details: String? = null, val phase: StudyPhase? = null, val studyLogoUrl: String? = null, val colorScheme: ColorScheme? = null, val signInTypes: List<SignInType>? = null, val type: String? = null)

An abridged study object with information that is useful for displaying, selecting, and signing into the study.

Parameters

identifier

The identifier for this study.

name

The name of the study.

details

An in-depth description of this study for prospective participants, or to show participants after they have joined a study (the “about” screen for the study).

phase
studyLogoUrl

An URL to a logo for the study.

colorScheme
signInTypes
type

StudyInfo

Constructors

Link copied to clipboard
constructor(identifier: String? = null, name: String? = null, details: String? = null, phase: StudyPhase? = null, studyLogoUrl: String? = null, colorScheme: ColorScheme? = null, signInTypes: List<SignInType>? = null, type: String? = null)

Properties

Link copied to clipboard
@SerialName(value = "colorScheme")
val colorScheme: ColorScheme? = null
Link copied to clipboard
@SerialName(value = "details")
val details: String? = null
Link copied to clipboard
@SerialName(value = "identifier")
val identifier: String? = null
Link copied to clipboard
@SerialName(value = "name")
val name: String? = null
Link copied to clipboard
@SerialName(value = "phase")
val phase: StudyPhase? = null
Link copied to clipboard
@SerialName(value = "signInTypes")
val signInTypes: List<SignInType>? = null
Link copied to clipboard
@SerialName(value = "studyLogoUrl")
val studyLogoUrl: String? = null
Link copied to clipboard
@SerialName(value = "type")
val type: String? = null