|
GData JavaScript Client 2.0 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Object | +--google.gdata.client.Query | +--google.gdata.calendar.CalendarEventQuery
Describes a query for the feed of a calendar's events.
Defined in gdata.js
Field Summary | |
<static> <final> {string} |
ORDERBY_LAST_MODIFIED
Order the returned feed's entries by their <updated> values. |
<static> <final> {string} |
ORDERBY_START_TIME
Order the returned feed's entries by the <gd:when> element's starttime attribute. |
<static> <final> {string} |
SORTORDER_ASCENDING
Ascending. |
<static> <final> {string} |
SORTORDER_DESCENDING
Descending. |
Fields inherited from class google.gdata.client.Query |
feedUri
|
Constructor Summary | |
google.gdata.calendar.CalendarEventQuery(<string> feedUri)
Constructor. |
Method Summary | |
String?
|
getAuthor()
Returns the author name or email address. |
String?
|
getFullTextQuery()
Returns the full-text query string. |
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. |
google.gdata.DateTime?
|
getMaximumStartTime()
Returns the latest event start time to match (default is 2031-01-01). |
Number?
|
getMaxResults()
Returns the maximum number of results to be retrieved. |
google.gdata.DateTime?
|
getMinimumStartTime()
Returns the earliest event start time to match (default is 1970-01-01). |
String?
|
getOrderBy()
Returns the order of entries in a feed. |
google.gdata.DateTime?
|
getRecurrenceExpansionEnd()
Returns the end of time period for which to expand recurring events. |
google.gdata.DateTime?
|
getRecurrenceExpansionStart()
Returns the beginning of time period for which to expand recurring events. |
Boolean?
|
getShowAllowGSync()
Returns the whether to include the allowGSync2 flag in the output. |
Boolean?
|
getShowHidden()
Returns the whether to force including new invitation events. |
Boolean?
|
getSingleEvents()
Returns the whether recurring events should be expanded or represented as a single event. |
String?
|
getSortOrder()
Returns the direction of sorting. |
Number?
|
getStartIndex()
Returns the 1-based index of the first result to be retrieved. |
google.gdata.DateTime?
|
getUpdatedMax()
Returns the maximum updated date. |
google.gdata.DateTime?
|
getUpdatedMin()
Returns the minimum updated date. |
void
|
setAuthor(<String?> author)
Sets the author name or email address. |
void
|
setFullTextQuery(<String?> fullTextQuery)
Sets the full-text query string. |
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. |
void
|
setMaximumStartTime(<google.gdata.DateTime|string|null> maximumStartTime)
Sets the latest event start time to match (default is 2031-01-01). |
void
|
setMaxResults(<Number|string|null> maxResults)
Sets the maximum number of results to be retrieved. |
void
|
setMinimumStartTime(<google.gdata.DateTime|string|null> minimumStartTime)
Sets the earliest event start time to match (default is 1970-01-01). |
void
|
setOrderBy(<String?> orderBy)
Sets the order of entries in a feed. |
void
|
setRecurrenceExpansionEnd(<google.gdata.DateTime|string|null> recurrenceExpansionEnd)
Sets the end of time period for which to expand recurring events. |
void
|
setRecurrenceExpansionStart(<google.gdata.DateTime|string|null> recurrenceExpansionStart)
Sets the beginning of time period for which to expand recurring events. |
void
|
setShowAllowGSync(<Boolean|string|null> showAllowGSync)
Sets the whether to include the allowGSync2 flag in the output. |
void
|
setShowHidden(<Boolean|string|null> showHidden)
Sets the whether to force including new invitation events. |
void
|
setSingleEvents(<Boolean|string|null> singleEvents)
Sets the whether recurring events should be expanded or represented as a single event. |
void
|
setSortOrder(<String?> sortOrder)
Sets the direction of sorting. |
void
|
setStartIndex(<Number|string|null> startIndex)
Sets the 1-based index of the first result to be retrieved. |
void
|
setUpdatedMax(<google.gdata.DateTime|string|null> updatedMax)
Sets the maximum updated date. |
void
|
setUpdatedMin(<google.gdata.DateTime|string|null> updatedMin)
Sets the minimum updated date. |
Methods inherited from class google.gdata.client.Query |
setParamDef, setParam, getPath, getUri, getParam
|
Field Detail |
<static> <final> {string} ORDERBY_LAST_MODIFIED
<static> <final> {string} ORDERBY_START_TIME
<static> <final> {string} SORTORDER_ASCENDING
<static> <final> {string} SORTORDER_DESCENDING
Constructor Detail |
google.gdata.calendar.CalendarEventQuery(<string> feedUri)
feedUri
- URI of feed.
Method Detail |
String? getAuthor()
null
to indicate that the parameter is disabled.
String? getFullTextQuery()
null
to indicate that the parameter is disabled.
Boolean? getFutureEvents()
null
to indicate that the parameter is disabled.
google.gdata.DateTime? getMaximumStartTime()
null
to indicate that the parameter is disabled.
Number? getMaxResults()
null
to indicate that the parameter is disabled.
google.gdata.DateTime? getMinimumStartTime()
null
to indicate that the parameter is disabled.
String? getOrderBy()
null
to indicate that the parameter is disabled.
google.gdata.DateTime? getRecurrenceExpansionEnd()
null
to indicate that the parameter is disabled.
google.gdata.DateTime? getRecurrenceExpansionStart()
null
to indicate that the parameter is disabled.
Boolean? getShowAllowGSync()
null
to indicate that the parameter is disabled.
Boolean? getShowHidden()
null
to indicate that the parameter is disabled.
Boolean? getSingleEvents()
null
to indicate that the parameter is disabled.
String? getSortOrder()
null
to indicate that the parameter is disabled.
Number? getStartIndex()
null
to indicate that the parameter is disabled.
google.gdata.DateTime? getUpdatedMax()
null
to indicate that the parameter is disabled.
google.gdata.DateTime? getUpdatedMin()
null
to indicate that the parameter is disabled.
void setAuthor(<String?> author)
author
- Author name or email address or null
to disable this parameter.
void setFullTextQuery(<String?> fullTextQuery)
fullTextQuery
- Full-text query string or null
to disable this parameter.
void setFutureEvents(<Boolean|string|null> futureEvents)
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.
void setMaximumStartTime(<google.gdata.DateTime|string|null> maximumStartTime)
maximumStartTime
- Latest event start time to match (default is 2031-01-01) or an equivalent string value or null
to disable this parameter.
void setMaxResults(<Number|string|null> maxResults)
maxResults
- Maximum number of results to be retrieved or an equivalent string value or null
to disable this parameter.
void setMinimumStartTime(<google.gdata.DateTime|string|null> minimumStartTime)
minimumStartTime
- Earliest event start time to match (default is 1970-01-01) or an equivalent string value or null
to disable this parameter.
void setOrderBy(<String?> orderBy)
orderBy
- Order of entries in a feed or null
to disable this parameter.
void setRecurrenceExpansionEnd(<google.gdata.DateTime|string|null> recurrenceExpansionEnd)
recurrenceExpansionEnd
- End of time period for which to expand recurring events or an equivalent string value or null
to disable this parameter.
void setRecurrenceExpansionStart(<google.gdata.DateTime|string|null> recurrenceExpansionStart)
recurrenceExpansionStart
- Beginning of time period for which to expand recurring events or an equivalent string value or null
to disable this parameter.
void setShowAllowGSync(<Boolean|string|null> showAllowGSync)
showAllowGSync
- Whether to include the allowGSync2 flag in the output or an equivalent string value or null
to disable this parameter.
void setShowHidden(<Boolean|string|null> showHidden)
showHidden
- Whether to force including new invitation events or an equivalent string value or null
to disable this parameter.
void setSingleEvents(<Boolean|string|null> singleEvents)
singleEvents
- Whether recurring events should be expanded or represented as a single event or an equivalent string value or null
to disable this parameter.
void setSortOrder(<String?> sortOrder)
sortOrder
- Direction of sorting or null
to disable this parameter.
void setStartIndex(<Number|string|null> startIndex)
startIndex
- 1-based index of the first result to be retrieved or an equivalent string value or null
to disable this parameter.
void setUpdatedMax(<google.gdata.DateTime|string|null> updatedMax)
updatedMax
- Maximum updated date or an equivalent string value or null
to disable this parameter.
void setUpdatedMin(<google.gdata.DateTime|string|null> updatedMin)
updatedMin
- Minimum updated date or an equivalent string value or null
to disable this parameter.
|
GData JavaScript Client 2.0 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |