StudyActivityEvent

@Serializable
data class StudyActivityEvent(val eventId: String, val timestamp: Instant, val answerValue: String? = null, val clientTimeZone: String? = null, val recordCount: Int? = null, val createdOn: String? = null, val type: String? = null)

Activity event for a participant in a specific study, used for scheduling activities.

Parameters

eventId

event identifier

answerValue

answer value for a question event

timestamp

ISO 8601 date and time that the event occurred

clientTimeZone

An IANA Time Zone Database (TZDB) name for the participant’s time zone at the time the record is submitted. If present, this field will be validated to be a valid time zone name.

recordCount

The number of unique timestamp values that have been recorded for this events. Immutable events should only ever have one record, while mutable events (future_only and mutable) can have any number of historical values.

createdOn

ISO 8601 date and time that the user account was created.

type

StudyActivityEvent

Constructors

Link copied to clipboard
constructor(eventId: String, timestamp: Instant, answerValue: String? = null, clientTimeZone: String? = null, recordCount: Int? = null, createdOn: String? = null, type: String? = null)

Properties

Link copied to clipboard
@SerialName(value = "answerValue")
val answerValue: String? = null
Link copied to clipboard
@SerialName(value = "clientTimeZone")
val clientTimeZone: String? = null
Link copied to clipboard
@SerialName(value = "createdOn")
val createdOn: String? = null
Link copied to clipboard
@SerialName(value = "eventId")
val eventId: String
Link copied to clipboard
@SerialName(value = "recordCount")
val recordCount: Int? = null
Link copied to clipboard
@SerialName(value = "timestamp")
val timestamp: Instant
Link copied to clipboard
@SerialName(value = "type")
val type: String? = null