Interface EventResources
- Namespace
- Smartsheet.Api
- Assembly
- smartsheet-csharp-sdk.dll
Interface for event resources
public interface EventResources
Methods
ListEvents(object?, string?, int?, bool?)
List all events
EventResult ListEvents(object? since = null, string? streamPosition = null, int? maxCount = null, bool? numericDates = null)
Parameters
since
objectStarting time for events to return. You must pass in a value for either since or streamPosition and never both.
streamPosition
stringIndicates 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.optional list of resource parameters
maxCount
int?Maximum number of events to return as response to this call. Must be between 1 through 10,000 (inclusive).
numericDates
bool?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
- EventResult
A list of all events (note that an empty list will be returned if there are none).
Exceptions
- InvalidOperationException
if any argument is null or an 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