GData JavaScript Client 2.1

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 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.
 
Constructor Summary
google.gdata.calendar.CalendarEventQuery(<string> feedUri)
            Constructor.
 
Method Summary
 Boolean? getAllowIncomplete()
           Returns the whether to return incomplete results instead of failing the operation when some of the data cannot be retrieved.
 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 setAllowIncomplete(<Boolean|string|null> allowIncomplete)
           Sets the whether to return incomplete results instead of failing the operation when some of the data cannot be retrieved.
 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

ORDERBY_LAST_MODIFIED

<static> <final> {string} ORDERBY_LAST_MODIFIED

ORDERBY_START_TIME

<static> <final> {string} ORDERBY_START_TIME

SORTORDER_ASCENDING

<static> <final> {string} SORTORDER_ASCENDING

SORTORDER_DESCENDING

<static> <final> {string} SORTORDER_DESCENDING

Constructor Detail

google.gdata.calendar.CalendarEventQuery

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

Method Detail

getAllowIncomplete

Boolean? getAllowIncomplete()

getAuthor

String? getAuthor()

getFullTextQuery

String? getFullTextQuery()

getFutureEvents

Boolean? getFutureEvents()

getMaximumStartTime

google.gdata.DateTime? getMaximumStartTime()

getMaxResults

Number? getMaxResults()

getMinimumStartTime

google.gdata.DateTime? getMinimumStartTime()

getOrderBy

String? getOrderBy()

getRecurrenceExpansionEnd

google.gdata.DateTime? getRecurrenceExpansionEnd()

getRecurrenceExpansionStart

google.gdata.DateTime? getRecurrenceExpansionStart()

getShowAllowGSync

Boolean? getShowAllowGSync()

getShowHidden

Boolean? getShowHidden()

getSingleEvents

Boolean? getSingleEvents()

getSortOrder

String? getSortOrder()

getStartIndex

Number? getStartIndex()

getUpdatedMax

google.gdata.DateTime? getUpdatedMax()

getUpdatedMin

google.gdata.DateTime? getUpdatedMin()

setAllowIncomplete

void setAllowIncomplete(<Boolean|string|null> allowIncomplete)

setAuthor

void setAuthor(<String?> author)

setFullTextQuery

void setFullTextQuery(<String?> fullTextQuery)

setFutureEvents

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

setMaximumStartTime

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

setMaxResults

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

setMinimumStartTime

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

setOrderBy

void setOrderBy(<String?> orderBy)

setRecurrenceExpansionEnd

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

setRecurrenceExpansionStart

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

setShowAllowGSync

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

setShowHidden

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

setSingleEvents

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

setSortOrder

void setSortOrder(<String?> sortOrder)

setStartIndex

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

setUpdatedMax

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

setUpdatedMin

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

GData JavaScript Client 2.1

Documentation generated by JSDoc on Mon Nov 9 14:24:07 2009