GData JavaScript Client 1.0

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


 
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 specifies order of entries in a feed.
 google.gdata.DateTime|Null getRecurrenceExpansionEnd()
           Returns the specifies end of time period for which to expand recurring events.
 google.gdata.DateTime|Null getRecurrenceExpansionStart()
           Returns the specifies beginning of time period for which to expand recurring events.
 Boolean|Null getSingleEvents()
           Returns the indicates whether recurring events should be expanded or represented as a single event.
 String|Null getSortOrder()
           Returns the specifies 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 specifies order of entries in a feed.
 void setRecurrenceExpansionEnd(<google.gdata.DateTime|String|Null> recurrenceExpansionEnd)
           Sets the specifies end of time period for which to expand recurring events.
 void setRecurrenceExpansionStart(<google.gdata.DateTime|String|Null> recurrenceExpansionStart)
           Sets the specifies beginning of time period for which to expand recurring events.
 void setSingleEvents(<Boolean|String|Null> singleEvents)
           Sets the indicates whether recurring events should be expanded or represented as a single event.
 void setSortOrder(<String|Null> sortOrder)
           Sets the specifies 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
 

Constructor Detail

google.gdata.calendar.CalendarEventQuery

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

Method Detail

getAuthor

String|Null getAuthor()

getFullTextQuery

String|Null getFullTextQuery()

getFutureEvents

Boolean|Null getFutureEvents()

getMaximumStartTime

google.gdata.DateTime|Null getMaximumStartTime()

getMaxResults

Number|Null getMaxResults()

getMinimumStartTime

google.gdata.DateTime|Null getMinimumStartTime()

getOrderBy

String|Null getOrderBy()

getRecurrenceExpansionEnd

google.gdata.DateTime|Null getRecurrenceExpansionEnd()

getRecurrenceExpansionStart

google.gdata.DateTime|Null getRecurrenceExpansionStart()

getSingleEvents

Boolean|Null getSingleEvents()

getSortOrder

String|Null getSortOrder()

getStartIndex

Number|Null getStartIndex()

getUpdatedMax

google.gdata.DateTime|Null getUpdatedMax()

getUpdatedMin

google.gdata.DateTime|Null getUpdatedMin()

setAuthor

void setAuthor(<String|Null> author)

setFullTextQuery

void setFullTextQuery(<String|Null> 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|Null> orderBy)

setRecurrenceExpansionEnd

void setRecurrenceExpansionEnd(<google.gdata.DateTime|String|Null> recurrenceExpansionEnd)

setRecurrenceExpansionStart

void setRecurrenceExpansionStart(<google.gdata.DateTime|String|Null> recurrenceExpansionStart)

setSingleEvents

void setSingleEvents(<Boolean|String|Null> singleEvents)

setSortOrder

void setSortOrder(<String|Null> 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 1.0

Documentation generated by JSDoc on Fri Sep 14 16:32:36 2007