|
GData JavaScript Client 1.3 | ||||||||
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.EventEntry
Describes an event entry.
Defined in gdata.js
Field Summary | |
Object |
$commentsClass_
|
Object |
$participantsClass_
|
Object |
$recurrenceExceptionClass_
|
Fields inherited from class google.gdata.Entry |
$controlClass_
|
Fields inherited from class google.gdata.atom.Entry |
$authorsClass_, $categoriesClass_, $contributorsClass_, $linksClass_, author, category, content, contributor, id, link, published, rights, summary, title, updated, xmlns
|
Constructor Summary | |
google.gdata.EventEntry(<Object> opt_params)
Constructs an event 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 event location. |
void
|
addParticipant(<google.gdata.Who|Object> participant)
Adds a new event participant. |
void
|
addRecurrenceException(<google.gdata.RecurrenceException|Object> recurrenceException)
Adds a new recurrence exception. |
void
|
addReminder(<google.gdata.Reminder|Object> reminder)
Adds a new event reminder. |
void
|
addTime(<google.gdata.When|Object> time)
Adds a new event time. |
google.gdata.Comments|undefined
|
getComments()
Returns the nested comments feed. |
google.gdata.EventStatus|undefined
|
getEventStatus()
Returns the event status. |
Array.<google.gdata.Where>
|
getLocations()
Returns the event locations. |
google.gdata.OriginalEvent|undefined
|
getOriginalEvent()
Returns the event original start time. |
Array.<google.gdata.Who>
|
getParticipants()
Returns the event participants. |
google.gdata.Recurrence|undefined
|
getRecurrence()
Returns the event recurrence. |
Array.<google.gdata.RecurrenceException>
|
getRecurrenceException()
Returns the recurrence exceptions. |
Array.<google.gdata.Reminder>
|
getReminders()
Returns the event reminders. |
Array.<google.gdata.When>
|
getTimes()
Returns the event times. |
google.gdata.Transparency|undefined
|
getTransparency()
Returns the event transparency. |
google.gdata.Visibility|undefined
|
getVisibility()
Returns the event visibility. |
void
|
setComments(<google.gdata.Comments|Object|undefined> comments)
Sets the nested comments feed. |
void
|
setEventStatus(<google.gdata.EventStatus|Object|undefined> eventStatus)
Sets the event status. |
void
|
setLocations(<Array.<google.gdata.Where>|Array.<Object>|undefined> locations)
Sets the event locations. |
void
|
setOriginalEvent(<google.gdata.OriginalEvent|Object|undefined> originalEvent)
Sets the event original start time. |
void
|
setParticipants(<Array.<google.gdata.Who>|Array.<Object>|undefined> participants)
Sets the event participants. |
void
|
setRecurrence(<google.gdata.Recurrence|Object|undefined> recurrence)
Sets the event recurrence. |
void
|
setRecurrenceException(<Array.<google.gdata.RecurrenceException>|Array.<Object>|undefined> recurrenceException)
Sets the recurrence exceptions. |
void
|
setReminders(<Array.<google.gdata.Reminder>|Array.<Object>|undefined> reminders)
Sets the event reminders. |
void
|
setTimes(<Array.<google.gdata.When>|Array.<Object>|undefined> times)
Sets the event times. |
void
|
setTransparency(<google.gdata.Transparency|Object|undefined> transparency)
Sets the event transparency. |
void
|
setVisibility(<google.gdata.Visibility|Object|undefined> visibility)
Sets the event visibility. |
Methods inherited from class google.gdata.Entry |
getControl, setControl, getEdited, setEdited, 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 $commentsClass_
Object $participantsClass_
Object $recurrenceExceptionClass_
Constructor Detail |
google.gdata.EventEntry(<Object> opt_params)
opt_params
- Optional parameters, each of which is used as the sole parameter to the associated setter method: authors, categories, comments, content, contributors, eventStatus, id, links, locations, originalEvent, participants, published, recurrence, recurrenceException, reminders, summary, times, title, transparency, updated, and visibility
Method Detail |
void addLocation(<google.gdata.Where|Object> location)
location
- Event location to add, or object to use as a parameter to the google.gdata.Where constructor
void addParticipant(<google.gdata.Who|Object> participant)
participant
- Event participant to add, or object to use as a parameter to the google.gdata.Who constructor
void addRecurrenceException(<google.gdata.RecurrenceException|Object> recurrenceException)
recurrenceException
- Recurrence exception to add, or object to use as a parameter to the google.gdata.RecurrenceException constructor
void addReminder(<google.gdata.Reminder|Object> reminder)
reminder
- Event reminder to add, or object to use as a parameter to the google.gdata.Reminder constructor
void addTime(<google.gdata.When|Object> time)
time
- Event time to add, or object to use as a parameter to the google.gdata.When constructor
google.gdata.Comments|undefined getComments()
google.gdata.EventStatus|undefined getEventStatus()
Array.<google.gdata.Where> getLocations()
google.gdata.OriginalEvent|undefined getOriginalEvent()
Array.<google.gdata.Who> getParticipants()
google.gdata.Recurrence|undefined getRecurrence()
Array.<google.gdata.RecurrenceException> getRecurrenceException()
Array.<google.gdata.Reminder> getReminders()
Array.<google.gdata.When> getTimes()
google.gdata.Transparency|undefined getTransparency()
google.gdata.Visibility|undefined getVisibility()
void setComments(<google.gdata.Comments|Object|undefined> comments)
comments
- Nested comments feed, or object to use as a parameter to the google.gdata.Comments constructor, or undefined for none
void setEventStatus(<google.gdata.EventStatus|Object|undefined> eventStatus)
eventStatus
- Event status, or object to use as a parameter to the google.gdata.EventStatus constructor, or undefined for none
void setLocations(<Array.<google.gdata.Where>|Array.<Object>|undefined> locations)
locations
- Event locations, where each event location is added using the addLocation() function, or undefined to clear the event locations
void setOriginalEvent(<google.gdata.OriginalEvent|Object|undefined> originalEvent)
originalEvent
- Event original start time, or object to use as a parameter to the google.gdata.OriginalEvent constructor, or undefined for none
void setParticipants(<Array.<google.gdata.Who>|Array.<Object>|undefined> participants)
participants
- Event participants, where each event participant is added using the addParticipant() function, or undefined to clear the event participants
void setRecurrence(<google.gdata.Recurrence|Object|undefined> recurrence)
recurrence
- Event recurrence, or object to use as a parameter to the google.gdata.Recurrence constructor, or undefined for none
void setRecurrenceException(<Array.<google.gdata.RecurrenceException>|Array.<Object>|undefined> recurrenceException)
recurrenceException
- Recurrence exceptions, where each recurrence exception is added using the addRecurrenceException() function, or undefined to clear the recurrence exceptions
void setReminders(<Array.<google.gdata.Reminder>|Array.<Object>|undefined> reminders)
reminders
- Event reminders, where each event reminder is added using the addReminder() function, or undefined to clear the event reminders
void setTimes(<Array.<google.gdata.When>|Array.<Object>|undefined> times)
times
- Event times, where each event time is added using the addTime() function, or undefined to clear the event times
void setTransparency(<google.gdata.Transparency|Object|undefined> transparency)
transparency
- Event transparency, or object to use as a parameter to the google.gdata.Transparency constructor, or undefined for none
void setVisibility(<google.gdata.Visibility|Object|undefined> visibility)
visibility
- Event visibility, or object to use as a parameter to the google.gdata.Visibility constructor, or undefined for none
|
GData JavaScript Client 1.3 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |