Class google.gdata.calendar.CalendarEntry

Object
   |
   +--google.gdata.atom.Entry
         |
         +--google.gdata.Entry
               |
               +--google.gdata.calendar.CalendarEntry

class google.gdata.calendar.CalendarEntry

extends google.gdata.Entry

Describes a Calendar entry in the feed of a user's calendars.
Defined in gdata.js

Constructor Detail

google.gdata.calendar.CalendarEntry

google.gdata.calendar.CalendarEntry(<Object> opt_params)

Constructs a Calendar entry using an object parameter whose property names match the setter method to use for each property.

Parameters:
opt_params - Optional parameters, each of which is used as the sole parameter to the associated setter method: accessLevel, authors, categories, color, contributors, hidden, id, links, locations, overrideName, published, selected, summary, timeZone, title, and updated

addLocation

void addLocation(<google.gdata.Where|Object> location)

Adds a new calendar location.

Parameters:
location - Calendar location to add, or object to use as a parameter to the google.gdata.Where constructor

getAccessControlListLink

google.gdata.calendar.CalendarLink|undefined getAccessControlListLink()

Returns the link that provides the URI of the feed for the access control list for the entry.

Returns:
Link that provides the URI of the feed for the access control list for the entry or undefined for none

getAccessLevel

google.gdata.calendar.AccessLevelProperty|undefined getAccessLevel()

Returns the access level property. This element is required.

Returns:
Access level property or undefined for none

getAtomAlternateLink

google.gdata.calendar.CalendarLink|undefined getAtomAlternateLink()

Returns the link that provides the URI of an alternate format of the entry's or feed's contents.

Returns:
Link that provides the URI of an alternate format of the entry's or feed's contents or undefined for none

getColor

google.gdata.calendar.ColorProperty|undefined getColor()

Returns the color property. This element is required.

Returns:
Color property or undefined for none

getHidden

google.gdata.calendar.HiddenProperty|undefined getHidden()

Returns the hidden property. This element is required.

Returns:
Hidden property or undefined for none

getLinkClass

Object getLinkClass()

Returns the class to use for representing atom:link. Override to use an extension of google.gdata.atom.Link.

Returns:
Class to use for representing atom:link

getLocations

Array.<google.gdata.Where> getLocations()

Returns the calendar locations.

Returns:
Calendar locations

getOverrideName

google.gdata.calendar.OverrideNameProperty|undefined getOverrideName()

Returns the override name property. This element is optional.

Returns:
Override name property or undefined for none

getRelatedLink

google.gdata.calendar.CalendarLink|undefined getRelatedLink()

Returns the link that provides the URI of a related link to the entry.

Returns:
Link that provides the URI of a related link to the entry or undefined for none

getSelected

google.gdata.calendar.SelectedProperty|undefined getSelected()

Returns the selected property. This element is required.

Returns:
Selected property or undefined for none

getTimeZone

google.gdata.calendar.TimeZoneProperty|undefined getTimeZone()

Returns the time zone property. This element is required.

Returns:
Time zone property or undefined for none

setAccessLevel

void setAccessLevel(<google.gdata.calendar.AccessLevelProperty|Object|undefined> accessLevel)

Sets the access level property. This element is required.

Parameters:
accessLevel - Access level property, or object to use as a parameter to the google.gdata.calendar.AccessLevelProperty constructor, or undefined for none

setColor

void setColor(<google.gdata.calendar.ColorProperty|Object|undefined> color)

Sets the color property. This element is required.

Parameters:
color - Color property, or object to use as a parameter to the google.gdata.calendar.ColorProperty constructor, or undefined for none

setHidden

void setHidden(<google.gdata.calendar.HiddenProperty|Object|undefined> hidden)

Sets the hidden property. This element is required.

Parameters:
hidden - Hidden property, or object to use as a parameter to the google.gdata.calendar.HiddenProperty constructor, or undefined for none

setLocations

void setLocations(<Array.<google.gdata.Where>|Array.<Object>|undefined> locations)

Sets the calendar locations.

Parameters:
locations - Calendar locations, where each calendar location is added using the addLocation() function, or undefined to clear the calendar locations

setOverrideName

void setOverrideName(<google.gdata.calendar.OverrideNameProperty|Object|undefined> overrideName)

Sets the override name property. This element is optional.

Parameters:
overrideName - Override name property, or object to use as a parameter to the google.gdata.calendar.OverrideNameProperty constructor, or undefined for none

setSelected

void setSelected(<google.gdata.calendar.SelectedProperty|Object|undefined> selected)

Sets the selected property. This element is required.

Parameters:
selected - Selected property, or object to use as a parameter to the google.gdata.calendar.SelectedProperty constructor, or undefined for none

setTimeZone

void setTimeZone(<google.gdata.calendar.TimeZoneProperty|Object|undefined> timeZone)

Sets the time zone property. This element is required.

Parameters:
timeZone - Time zone property, or object to use as a parameter to the google.gdata.calendar.TimeZoneProperty constructor, or undefined for none