Class google.gdata.EventEntry

Object
   |
   +--google.gdata.atom.Entry
         |
         +--google.gdata.Entry
               |
               +--google.gdata.EventEntry

Direct Known Subclasses:

google.gdata.calendar.CalendarEventEntry

class google.gdata.EventEntry

extends google.gdata.Entry

Describes an event entry.
Defined in gdata.js

Field Detail

$commentsClass_

Object $commentsClass_

$participantsClass_

Object $participantsClass_

$recurrenceExceptionClass_

Object $recurrenceExceptionClass_

google.gdata.EventEntry

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.

Parameters:
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

addLocation

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

Adds a new event location.

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

addParticipant

void addParticipant(<google.gdata.Who|Object> participant)

Adds a new event participant.

Parameters:
participant - Event participant to add, or object to use as a parameter to the google.gdata.Who constructor

addRecurrenceException

void addRecurrenceException(<google.gdata.RecurrenceException|Object> recurrenceException)

Adds a new recurrence exception.

Parameters:
recurrenceException - Recurrence exception to add, or object to use as a parameter to the google.gdata.RecurrenceException constructor

addReminder

void addReminder(<google.gdata.Reminder|Object> reminder)

Adds a new event reminder.

Parameters:
reminder - Event reminder to add, or object to use as a parameter to the google.gdata.Reminder constructor

addTime

void addTime(<google.gdata.When|Object> time)

Adds a new event time.

Parameters:
time - Event time to add, or object to use as a parameter to the google.gdata.When constructor

getComments

google.gdata.Comments|undefined getComments()

Returns the nested comments feed. This element is optional.

Returns:
Nested comments feed or undefined for none

getEventStatus

google.gdata.EventStatus|undefined getEventStatus()

Returns the event status. This element is optional.

Returns:
Event status or undefined for none

getLocations

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

Returns the event locations.

Returns:
Event locations

getOriginalEvent

google.gdata.OriginalEvent|undefined getOriginalEvent()

Returns the event original start time. This element is optional.

Returns:
Event original start time or undefined for none

getParticipants

Array.<google.gdata.Who> getParticipants()

Returns the event participants.

Returns:
Event participants

getRecurrence

google.gdata.Recurrence|undefined getRecurrence()

Returns the event recurrence. This element is optional.

Returns:
Event recurrence or undefined for none

getRecurrenceException

Array.<google.gdata.RecurrenceException> getRecurrenceException()

Returns the recurrence exceptions.

Returns:
Recurrence exceptions

getReminders

Array.<google.gdata.Reminder> getReminders()

Returns the event reminders.

Returns:
Event reminders

getTimes

Array.<google.gdata.When> getTimes()

Returns the event times.

Returns:
Event times

getTransparency

google.gdata.Transparency|undefined getTransparency()

Returns the event transparency. This element is optional.

Returns:
Event transparency or undefined for none

getVisibility

google.gdata.Visibility|undefined getVisibility()

Returns the event visibility. This element is optional.

Returns:
Event visibility or undefined for none

setComments

void setComments(<google.gdata.Comments|Object|undefined> comments)

Sets the nested comments feed. This element is optional.

Parameters:
comments - Nested comments feed, or object to use as a parameter to the google.gdata.Comments constructor, or undefined for none

setEventStatus

void setEventStatus(<google.gdata.EventStatus|Object|undefined> eventStatus)

Sets the event status. This element is optional.

Parameters:
eventStatus - Event status, or object to use as a parameter to the google.gdata.EventStatus constructor, or undefined for none

setLocations

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

Sets the event locations.

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

setOriginalEvent

void setOriginalEvent(<google.gdata.OriginalEvent|Object|undefined> originalEvent)

Sets the event original start time. This element is optional.

Parameters:
originalEvent - Event original start time, or object to use as a parameter to the google.gdata.OriginalEvent constructor, or undefined for none

setParticipants

void setParticipants(<Array.<google.gdata.Who>|Array.<Object>|undefined> participants)

Sets the event participants.

Parameters:
participants - Event participants, where each event participant is added using the addParticipant() function, or undefined to clear the event participants

setRecurrence

void setRecurrence(<google.gdata.Recurrence|Object|undefined> recurrence)

Sets the event recurrence. This element is optional.

Parameters:
recurrence - Event recurrence, or object to use as a parameter to the google.gdata.Recurrence constructor, or undefined for none

setRecurrenceException

void setRecurrenceException(<Array.<google.gdata.RecurrenceException>|Array.<Object>|undefined> recurrenceException)

Sets the recurrence exceptions.

Parameters:
recurrenceException - Recurrence exceptions, where each recurrence exception is added using the addRecurrenceException() function, or undefined to clear the recurrence exceptions

setReminders

void setReminders(<Array.<google.gdata.Reminder>|Array.<Object>|undefined> reminders)

Sets the event reminders.

Parameters:
reminders - Event reminders, where each event reminder is added using the addReminder() function, or undefined to clear the event reminders

setTimes

void setTimes(<Array.<google.gdata.When>|Array.<Object>|undefined> times)

Sets the event times.

Parameters:
times - Event times, where each event time is added using the addTime() function, or undefined to clear the event times

setTransparency

void setTransparency(<google.gdata.Transparency|Object|undefined> transparency)

Sets the event transparency. This element is optional.

Parameters:
transparency - Event transparency, or object to use as a parameter to the google.gdata.Transparency constructor, or undefined for none

setVisibility

void setVisibility(<google.gdata.Visibility|Object|undefined> visibility)

Sets the event visibility. This element is optional.

Parameters:
visibility - Event visibility, or object to use as a parameter to the google.gdata.Visibility constructor, or undefined for none