|
GData JavaScript Client 2.2 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Object | +--google.gdata.atom.Entry | +--google.gdata.Entry | +--google.gdata.calendar.CalendarEntry
Describes a Calendar entry in the feed of a user's calendars.
Defined in gdata.js
Field Summary | |
Object |
$accessLevelClass_
|
Object |
$colorClass_
|
Object |
$hiddenClass_
|
Object |
$linksClass_
|
Object |
$locationsClass_
|
Object |
$overrideNameClass_
|
Object |
$selectedClass_
|
Object |
$timesCleanedClass_
|
Object |
$timeZoneClass_
|
Fields inherited from class google.gdata.Entry |
$controlClass_, $editedClass_
|
Fields inherited from class google.gdata.atom.Entry |
$authorsClass_, $categoriesClass_, $contentClass_, $contributorsClass_, $idClass_, $linksClass_, $publishedClass_, $rightsClass_, $summaryClass_, $titleClass_, $updatedClass_, author, category, content, contributor, id, link, published, rights, summary, title, updated, xmlns
|
Constructor Summary | |
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. |
Method Summary | |
void
|
addLocation(<google.gdata.Where|Object> location)
Adds a new calendar location. |
google.gdata.calendar.CalendarLink|undefined
|
getAccessControlListLink()
Returns the link that provides the URI of the feed for the access control list for the entry. |
google.gdata.calendar.AccessLevelProperty|undefined
|
getAccessLevel()
Returns the access level property. |
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. |
google.gdata.calendar.ColorProperty|undefined
|
getColor()
Returns the color property. |
google.gdata.calendar.EventFeedLink|undefined
|
getEventFeedLink()
Returns the eventFeed event feed link. |
google.gdata.calendar.HiddenProperty|undefined
|
getHidden()
Returns the hidden property. |
boolean|undefined
|
getIncomplete()
Returns mode where the server returns incomplete entries (for which the full metadata could not be retrieved) . |
Array.<google.gdata.Where>
|
getLocations()
Returns the calendar locations. |
google.gdata.calendar.OverrideNameProperty|undefined
|
getOverrideName()
Returns the override name property. |
google.gdata.calendar.CalendarLink|undefined
|
getRelatedLink()
Returns the link that provides the URI of a related link to the entry. |
google.gdata.calendar.SelectedProperty|undefined
|
getSelected()
Returns the selected property. |
google.gdata.calendar.TimesCleanedProperty|undefined
|
getTimesCleaned()
Returns the times cleaned property. |
google.gdata.calendar.TimeZoneProperty|undefined
|
getTimeZone()
Returns the time zone property. |
void
|
setAccessLevel(<google.gdata.calendar.AccessLevelProperty|Object|undefined> accessLevel)
Sets the access level property. |
void
|
setColor(<google.gdata.calendar.ColorProperty|Object|undefined> color)
Sets the color property. |
void
|
setHidden(<google.gdata.calendar.HiddenProperty|Object|undefined> hidden)
Sets the hidden property. |
void
|
setIncomplete(<boolean|undefined> incomplete)
Sets mode where the server returns incomplete entries (for which the full metadata could not be retrieved) . |
void
|
setLocations(<Array.<google.gdata.Where>|Array.<Object>|undefined> locations)
Sets the calendar locations. |
void
|
setOverrideName(<google.gdata.calendar.OverrideNameProperty|Object|undefined> overrideName)
Sets the override name property. |
void
|
setSelected(<google.gdata.calendar.SelectedProperty|Object|undefined> selected)
Sets the selected property. |
void
|
setTimesCleaned(<google.gdata.calendar.TimesCleanedProperty|Object|undefined> timesCleaned)
Sets the times cleaned property. |
void
|
setTimeZone(<google.gdata.calendar.TimeZoneProperty|Object|undefined> timeZone)
Sets the time zone property. |
Methods inherited from class google.gdata.Entry |
getControl, setControl, getEdited, setEdited, getEtag, setEtag, getKind, setKind, getEditLink, getSelfLink, getLink, getSelf, updateEntry, deleteEntry
|
Methods inherited from class google.gdata.atom.Entry |
getAuthors, setAuthors, addAuthor, getCategories, setCategories, addCategory, getContent, setContent, getContributors, setContributors, addContributor, getId, setId, getLinks, setLinks, addLink, getPublished, setPublished, getRights, setRights, getSummary, setSummary, getTitle, setTitle, getUpdated, setUpdated
|
Field Detail |
Object $accessLevelClass_
Object $colorClass_
Object $hiddenClass_
Object $linksClass_
Object $locationsClass_
Object $overrideNameClass_
Object $selectedClass_
Object $timesCleanedClass_
Object $timeZoneClass_
Constructor Detail |
google.gdata.calendar.CalendarEntry(<Object> opt_params)
opt_params
- Optional parameters, each of which is used as the sole parameter to the associated setter method: accessLevel, authors, categories, color, content, contributors, etag, hidden, id, incomplete, links, locations, overrideName, published, selected, summary, timeZone, timesCleaned, title, and updated.
Method Detail |
void addLocation(<google.gdata.Where|Object> location)
location
- Calendar location to add, or object to use as a parameter to the google.gdata.Where constructor.
google.gdata.calendar.CalendarLink|undefined getAccessControlListLink()
google.gdata.calendar.AccessLevelProperty|undefined getAccessLevel()
google.gdata.calendar.CalendarLink|undefined getAtomAlternateLink()
google.gdata.calendar.ColorProperty|undefined getColor()
google.gdata.calendar.EventFeedLink|undefined getEventFeedLink()
google.gdata.calendar.HiddenProperty|undefined getHidden()
boolean|undefined getIncomplete()
Array.<google.gdata.Where> getLocations()
google.gdata.calendar.OverrideNameProperty|undefined getOverrideName()
google.gdata.calendar.CalendarLink|undefined getRelatedLink()
google.gdata.calendar.SelectedProperty|undefined getSelected()
google.gdata.calendar.TimesCleanedProperty|undefined getTimesCleaned()
google.gdata.calendar.TimeZoneProperty|undefined getTimeZone()
void setAccessLevel(<google.gdata.calendar.AccessLevelProperty|Object|undefined> accessLevel)
accessLevel
- Access level property, or object to use as a parameter to the google.gdata.calendar.AccessLevelProperty constructor, or undefined for none.
void setColor(<google.gdata.calendar.ColorProperty|Object|undefined> color)
color
- Color property, or object to use as a parameter to the google.gdata.calendar.ColorProperty constructor, or undefined for none.
void setHidden(<google.gdata.calendar.HiddenProperty|Object|undefined> hidden)
hidden
- Hidden property, or object to use as a parameter to the google.gdata.calendar.HiddenProperty constructor, or undefined for none.
void setIncomplete(<boolean|undefined> incomplete)
incomplete
- Mode where the server returns incomplete entries (for which the full metadata could not be retrieved) or undefined for none.
void setLocations(<Array.<google.gdata.Where>|Array.<Object>|undefined> locations)
locations
- Calendar locations, where each calendar location is added using the addLocation() function, or undefined to clear the calendar locations.
void setOverrideName(<google.gdata.calendar.OverrideNameProperty|Object|undefined> overrideName)
overrideName
- Override name property, or object to use as a parameter to the google.gdata.calendar.OverrideNameProperty constructor, or undefined for none.
void setSelected(<google.gdata.calendar.SelectedProperty|Object|undefined> selected)
selected
- Selected property, or object to use as a parameter to the google.gdata.calendar.SelectedProperty constructor, or undefined for none.
void setTimesCleaned(<google.gdata.calendar.TimesCleanedProperty|Object|undefined> timesCleaned)
timesCleaned
- Times cleaned property, or object to use as a parameter to the google.gdata.calendar.TimesCleanedProperty constructor, or undefined for none.
void setTimeZone(<google.gdata.calendar.TimeZoneProperty|Object|undefined> timeZone)
timeZone
- Time zone property, or object to use as a parameter to the google.gdata.calendar.TimeZoneProperty constructor, or undefined for none.
|
GData JavaScript Client 2.2 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |