com.smartsheet.api.models

Class Event

java.lang.Object

com.smartsheet.api.models.Event

public class Event
extends Object

Constructor Summary

Constructors

Constructor and Description
Event()

Method Summary

Modifier and Type	Method and Description
String	getAccessTokenName() Gets the access token name associated with the event, can be null
EventAction	getAction() Gets the action associated with the event (EventAction enumeration)
HashMap<String,Object>	getAdditionalDetails() Returns a hashmap of additional details associated with the event
String	getEventId() Gets a unique event ID
Object	getEventTimestamp() Gets an event timestamp, either a Date object, or Long if numericDates parameter is true on API call.
Object	getObjectId() Get the object ID of the object associated with the event
EventObjectType	getObjectType() Gets the object type of the object associated with the event (EventObjectType enumeration)
Long	getRequestUserId() Get the user ID of the user whose credential initiated the request
EventSource	getSource() Gets the source of the event request (EventSource enumeration)
Long	getUserId() Gets the assumed user ID for the event request
Event	setAccessTokenName(String accessTokenName) Sets the access token name associated with the event
Event	setAction(EventAction action) Sets the action associated with the event (EventAction enumeration)
Event	setAdditionalDetails(HashMap<String,Object> additionalDetails) Set the hashmap of additional details associated with the event
Event	setEventId(String eventId) Sets a unique event ID
Event	setEventTimestamp(Object eventTimestamp) Sets an event timestamp
Event	setObjectId(Object objectId) Sets an object ID for the object associated with the event
Event	setObjectType(EventObjectType objectType) Sets the object type of the object associated with the event
Event	setRequestUserId(Long requestUserId) Sets the user ID of the user whose credential initiated the request
Event	setSource(EventSource source) Sets the source of the event request
Event	setUserId(Long userId) Sets the assumed user ID for the event request

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Event

public Event()

Method Detail

getAccessTokenName

public String getAccessTokenName()

Gets the access token name associated with the event, can be null

Returns:

the access token name associated with the event

setAccessTokenName

public Event setAccessTokenName(String accessTokenName)

Sets the access token name associated with the event

Parameters:

accessTokenName - the access token name

getAction

public EventAction getAction()

Gets the action associated with the event (EventAction enumeration)

Returns:

the event action

setAction

public Event setAction(EventAction action)

Sets the action associated with the event (EventAction enumeration)

Parameters:

action -

getAdditionalDetails

public HashMap<String,Object> getAdditionalDetails()

Returns a hashmap of additional details associated with the event

Returns:

the hashmap

setAdditionalDetails

public Event setAdditionalDetails(HashMap<String,Object> additionalDetails)

Set the hashmap of additional details associated with the event

Parameters:

additionalDetails - the hashmap

getEventId

public String getEventId()

Gets a unique event ID

Returns:

the event ID

setEventId

public Event setEventId(String eventId)

Sets a unique event ID

Parameters:

eventId - the event ID

getEventTimestamp

public Object getEventTimestamp()

Gets an event timestamp, either a Date object, or Long if numericDates parameter is true on API call.

Returns:

the event timestamp

setEventTimestamp

public Event setEventTimestamp(Object eventTimestamp)

Sets an event timestamp

Parameters:

eventTimestamp - String if Date, Long if numericDate true on API call.

getObjectId

public Object getObjectId()

Get the object ID of the object associated with the event

Returns:

the object ID

setObjectId

public Event setObjectId(Object objectId)

Sets an object ID for the object associated with the event

Parameters:

objectId - the object ID

getObjectType

public EventObjectType getObjectType()

Gets the object type of the object associated with the event (EventObjectType enumeration)

Returns:

the object type

setObjectType

public Event setObjectType(EventObjectType objectType)

Sets the object type of the object associated with the event

Parameters:

objectType - the object type

getRequestUserId

public Long getRequestUserId()

Get the user ID of the user whose credential initiated the request

Returns:

the request user ID

setRequestUserId

public Event setRequestUserId(Long requestUserId)

Sets the user ID of the user whose credential initiated the request

Parameters:

requestUserId - the request user ID

getSource

public EventSource getSource()

Gets the source of the event request (EventSource enumeration)

Returns:

the event source

setSource

public Event setSource(EventSource source)

Sets the source of the event request

Parameters:

source - the event source

getUserId

public Long getUserId()

Gets the assumed user ID for the event request

Returns:

the assumed user ID

setUserId

public Event setUserId(Long userId)

Sets the assumed user ID for the event request

Parameters:

userId - the assumed user ID