org.sagebionetworks.bridge.rest.model

Class RequestInfo

java.lang.Object

org.sagebionetworks.bridge.rest.model.RequestInfo

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2022-11-05T00:31:27.098Z")
public class RequestInfo
extends Object

Some basic information is captured when a participant makes a request to the Bridge server, mostly for the purpose of troubleshooting user issues with the app. Questions that can be answered include: * what version of the app is this participant using? * what filtering criteria might be applied to their requests? * when was the last time they uploaded data or retrieved activities? * do they have a session right now, or have they contacted the server recently at all? This information is cached but not persisted; it is not guaranteed to be present for all active users.

Constructor Summary

Constructors

Constructor and Description
RequestInfo()

Method Summary

Modifier and Type	Method and Description
RequestInfo	activitiesAccessedOn(DateTime activitiesAccessedOn)
RequestInfo	addLanguagesItem(String languagesItem)
RequestInfo	addUserDataGroupsItem(String userDataGroupsItem)
RequestInfo	addUserStudyIdsItem(String userStudyIdsItem)
RequestInfo	clientInfo(ClientInfo clientInfo)
boolean	equals(Object o)
DateTime	getActivitiesAccessedOn() The last recorded time the participant's application requested scheduled activities from the server.
ClientInfo	getClientInfo() The `User-Agent` string from the last request as parsed for the purpose of applying filtering criteria.
List<String>	getLanguages() The language or languages sent in the user's `Accept-Language` header and persisted as part of the participant's account configuration, as they were set at the time of the last request.
DateTime	getSignedInOn() The last recorded time the participant signed in to the server.
DateTime	getTimelineAccessedOn() The last recorded time the participant's application requested timeline information (either the timeline or the recent study activity events) from the server.
String	getTimeZone() The user's time zone at the time of the last request.
String	getType() RequestInfo
DateTime	getUploadedOn() The last recorded time the participant started an upload to the server.
String	getUserAgent() The `User-Agent` header exactly as it was sent to the server, whether it is parseable by the Bridge server or not.
List<String>	getUserDataGroups() The data groups assigned to this participant at the time of the last request.
String	getUserId() The user's account ID.
List<String>	getUserStudyIds() The study IDs that this participant is enrolled in.
int	hashCode()
RequestInfo	languages(List<String> languages)
void	setActivitiesAccessedOn(DateTime activitiesAccessedOn)
void	setClientInfo(ClientInfo clientInfo)
void	setLanguages(List<String> languages)
void	setSignedInOn(DateTime signedInOn)
void	setTimelineAccessedOn(DateTime timelineAccessedOn)
void	setTimeZone(String timeZone)
void	setUploadedOn(DateTime uploadedOn)
void	setUserAgent(String userAgent)
void	setUserDataGroups(List<String> userDataGroups)
void	setUserStudyIds(List<String> userStudyIds)
RequestInfo	signedInOn(DateTime signedInOn)
RequestInfo	timelineAccessedOn(DateTime timelineAccessedOn)
RequestInfo	timeZone(String timeZone)
String	toString()
RequestInfo	uploadedOn(DateTime uploadedOn)
RequestInfo	userAgent(String userAgent)
RequestInfo	userDataGroups(List<String> userDataGroups)
RequestInfo	userStudyIds(List<String> userStudyIds)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RequestInfo

public RequestInfo()

Method Detail

getUserId

public String getUserId()

The user's account ID.

Returns:

userId

clientInfo

public RequestInfo clientInfo(ClientInfo clientInfo)

getClientInfo

public ClientInfo getClientInfo()

The `User-Agent` string from the last request as parsed for the purpose of applying filtering criteria.

Returns:

clientInfo

setClientInfo

public void setClientInfo(ClientInfo clientInfo)

userAgent

public RequestInfo userAgent(String userAgent)

getUserAgent

public String getUserAgent()

The `User-Agent` header exactly as it was sent to the server, whether it is parseable by the Bridge server or not.

Returns:

userAgent

setUserAgent

public void setUserAgent(String userAgent)

languages

public RequestInfo languages(List<String> languages)

addLanguagesItem

public RequestInfo addLanguagesItem(String languagesItem)

getLanguages

public List<String> getLanguages()

The language or languages sent in the user's `Accept-Language` header and persisted as part of the participant's account configuration, as they were set at the time of the last request.

Returns:

languages

setLanguages

public void setLanguages(List<String> languages)

userDataGroups

public RequestInfo userDataGroups(List<String> userDataGroups)

addUserDataGroupsItem

public RequestInfo addUserDataGroupsItem(String userDataGroupsItem)

getUserDataGroups

public List<String> getUserDataGroups()

The data groups assigned to this participant at the time of the last request.

Returns:

userDataGroups

setUserDataGroups

public void setUserDataGroups(List<String> userDataGroups)

userStudyIds

public RequestInfo userStudyIds(List<String> userStudyIds)

addUserStudyIdsItem

public RequestInfo addUserStudyIdsItem(String userStudyIdsItem)

getUserStudyIds

public List<String> getUserStudyIds()

The study IDs that this participant is enrolled in.

Returns:

userStudyIds

setUserStudyIds

public void setUserStudyIds(List<String> userStudyIds)

activitiesAccessedOn

public RequestInfo activitiesAccessedOn(DateTime activitiesAccessedOn)

getActivitiesAccessedOn

public DateTime getActivitiesAccessedOn()

The last recorded time the participant's application requested scheduled activities from the server.

Returns:

activitiesAccessedOn

setActivitiesAccessedOn

public void setActivitiesAccessedOn(DateTime activitiesAccessedOn)

timelineAccessedOn

public RequestInfo timelineAccessedOn(DateTime timelineAccessedOn)

getTimelineAccessedOn

public DateTime getTimelineAccessedOn()

The last recorded time the participant's application requested timeline information (either the timeline or the recent study activity events) from the server.

Returns:

timelineAccessedOn

setTimelineAccessedOn

public void setTimelineAccessedOn(DateTime timelineAccessedOn)

signedInOn

public RequestInfo signedInOn(DateTime signedInOn)

getSignedInOn

public DateTime getSignedInOn()

The last recorded time the participant signed in to the server.

Returns:

signedInOn

setSignedInOn

public void setSignedInOn(DateTime signedInOn)

uploadedOn

public RequestInfo uploadedOn(DateTime uploadedOn)

getUploadedOn

public DateTime getUploadedOn()

The last recorded time the participant started an upload to the server.

Returns:

uploadedOn

setUploadedOn

public void setUploadedOn(DateTime uploadedOn)

timeZone

public RequestInfo timeZone(String timeZone)

getTimeZone

public String getTimeZone()

The user's time zone at the time of the last request.

Returns:

timeZone

setTimeZone

public void setTimeZone(String timeZone)

getType

public String getType()

RequestInfo

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