Package com.smartsheet.api

Interface EventResources

public interface EventResources

Method Summary

Modifier and Type	Method	Description
EventResult	listEvents(java.lang.Object since, java.lang.String streamPosition, java.lang.Integer maxCount, java.lang.Boolean numericDates)	List all events.

Method Detail

listEvents

EventResult listEvents(java.lang.Object since,
                       java.lang.String streamPosition,
                       java.lang.Integer maxCount,
                       java.lang.Boolean numericDates)
                throws SmartsheetException

List all events.

It mirrors to the following Smartsheet REST API method: GET /events

Parameters:

since - Starting time for events to return. You must pass in a value for either since or streamPosition and never both.

streamPosition - Indicates next set of events to return. Use value of nextStreamPosition returned from the previous call. You must pass in a value for either since or streamPosition and never both.

maxCount - Maximum number of events to return as response to this call. Must be between 1 through 10,000 (inclusive).

numericDates - If true, dates are accepted and returned in Unix epoch time (milliseconds since midnight on January 1, 1970 in UTC time). Default is false, which means ISO-8601 format

Returns:

A list of all events (note that an empty list will be returned if there are none).

Throws:

java.lang.IllegalArgumentException - if any argument is null or empty string

InvalidRequestException - if there is any problem with the REST API request

AuthorizationException - if there is any problem with the REST API authorization (access token)

ResourceNotFoundException - if the resource cannot be found

ServiceUnavailableException - if the REST API service is not available (possibly due to rate limiting)

SmartsheetException - if there is any other error during the operation