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

AssessmentInfo

@Serializable

data class AssessmentInfo(val key: String, val guid: String, val appId: String, val identifier: String, val revision: Int? = null, val label: String, val minutesToComplete: Int? = null, val colorScheme: ColorScheme? = null, val configUrl: String, val imageResource: ImageResource? = null, val type: String? = null)

Information about an assessment in order to render it in a UI prior to execution.

Parameters

key

Because assessments can be configured with different display information, they are not referenced in the schedule portion of a timeline by their GUIDs. Instead they are given a unique string key that is used to look up the assessment.

guid

Each assessment revision is assigned a unique GUID which can be used to retrieve it through the API. Assessments will also have a unique combination of an identifier and a revision, and can be retrieved as a set of revisions under a given identifier.

appId

identifier

A human-readable identifier for an assessment, which can have one or more revisions.

revision

The revision of the assessment under the given identifier (the identifier and the revision together are mapped to a single GUID which can be used to reference the assessment; only the GUID is required in this object).

label

minutesToComplete

The number of minutes it takes for a participant to complete this assessment.

colorScheme

configUrl

The URL to download the configuration associated with this assessment.

type

AssessmentInfo

Constructors

AssessmentInfo

constructor(key: String, guid: String, appId: String, identifier: String, revision: Int? = null, label: String, minutesToComplete: Int? = null, colorScheme: ColorScheme? = null, configUrl: String, imageResource: ImageResource? = null, type: String? = null)