com.google.api.services.calendar.model
Class Event

java.lang.Object
  extended by java.util.AbstractMap<String,Object>
      extended by com.google.api.client.util.GenericData
          extended by com.google.api.client.json.GenericJson
              extended by com.google.api.services.calendar.model.Event
All Implemented Interfaces:
Cloneable, Map<String,Object>

public final class Event
extends com.google.api.client.json.GenericJson

Model definition for Calendar.Event. This class models an object which will be transmitted to or from the Calendar service. To reduce the data transferred during service requests, you may remove members that contain data elements that your application does not need. For a detailed explanation, see: http://code.google.com/p/google-api-java-client/wiki/Json

Author:
Google, Inc.

Nested Class Summary
 
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
 
Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>
 
Field Summary
 
Fields inherited from class com.google.api.client.json.GenericJson
jsonFactory
 
Constructor Summary
Event()
           
 
Method Summary
 Boolean getAnyoneCanAddSelf()
          Whether anyone can invite themselves to the event.
 List<EventAttendee> getAttendees()
          The attendees of the event.
 Boolean getAttendeesOmitted()
          Whether attendees have been omitted from the event's representation.
 String getColorId()
          The color of the event.
 com.google.api.client.util.DateTime getCreated()
          Creation time of the event (as a RFC 3339 timestamp).
 EventCreator getCreator()
          The creator of the event.
 String getDescription()
          Description of the event.
 EventDateTime getEnd()
          The end time of the event.
 String getEtag()
          ETag of the resource.
 EventExtendedProperties getExtendedProperties()
          Extended properties of the event.
 EventGadget getGadget()
          A gadget that extends this event.
 Boolean getGuestsCanInviteOthers()
          Whether attendees other than the organizer can invite others to the event.
 Boolean getGuestsCanModify()
          Whether attendees other than the organizer can modify the event.
 Boolean getGuestsCanSeeOtherGuests()
          Whether attendees other than the organizer can see who the event's attendees are.
 String getHtmlLink()
          An absolute link to this event in the Google Calendar Web UI.
 String getICalUID()
          Event ID in the iCalendar format.
 String getId()
          Identifier of the event.
 String getKind()
          Type of the resource ("calendar#event").
 String getLocation()
          Geographic location of the event as free-form text.
 EventOrganizer getOrganizer()
          The organizer of the event.
 EventDateTime getOriginalStartTime()
          For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId.
 Boolean getPrivateCopy()
          Whether this is a private event copy where changes are not shared with other copies on other calendars.
 List<String> getRecurrence()
          List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event.
 String getRecurringEventId()
          For an instance of a recurring event, this is the event ID of the recurring event itself.
 EventReminders getReminders()
          Information about the event's reminders for the authenticated user.
 com.google.api.client.http.HttpHeaders getResponseHeaders()
          Returns the HTTP headers that were returned with the server response, or null.
 Integer getSequence()
          Sequence number as per iCalendar.
 EventDateTime getStart()
          The start time of the event.
 String getStatus()
          Status of the event.
 String getSummary()
          Title of the event.
 String getTransparency()
          Whether the event blocks time on the calendar.
 com.google.api.client.util.DateTime getUpdated()
          Last modification time of the event (as a RFC 3339 timestamp).
 String getVisibility()
          Visibility of the event.
 Event setAnyoneCanAddSelf(Boolean anyoneCanAddSelf)
          Whether anyone can invite themselves to the event.
 Event setAttendees(List<EventAttendee> attendees)
          The attendees of the event.
 Event setAttendeesOmitted(Boolean attendeesOmitted)
          Whether attendees have been omitted from the event's representation.
 Event setColorId(String colorId)
          The color of the event.
 Event setCreated(com.google.api.client.util.DateTime created)
          Creation time of the event (as a RFC 3339 timestamp).
 Event setCreator(EventCreator creator)
          The creator of the event.
 Event setDescription(String description)
          Description of the event.
 Event setEnd(EventDateTime end)
          The end time of the event.
 Event setEtag(String etag)
          ETag of the resource.
 Event setExtendedProperties(EventExtendedProperties extendedProperties)
          Extended properties of the event.
 Event setGadget(EventGadget gadget)
          A gadget that extends this event.
 Event setGuestsCanInviteOthers(Boolean guestsCanInviteOthers)
          Whether attendees other than the organizer can invite others to the event.
 Event setGuestsCanModify(Boolean guestsCanModify)
          Whether attendees other than the organizer can modify the event.
 Event setGuestsCanSeeOtherGuests(Boolean guestsCanSeeOtherGuests)
          Whether attendees other than the organizer can see who the event's attendees are.
 Event setHtmlLink(String htmlLink)
          An absolute link to this event in the Google Calendar Web UI.
 Event setICalUID(String iCalUID)
          Event ID in the iCalendar format.
 Event setId(String id)
          Identifier of the event.
 Event setKind(String kind)
          Type of the resource ("calendar#event").
 Event setLocation(String location)
          Geographic location of the event as free-form text.
 Event setOrganizer(EventOrganizer organizer)
          The organizer of the event.
 Event setOriginalStartTime(EventDateTime originalStartTime)
          For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId.
 Event setPrivateCopy(Boolean privateCopy)
          Whether this is a private event copy where changes are not shared with other copies on other calendars.
 Event setRecurrence(List<String> recurrence)
          List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event.
 Event setRecurringEventId(String recurringEventId)
          For an instance of a recurring event, this is the event ID of the recurring event itself.
 Event setReminders(EventReminders reminders)
          Information about the event's reminders for the authenticated user.
 void setResponseHeaders(com.google.api.client.http.HttpHeaders responseHeaders)
          Sets the HTTP headers returned with the server response, or null.
 Event setSequence(Integer sequence)
          Sequence number as per iCalendar.
 Event setStart(EventDateTime start)
          The start time of the event.
 Event setStatus(String status)
          Status of the event.
 Event setSummary(String summary)
          Title of the event.
 Event setTransparency(String transparency)
          Whether the event blocks time on the calendar.
 Event setUpdated(com.google.api.client.util.DateTime updated)
          Last modification time of the event (as a RFC 3339 timestamp).
 Event setVisibility(String visibility)
          Visibility of the event.
 
Methods inherited from class com.google.api.client.json.GenericJson
clone, getFactory, setFactory, toPrettyString, toString
 
Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getUnknownKeys, put, putAll, remove, set, setUnknownKeys
 
Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Event

public Event()
Method Detail

getCreator

public EventCreator getCreator()
The creator of the event. Read-only.


setCreator

public Event setCreator(EventCreator creator)
The creator of the event. Read-only.


getOrganizer

public EventOrganizer getOrganizer()
The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True.


setOrganizer

public Event setOrganizer(EventOrganizer organizer)
The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True.


getId

public String getId()
Identifier of the event.


setId

public Event setId(String id)
Identifier of the event.


getAttendees

public List<EventAttendee> getAttendees()
The attendees of the event.


setAttendees

public Event setAttendees(List<EventAttendee> attendees)
The attendees of the event.


getHtmlLink

public String getHtmlLink()
An absolute link to this event in the Google Calendar Web UI. Read-only.


setHtmlLink

public Event setHtmlLink(String htmlLink)
An absolute link to this event in the Google Calendar Web UI. Read-only.


getRecurrence

public List<String> getRecurrence()
List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.


setRecurrence

public Event setRecurrence(List<String> recurrence)
List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.


getStart

public EventDateTime getStart()
The start time of the event. For a recurring event, this is the start time of the first instance.


setStart

public Event setStart(EventDateTime start)
The start time of the event. For a recurring event, this is the start time of the first instance.


getEtag

public String getEtag()
ETag of the resource.


setEtag

public Event setEtag(String etag)
ETag of the resource.


getLocation

public String getLocation()
Geographic location of the event as free-form text. Optional.


setLocation

public Event setLocation(String location)
Geographic location of the event as free-form text. Optional.


getRecurringEventId

public String getRecurringEventId()
For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.


setRecurringEventId

public Event setRecurringEventId(String recurringEventId)
For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.


getOriginalStartTime

public EventDateTime getOriginalStartTime()
For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.


setOriginalStartTime

public Event setOriginalStartTime(EventDateTime originalStartTime)
For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.


getStatus

public String getStatus()
Status of the event. Optional. Possible values are: - "confirmed" - The event is confirmed. This is the default status. - "tentative" - The event is tentatively confirmed. - "cancelled" - The event is cancelled.


setStatus

public Event setStatus(String status)
Status of the event. Optional. Possible values are: - "confirmed" - The event is confirmed. This is the default status. - "tentative" - The event is tentatively confirmed. - "cancelled" - The event is cancelled.


getUpdated

public com.google.api.client.util.DateTime getUpdated()
Last modification time of the event (as a RFC 3339 timestamp). Read-only.


setUpdated

public Event setUpdated(com.google.api.client.util.DateTime updated)
Last modification time of the event (as a RFC 3339 timestamp). Read-only.


getGadget

public EventGadget getGadget()
A gadget that extends this event.


setGadget

public Event setGadget(EventGadget gadget)
A gadget that extends this event.


getDescription

public String getDescription()
Description of the event. Optional.


setDescription

public Event setDescription(String description)
Description of the event. Optional.


getICalUID

public String getICalUID()
Event ID in the iCalendar format.


setICalUID

public Event setICalUID(String iCalUID)
Event ID in the iCalendar format.


getExtendedProperties

public EventExtendedProperties getExtendedProperties()
Extended properties of the event.


setExtendedProperties

public Event setExtendedProperties(EventExtendedProperties extendedProperties)
Extended properties of the event.


getSequence

public Integer getSequence()
Sequence number as per iCalendar.


setSequence

public Event setSequence(Integer sequence)
Sequence number as per iCalendar.


getVisibility

public String getVisibility()
Visibility of the event. Optional. Possible values are: - "default" - Uses the default visibility for events on the calendar. This is the default value. - "public" - The event is public and event details are visible to all readers of the calendar. - "private" - The event is private and only event attendees may view event details. - "confidential" - The event is private. This value is provided for compatibility reasons.


setVisibility

public Event setVisibility(String visibility)
Visibility of the event. Optional. Possible values are: - "default" - Uses the default visibility for events on the calendar. This is the default value. - "public" - The event is public and event details are visible to all readers of the calendar. - "private" - The event is private and only event attendees may view event details. - "confidential" - The event is private. This value is provided for compatibility reasons.


getGuestsCanModify

public Boolean getGuestsCanModify()
Whether attendees other than the organizer can modify the event. Optional. The default is False.


setGuestsCanModify

public Event setGuestsCanModify(Boolean guestsCanModify)
Whether attendees other than the organizer can modify the event. Optional. The default is False.


getEnd

public EventDateTime getEnd()
The end time of the event. For a recurring event, this is the end time of the first instance.


setEnd

public Event setEnd(EventDateTime end)
The end time of the event. For a recurring event, this is the end time of the first instance.


getAttendeesOmitted

public Boolean getAttendeesOmitted()
Whether attendees have been omitted from the event's representation. When retrieving an event, this is due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.


setAttendeesOmitted

public Event setAttendeesOmitted(Boolean attendeesOmitted)
Whether attendees have been omitted from the event's representation. When retrieving an event, this is due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.


getKind

public String getKind()
Type of the resource ("calendar#event").


setKind

public Event setKind(String kind)
Type of the resource ("calendar#event").


getCreated

public com.google.api.client.util.DateTime getCreated()
Creation time of the event (as a RFC 3339 timestamp). Read-only.


setCreated

public Event setCreated(com.google.api.client.util.DateTime created)
Creation time of the event (as a RFC 3339 timestamp). Read-only.


getColorId

public String getColorId()
The color of the event. This is an ID referring to an entry in the "event" section of the colors definition (see the "colors" endpoint). Optional.


setColorId

public Event setColorId(String colorId)
The color of the event. This is an ID referring to an entry in the "event" section of the colors definition (see the "colors" endpoint). Optional.


getAnyoneCanAddSelf

public Boolean getAnyoneCanAddSelf()
Whether anyone can invite themselves to the event. Optional. The default is False.


setAnyoneCanAddSelf

public Event setAnyoneCanAddSelf(Boolean anyoneCanAddSelf)
Whether anyone can invite themselves to the event. Optional. The default is False.


getReminders

public EventReminders getReminders()
Information about the event's reminders for the authenticated user.


setReminders

public Event setReminders(EventReminders reminders)
Information about the event's reminders for the authenticated user.


getGuestsCanSeeOtherGuests

public Boolean getGuestsCanSeeOtherGuests()
Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is False.


setGuestsCanSeeOtherGuests

public Event setGuestsCanSeeOtherGuests(Boolean guestsCanSeeOtherGuests)
Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is False.


getSummary

public String getSummary()
Title of the event.


setSummary

public Event setSummary(String summary)
Title of the event.


getGuestsCanInviteOthers

public Boolean getGuestsCanInviteOthers()
Whether attendees other than the organizer can invite others to the event. Optional. The default is False.


setGuestsCanInviteOthers

public Event setGuestsCanInviteOthers(Boolean guestsCanInviteOthers)
Whether attendees other than the organizer can invite others to the event. Optional. The default is False.


getTransparency

public String getTransparency()
Whether the event blocks time on the calendar. Optional. Possible values are: - "opaque" - The event blocks time on the calendar. This is the default value. - "transparent" - The event does not block time on the calendar.


setTransparency

public Event setTransparency(String transparency)
Whether the event blocks time on the calendar. Optional. Possible values are: - "opaque" - The event blocks time on the calendar. This is the default value. - "transparent" - The event does not block time on the calendar.


getPrivateCopy

public Boolean getPrivateCopy()
Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.


setPrivateCopy

public Event setPrivateCopy(Boolean privateCopy)
Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.


setResponseHeaders

public void setResponseHeaders(com.google.api.client.http.HttpHeaders responseHeaders)
Sets the HTTP headers returned with the server response, or null. This member should only be non-null if this object was the top level element of a response. For example, a request that returns a single Event would include the response headers, while a request which returns an array of Event, would have a non-null response header in the enclosing object only.


getResponseHeaders

public com.google.api.client.http.HttpHeaders getResponseHeaders()
Returns the HTTP headers that were returned with the server response, or null.



Copyright © 2011 Google. All Rights Reserved.