Package com.smartsheet.api.models

Class Event

  • public class Event
extends java.lang.Object

    • Constructor Summary

      Constructors 
      Constructor Description
      Event()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.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)
      java.util.Map<java.lang.String,​java.lang.Object> getAdditionalDetails()
      Returns a hashmap of additional details associated with the event
      java.lang.String getEventId()
      Gets a unique event ID
      java.lang.Object getEventTimestamp()
      Gets an event timestamp, either a Date object, or Long if numericDates parameter is true on API call.
      java.lang.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)
      java.lang.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)
      java.lang.Long getUserId()
      Gets the assumed user ID for the event request
      Event setAccessTokenName​(java.lang.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​(java.util.Map<java.lang.String,​java.lang.Object> additionalDetails)
      Set the hashmap of additional details associated with the event
      Event setEventId​(java.lang.String eventId)
      Sets a unique event ID
      Event setEventTimestamp​(java.lang.Object eventTimestamp)
      Sets an event timestamp
      Event setObjectId​(java.lang.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​(java.lang.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​(java.lang.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 java.lang.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​(java.lang.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)

      • getAdditionalDetails

        public java.util.Map<java.lang.String,​java.lang.Object> getAdditionalDetails()
        Returns a hashmap of additional details associated with the event
        Returns:
        the hashmap

      • setAdditionalDetails

        public Event setAdditionalDetails​(java.util.Map<java.lang.String,​java.lang.Object> additionalDetails)
        Set the hashmap of additional details associated with the event
        Parameters:
        additionalDetails - the hashmap

      • getEventId

        public java.lang.String getEventId()
        Gets a unique event ID
        Returns:
        the event ID

      • setEventId

        public Event setEventId​(java.lang.String eventId)
        Sets a unique event ID
        Parameters:
        eventId - the event ID

      • getEventTimestamp

        public java.lang.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​(java.lang.Object eventTimestamp)
        Sets an event timestamp
        Parameters:
        eventTimestamp - String if Date, Long if numericDate true on API call.

      • getObjectId

        public java.lang.Object getObjectId()
        Get the object ID of the object associated with the event
        Returns:
        the object ID

      • setObjectId

        public Event setObjectId​(java.lang.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 java.lang.Long getRequestUserId()
        Get the user ID of the user whose credential initiated the request
        Returns:
        the request user ID

      • setRequestUserId

        public Event setRequestUserId​(java.lang.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 java.lang.Long getUserId()
        Gets the assumed user ID for the event request
        Returns:
        the assumed user ID

      • setUserId

        public Event setUserId​(java.lang.Long userId)
        Sets the assumed user ID for the event request
        Parameters:
        userId - the assumed user ID