org.sagebionetworks.bridge.rest.model

Class StudyActivityEventRequest

java.lang.Object

org.sagebionetworks.bridge.rest.model.StudyActivityEventRequest

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2023-07-13T01:30:51.265Z")
public class StudyActivityEventRequest
extends Object

Request object for creating a Custom Activity Event.

Constructor Summary

Constructors

Constructor and Description
StudyActivityEventRequest()

Method Summary

Modifier and Type	Method and Description
StudyActivityEventRequest	answerValue(String answerValue)
StudyActivityEventRequest	clientTimeZone(String clientTimeZone)
boolean	equals(Object o)
StudyActivityEventRequest	eventId(String eventId)
String	getAnswerValue() Some event types can be scoped to a specific answer from the participant (in particular, survey questions).
String	getClientTimeZone() An IANA Time Zone Database (TZDB) name for the participant’s time zone at the time the record is submitted.
String	getEventId() identifier for the custom event
DateTime	getTimestamp() ISO 8601 date and time to record for event
String	getType() CustomActivityEventRequest
int	hashCode()
void	setAnswerValue(String answerValue)
void	setClientTimeZone(String clientTimeZone)
void	setEventId(String eventId)
void	setTimestamp(DateTime timestamp)
StudyActivityEventRequest	timestamp(DateTime timestamp)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StudyActivityEventRequest

public StudyActivityEventRequest()

Method Detail

eventId

public StudyActivityEventRequest eventId(String eventId)

getEventId

public String getEventId()

identifier for the custom event

Returns:

eventId

setEventId

public void setEventId(String eventId)

timestamp

public StudyActivityEventRequest timestamp(DateTime timestamp)

getTimestamp

public DateTime getTimestamp()

ISO 8601 date and time to record for event

Returns:

timestamp

setTimestamp

public void setTimestamp(DateTime timestamp)

answerValue

public StudyActivityEventRequest answerValue(String answerValue)

getAnswerValue

public String getAnswerValue()

Some event types can be scoped to a specific answer from the participant (in particular, survey questions). Ideally, answers are constrained to a known list of values so they can be targeted for scheduling.

Returns:

answerValue

setAnswerValue

public void setAnswerValue(String answerValue)

clientTimeZone

public StudyActivityEventRequest clientTimeZone(String clientTimeZone)

getClientTimeZone

public String getClientTimeZone()

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.

Returns:

clientTimeZone

setClientTimeZone

public void setClientTimeZone(String clientTimeZone)

getType

public String getType()

CustomActivityEventRequest

Returns:

type

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object