nylas/com.nylas.models/ListEventQueryParams

ListEventQueryParams

public final class ListEventQueryParams implements IQueryParams

Class representation of the query parameters for listing events.

Constructors

public ListEventQueryParams ListEventQueryParams(@Json(name = "calendar_id") String calendarId, @Json(name = "limit") Integer limit, @Json(name = "page_token") String pageToken, @Json(name = "show_cancelled") Boolean showCancelled, @Json(name = "title") String title, @Json(name = "description") String description, @Json(name = "location") String location, @Json(name = "end") String end, @Json(name = "start") String start, @Json(name = "metadata_pair") Map<String, String> metadataPair, @Json(name = "expand_recurring") Boolean expandRecurring, @Json(name = "busy") Boolean busy, @Json(name = "participants") String orderBy)

Types

Builder

public final class Builder

Builder for ListEventQueryParams.

Properties

busy

private final Boolean busy

Returns events with a busy status of true.

calendarId

private final String calendarId

Specify calendar ID of the event. "primary" is a supported value indicating the user's primary calendar.

description

private final String description

Return events matching the specified description. Graph: NOT supported

end

private final String end

Return events ending before the specified unix timestamp. Defaults to a month from now. Not respected by metadata filtering.

expandRecurring

private final Boolean expandRecurring

If true, the response will include an event for each occurrence of a recurring event within the requested time range. If false, only a single primary event will be returned for each recurring event. Cannot be used when filtering on metadata. Defaults to false.

limit

private final Integer limit

The maximum number of objects to return. This field defaults to 50. The maximum allowed value is 200.

location

private final String location

Return events matching the specified location.

metadataPair

private final Map<String, String> metadataPair

Pass in your metadata key and value pair to search for metadata.

orderBy

private final String orderBy

Order results by the specified field. Currently only start is supported.

pageToken

private final String pageToken

An identifier that specifies which page of data to return. This value should be taken from the ListResponse.nextCursor response field.

showCancelled

private final Boolean showCancelled

Return events that have a status of cancelled. If an event is recurring, then it returns no matter the value set. Different providers have different semantics for cancelled events.

start

private final String start

Return events starting after the specified unix timestamp. Defaults to the current timestamp. Not respected by metadata filtering.

title

private final String title

Return events matching the specified title.

Functions

convertToMap

public Map<String, Object> convertToMap()

Convert the query parameters to a json-formatted map.

getBusy

public final Boolean getBusy()

Returns events with a busy status of true.

getCalendarId

public final String getCalendarId()

Specify calendar ID of the event. "primary" is a supported value indicating the user's primary calendar.

getDescription

public final String getDescription()

Return events matching the specified description. Graph: NOT supported

getEnd

public final String getEnd()

Return events ending before the specified unix timestamp. Defaults to a month from now. Not respected by metadata filtering.

getExpandRecurring

public final Boolean getExpandRecurring()

getLimit

public final Integer getLimit()

The maximum number of objects to return. This field defaults to 50. The maximum allowed value is 200.

getLocation

public final String getLocation()

Return events matching the specified location.

getMetadataPair

public final Map<String, String> getMetadataPair()

Pass in your metadata key and value pair to search for metadata.

getOrderBy

public final String getOrderBy()

Order results by the specified field. Currently only start is supported.

getPageToken

public final String getPageToken()

An identifier that specifies which page of data to return. This value should be taken from the ListResponse.nextCursor response field.

getShowCancelled

public final Boolean getShowCancelled()

Return events that have a status of cancelled. If an event is recurring, then it returns no matter the value set. Different providers have different semantics for cancelled events.

getStart

public final String getStart()

Return events starting after the specified unix timestamp. Defaults to the current timestamp. Not respected by metadata filtering.

getTitle

public final String getTitle()

Return events matching the specified title.