GData JavaScript Client 1.5

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.
   
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

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

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.5

Documentation generated by JSDoc on Thu Oct 2 17:38:03 2008