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

SchemaReference

@Serializable

data class SchemaReference(val id: String, val revision: Long? = null, val type: String? = null)

A pointer to an upload schema defined for this survey. This schema represents a particular task or activity that the participant should perform, and tells the app which schema ID and revision number to associate the data upload with. If the revision number is set to null when creating a schedule plan, then the reference is to the most recent revision for the given OS and app version. The specific revision number that should be used will be resolved when a #ScheduledActivity is created for the participant).

Parameters

Schema ID

revision

Schema revision number. Can be blank in a Schedule Plan if you want the Scheduler to automatically resolve to the latest revision for the user's app version.

type

SchemaReference

Constructors

SchemaReference

constructor(id: String, revision: Long? = null, type: String? = null)

Properties

@SerialName(value = "id")

val id: String

revision

@SerialName(value = "revision")

val revision: Long? = null

type

@SerialName(value = "type")

val type: String? = null