|
GData JavaScript Client 1.3 | ||||||||
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|null
|
getAuthor()
Returns the author name or email address. |
String|null
|
getFullTextQuery()
Returns the full-text query string. |
Boolean|null
|
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|null
|
getMaximumStartTime()
Returns the latest event start time to match (default is 2031-01-01). |
Number|null
|
getMaxResults()
Returns the maximum number of results to be retrieved. |
google.gdata.DateTime|null
|
getMinimumStartTime()
Returns the earliest event start time to match (default is 1970-01-01). |
String|null
|
getOrderBy()
Returns the order of entries in a feed. |
google.gdata.DateTime|null
|
getRecurrenceExpansionEnd()
Returns the end of time period for which to expand recurring events. |
google.gdata.DateTime|null
|
getRecurrenceExpansionStart()
Returns the beginning of time period for which to expand recurring events. |
Boolean|null
|
getSingleEvents()
Returns the whether recurring events should be expanded or represented as a single event. |
String|null
|
getSortOrder()
Returns the direction of sorting. |
Number|null
|
getStartIndex()
Returns the 1-based index of the first result to be retrieved. |
google.gdata.DateTime|null
|
getUpdatedMax()
Returns the maximum updated date. |
google.gdata.DateTime|null
|
getUpdatedMin()
Returns the minimum updated date. |
void
|
setAuthor(<String|null> author)
Sets the author name or email address. |
void
|
setFullTextQuery(<String|null> 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|null> 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
|
setSingleEvents(<Boolean|String|null> singleEvents)
Sets the whether recurring events should be expanded or represented as a single event. |
void
|
setSortOrder(<String|null> 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|null getAuthor()
null
to indicate that the parameter is disabled
String|null getFullTextQuery()
null
to indicate that the parameter is disabled
Boolean|null getFutureEvents()
null
to indicate that the parameter is disabled
google.gdata.DateTime|null getMaximumStartTime()
null
to indicate that the parameter is disabled
Number|null getMaxResults()
null
to indicate that the parameter is disabled
google.gdata.DateTime|null getMinimumStartTime()
null
to indicate that the parameter is disabled
String|null getOrderBy()
null
to indicate that the parameter is disabled
google.gdata.DateTime|null getRecurrenceExpansionEnd()
null
to indicate that the parameter is disabled
google.gdata.DateTime|null getRecurrenceExpansionStart()
null
to indicate that the parameter is disabled
Boolean|null getSingleEvents()
null
to indicate that the parameter is disabled
String|null getSortOrder()
null
to indicate that the parameter is disabled
Number|null getStartIndex()
null
to indicate that the parameter is disabled
google.gdata.DateTime|null getUpdatedMax()
null
to indicate that the parameter is disabled
google.gdata.DateTime|null getUpdatedMin()
null
to indicate that the parameter is disabled
void setAuthor(<String|null> author)
author
- Author name or email address or null
to disable this parameter
void setFullTextQuery(<String|null> 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|null> 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 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|null> 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 1.3 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |