Class google.gdata.calendar.CalendarEventQuery

Object
   |
   +--google.gdata.client.Query
         |
         +--google.gdata.calendar.CalendarEventQuery

class google.gdata.calendar.CalendarEventQuery

extends google.gdata.client.Query

Describes a query for the feed of a calendar's events.
Defined in gdata.js

Field Detail

ORDERBY_LAST_MODIFIED

<static> <final> {string} ORDERBY_LAST_MODIFIED

Order the returned feed's entries by their <updated> values.

See Also:

Constant Field Values

ORDERBY_START_TIME

<static> <final> {string} ORDERBY_START_TIME

Order the returned feed's entries by the <gd:when> element's starttime attribute.

See Also:

Constant Field Values

SORTORDER_ASCENDING

<static> <final> {string} SORTORDER_ASCENDING

Ascending.

See Also:

Constant Field Values

SORTORDER_DESCENDING

<static> <final> {string} SORTORDER_DESCENDING

Descending.

See Also:

Constant Field Values

google.gdata.calendar.CalendarEventQuery

google.gdata.calendar.CalendarEventQuery(<string> feedUri)

Constructor.

Parameters:
feedUri - URI of feed.

getAuthor

String? getAuthor()

Returns the author name or email address.

Returns:
Author name or email address or null to indicate that the parameter is disabled.

getFullTextQuery

String? getFullTextQuery()

Returns the full-text query string.

Returns:
Full-text query string or null to indicate that the parameter is disabled.

getFutureEvents

Boolean? getFutureEvents()

Returns the shortcut to request all events that are scheduled for future times which overrides the recurrence-expansion-start, recurrence-expansion-end, start-min, and start-max values.

Returns:
Shortcut to request all events that are scheduled for future times which overrides the recurrence-expansion-start, recurrence-expansion-end, start-min, and start-max values or null to indicate that the parameter is disabled.

getMaximumStartTime

google.gdata.DateTime? getMaximumStartTime()

Returns the latest event start time to match (default is 2031-01-01).

Returns:
Latest event start time to match (default is 2031-01-01) or null to indicate that the parameter is disabled.

getMaxResults

Number? getMaxResults()

Returns the maximum number of results to be retrieved.

Returns:
Maximum number of results to be retrieved or null to indicate that the parameter is disabled.

getMinimumStartTime

google.gdata.DateTime? getMinimumStartTime()

Returns the earliest event start time to match (default is 1970-01-01).

Returns:
Earliest event start time to match (default is 1970-01-01) or null to indicate that the parameter is disabled.

getOrderBy

String? getOrderBy()

Returns the order of entries in a feed.

Returns:
Order of entries in a feed or null to indicate that the parameter is disabled.

getRecurrenceExpansionEnd

google.gdata.DateTime? getRecurrenceExpansionEnd()

Returns the end of time period for which to expand recurring events.

Returns:
End of time period for which to expand recurring events or null to indicate that the parameter is disabled.

getRecurrenceExpansionStart

google.gdata.DateTime? getRecurrenceExpansionStart()

Returns the beginning of time period for which to expand recurring events.

Returns:
Beginning of time period for which to expand recurring events or null to indicate that the parameter is disabled.

getShowAllowGSync

Boolean? getShowAllowGSync()

Returns the whether to include the allowGSync2 flag in the output.

Returns:
Whether to include the allowGSync2 flag in the output or null to indicate that the parameter is disabled.

getShowHidden

Boolean? getShowHidden()

Returns the whether to force including new invitation events.

Returns:
Whether to force including new invitation events or null to indicate that the parameter is disabled.

getSingleEvents

Boolean? getSingleEvents()

Returns the whether recurring events should be expanded or represented as a single event.

Returns:
Whether recurring events should be expanded or represented as a single event or null to indicate that the parameter is disabled.

getSortOrder

String? getSortOrder()

Returns the direction of sorting.

Returns:
Direction of sorting or null to indicate that the parameter is disabled.

getStartIndex

Number? getStartIndex()

Returns the 1-based index of the first result to be retrieved.

Returns:
1-based index of the first result to be retrieved or null to indicate that the parameter is disabled.

getUpdatedMax

google.gdata.DateTime? getUpdatedMax()

Returns the maximum updated date.

Returns:
Maximum updated date or null to indicate that the parameter is disabled.

getUpdatedMin

google.gdata.DateTime? getUpdatedMin()

Returns the minimum updated date.

Returns:
Minimum updated date or null to indicate that the parameter is disabled.

setAuthor

void setAuthor(<String?> author)

Sets the author name or email address.

Parameters:
author - Author name or email address or null to disable this parameter.

setFullTextQuery

void setFullTextQuery(<String?> fullTextQuery)

Sets the full-text query string.

Parameters:
fullTextQuery - Full-text query string or null to disable this parameter.

setFutureEvents

void setFutureEvents(<Boolean|string|null> futureEvents)

Sets the shortcut to request all events that are scheduled for future times which overrides the recurrence-expansion-start, recurrence-expansion-end, start-min, and start-max values. The default value is false.

Parameters:
futureEvents - Shortcut to request all events that are scheduled for future times which overrides the recurrence-expansion-start, recurrence-expansion-end, start-min, and start-max values or an equivalent string value or null to disable this parameter.

setMaximumStartTime

void setMaximumStartTime(<google.gdata.DateTime|string|null> maximumStartTime)

Sets the latest event start time to match (default is 2031-01-01).

Parameters:
maximumStartTime - Latest event start time to match (default is 2031-01-01) or an equivalent string value or null to disable this parameter.

setMaxResults

void setMaxResults(<Number|string|null> maxResults)

Sets the maximum number of results to be retrieved.

Parameters:
maxResults - Maximum number of results to be retrieved or an equivalent string value or null to disable this parameter.

setMinimumStartTime

void setMinimumStartTime(<google.gdata.DateTime|string|null> minimumStartTime)

Sets the earliest event start time to match (default is 1970-01-01).

Parameters:
minimumStartTime - Earliest event start time to match (default is 1970-01-01) or an equivalent string value or null to disable this parameter.

setOrderBy

void setOrderBy(<String?> orderBy)

Sets the order of entries in a feed. The default value is 'lastmodified'.

Parameters:
orderBy - Order of entries in a feed or null to disable this parameter.

setRecurrenceExpansionEnd

void setRecurrenceExpansionEnd(<google.gdata.DateTime|string|null> recurrenceExpansionEnd)

Sets the end of time period for which to expand recurring events.

Parameters:
recurrenceExpansionEnd - End of time period for which to expand recurring events or an equivalent string value or null to disable this parameter.

setRecurrenceExpansionStart

void setRecurrenceExpansionStart(<google.gdata.DateTime|string|null> recurrenceExpansionStart)

Sets the beginning of time period for which to expand recurring events.

Parameters:
recurrenceExpansionStart - Beginning of time period for which to expand recurring events or an equivalent string value or null to disable this parameter.

setShowAllowGSync

void setShowAllowGSync(<Boolean|string|null> showAllowGSync)

Sets the whether to include the allowGSync2 flag in the output. The default value is false.

Parameters:
showAllowGSync - Whether to include the allowGSync2 flag in the output or an equivalent string value or null to disable this parameter.

setShowHidden

void setShowHidden(<Boolean|string|null> showHidden)

Sets the whether to force including new invitation events. The default value is false.

Parameters:
showHidden - Whether to force including new invitation events or an equivalent string value or null to disable this parameter.

setSingleEvents

void setSingleEvents(<Boolean|string|null> singleEvents)

Sets the whether recurring events should be expanded or represented as a single event. The default value is false.

Parameters:
singleEvents - Whether recurring events should be expanded or represented as a single event or an equivalent string value or null to disable this parameter.

setSortOrder

void setSortOrder(<String?> sortOrder)

Sets the direction of sorting.

Parameters:
sortOrder - Direction of sorting or null to disable this parameter.

setStartIndex

void setStartIndex(<Number|string|null> startIndex)

Sets the 1-based index of the first result to be retrieved. The default value is 1.

Parameters:
startIndex - 1-based index of the first result to be retrieved or an equivalent string value or null to disable this parameter.

setUpdatedMax

void setUpdatedMax(<google.gdata.DateTime|string|null> updatedMax)

Sets the maximum updated date.

Parameters:
updatedMax - Maximum updated date or an equivalent string value or null to disable this parameter.

setUpdatedMin

void setUpdatedMin(<google.gdata.DateTime|string|null> updatedMin)

Sets the minimum updated date.

Parameters:
updatedMin - Minimum updated date or an equivalent string value or null to disable this parameter.