Calendar API v3 (revision 30)



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

java.lang.Object
  extended by java.util.AbstractMap<java.lang.String,java.lang.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:
java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public final class Event
extends GenericJson

Model definition for Event.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Calendar API. For a detailed explanation see: http://code.google.com/p/google-api-java-client/wiki/Json

Upgrade warning: starting with version 1.12 getResponseHeaders() is removed, instead use JsonHttpRequest.getLastResponseHeaders()

Author:
Google, Inc.

Nested Class Summary
static class Event.Creator
          The creator of the event.
static class Event.ExtendedProperties
          Extended properties of the event.
static class Event.Gadget
          A gadget that extends this event.
static class Event.Organizer
          The organizer of the event.
static class Event.Reminders
          Information about the event's reminders for the authenticated user.
 
Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
GenericData.Flags
 
Nested classes/interfaces inherited from class java.util.AbstractMap
java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
 
Nested classes/interfaces inherited from interface java.util.Map
java.util.Map.Entry<K,V>
 
Constructor Summary
Event()
           
 
Method Summary
 java.lang.Boolean getAnyoneCanAddSelf()
          Whether anyone can invite themselves to the event.
 java.util.List<EventAttendee> getAttendees()
          The attendees of the event.
 java.lang.Boolean getAttendeesOmitted()
          Whether attendees may have been omitted from the event's representation.
 java.lang.String getColorId()
          The color of the event.
 DateTime getCreated()
          Creation time of the event (as a RFC 3339 timestamp).
 Event.Creator getCreator()
          The creator of the event.
 java.lang.String getDescription()
          Description of the event.
 EventDateTime getEnd()
          The (exclusive) end time of the event.
 java.lang.Boolean getEndTimeUnspecified()
          Whether the end time is actually unspecified.
 java.lang.String getEtag()
          ETag of the resource.
 Event.ExtendedProperties getExtendedProperties()
          Extended properties of the event.
 Event.Gadget getGadget()
          A gadget that extends this event.
 java.lang.Boolean getGuestsCanInviteOthers()
          Whether attendees other than the organizer can invite others to the event.
 java.lang.Boolean getGuestsCanModify()
          Whether attendees other than the organizer can modify the event.
 java.lang.Boolean getGuestsCanSeeOtherGuests()
          Whether attendees other than the organizer can see who the event's attendees are.
 java.lang.String getHangoutLink()
          An absolute link to the Google+ hangout associated with this event.
 java.lang.String getHtmlLink()
          An absolute link to this event in the Google Calendar Web UI.
 java.lang.String getICalUID()
          Event ID in the iCalendar format.
 java.lang.String getId()
          Identifier of the event.
 java.lang.String getKind()
          Type of the resource ("calendar#event").
 java.lang.String getLocation()
          Geographic location of the event as free-form text.
 java.lang.Boolean getLocked()
          Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence".
 Event.Organizer 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.
 java.lang.Boolean getPrivateCopy()
          Whether this is a private event copy where changes are not shared with other copies on other calendars.
 java.util.List<java.lang.String> getRecurrence()
          List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event.
 java.lang.String getRecurringEventId()
          For an instance of a recurring event, this is the event ID of the recurring event itself.
 Event.Reminders getReminders()
          Information about the event's reminders for the authenticated user.
 java.lang.Integer getSequence()
          Sequence number as per iCalendar.
 EventDateTime getStart()
          The (inclusive) start time of the event.
 java.lang.String getStatus()
          Status of the event.
 java.lang.String getSummary()
          Title of the event.
 java.lang.String getTransparency()
          Whether the event blocks time on the calendar.
 DateTime getUpdated()
          Last modification time of the event (as a RFC 3339 timestamp).
 java.lang.String getVisibility()
          Visibility of the event.
 Event setAnyoneCanAddSelf(java.lang.Boolean anyoneCanAddSelf)
          Whether anyone can invite themselves to the event.
 Event setAttendees(java.util.List<EventAttendee> attendees)
          The attendees of the event.
 Event setAttendeesOmitted(java.lang.Boolean attendeesOmitted)
          Whether attendees may have been omitted from the event's representation.
 Event setColorId(java.lang.String colorId)
          The color of the event.
 Event setCreated(DateTime created)
          Creation time of the event (as a RFC 3339 timestamp).
 Event setCreator(Event.Creator creator)
          The creator of the event.
 Event setDescription(java.lang.String description)
          Description of the event.
 Event setEnd(EventDateTime end)
          The (exclusive) end time of the event.
 Event setEndTimeUnspecified(java.lang.Boolean endTimeUnspecified)
          Whether the end time is actually unspecified.
 Event setEtag(java.lang.String etag)
          ETag of the resource.
 Event setExtendedProperties(Event.ExtendedProperties extendedProperties)
          Extended properties of the event.
 Event setGadget(Event.Gadget gadget)
          A gadget that extends this event.
 Event setGuestsCanInviteOthers(java.lang.Boolean guestsCanInviteOthers)
          Whether attendees other than the organizer can invite others to the event.
 Event setGuestsCanModify(java.lang.Boolean guestsCanModify)
          Whether attendees other than the organizer can modify the event.
 Event setGuestsCanSeeOtherGuests(java.lang.Boolean guestsCanSeeOtherGuests)
          Whether attendees other than the organizer can see who the event's attendees are.
 Event setHangoutLink(java.lang.String hangoutLink)
          An absolute link to the Google+ hangout associated with this event.
 Event setHtmlLink(java.lang.String htmlLink)
          An absolute link to this event in the Google Calendar Web UI.
 Event setICalUID(java.lang.String iCalUID)
          Event ID in the iCalendar format.
 Event setId(java.lang.String id)
          Identifier of the event.
 Event setKind(java.lang.String kind)
          Type of the resource ("calendar#event").
 Event setLocation(java.lang.String location)
          Geographic location of the event as free-form text.
 Event setLocked(java.lang.Boolean locked)
          Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence".
 Event setOrganizer(Event.Organizer 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(java.lang.Boolean privateCopy)
          Whether this is a private event copy where changes are not shared with other copies on other calendars.
 Event setRecurrence(java.util.List<java.lang.String> recurrence)
          List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event.
 Event setRecurringEventId(java.lang.String recurringEventId)
          For an instance of a recurring event, this is the event ID of the recurring event itself.
 Event setReminders(Event.Reminders reminders)
          Information about the event's reminders for the authenticated user.
 Event setSequence(java.lang.Integer sequence)
          Sequence number as per iCalendar.
 Event setStart(EventDateTime start)
          The (inclusive) start time of the event.
 Event setStatus(java.lang.String status)
          Status of the event.
 Event setSummary(java.lang.String summary)
          Title of the event.
 Event setTransparency(java.lang.String transparency)
          Whether the event blocks time on the calendar.
 Event setUpdated(DateTime updated)
          Last modification time of the event (as a RFC 3339 timestamp).
 Event setVisibility(java.lang.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, getClassInfo, 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

getAnyoneCanAddSelf

public java.lang.Boolean getAnyoneCanAddSelf()
Whether anyone can invite themselves to the event. Optional. The default is False. The value returned may be null.


setAnyoneCanAddSelf

public Event setAnyoneCanAddSelf(java.lang.Boolean anyoneCanAddSelf)
Whether anyone can invite themselves to the event. Optional. The default is False. The value set may be null.


getAttendees

public java.util.List<EventAttendee> getAttendees()
The attendees of the event. The value returned may be null.


setAttendees

public Event setAttendees(java.util.List<EventAttendee> attendees)
The attendees of the event. The value set may be null.


getAttendeesOmitted

public java.lang.Boolean getAttendeesOmitted()
Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be 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. The value returned may be null.


setAttendeesOmitted

public Event setAttendeesOmitted(java.lang.Boolean attendeesOmitted)
Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be 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. The value set may be null.


getColorId

public java.lang.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. The value returned may be null.


setColorId

public Event setColorId(java.lang.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. The value set may be null.


getCreated

public DateTime getCreated()
Creation time of the event (as a RFC 3339 timestamp). Read-only. The value returned may be null.


setCreated

public Event setCreated(DateTime created)
Creation time of the event (as a RFC 3339 timestamp). Read-only. The value set may be null.


getCreator

public Event.Creator getCreator()
The creator of the event. Read-only. The value returned may be null.


setCreator

public Event setCreator(Event.Creator creator)
The creator of the event. Read-only. The value set may be null.


getDescription

public java.lang.String getDescription()
Description of the event. Optional. The value returned may be null.


setDescription

public Event setDescription(java.lang.String description)
Description of the event. Optional. The value set may be null.


getEnd

public EventDateTime getEnd()
The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. The value returned may be null.


setEnd

public Event setEnd(EventDateTime end)
The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. The value set may be null.


getEndTimeUnspecified

public java.lang.Boolean getEndTimeUnspecified()
Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False. The value returned may be null.


setEndTimeUnspecified

public Event setEndTimeUnspecified(java.lang.Boolean endTimeUnspecified)
Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False. The value set may be null.


getEtag

public java.lang.String getEtag()
ETag of the resource. The value returned may be null.


setEtag

public Event setEtag(java.lang.String etag)
ETag of the resource. The value set may be null.


getExtendedProperties

public Event.ExtendedProperties getExtendedProperties()
Extended properties of the event. The value returned may be null.


setExtendedProperties

public Event setExtendedProperties(Event.ExtendedProperties extendedProperties)
Extended properties of the event. The value set may be null.


getGadget

public Event.Gadget getGadget()
A gadget that extends this event. The value returned may be null.


setGadget

public Event setGadget(Event.Gadget gadget)
A gadget that extends this event. The value set may be null.


getGuestsCanInviteOthers

public java.lang.Boolean getGuestsCanInviteOthers()
Whether attendees other than the organizer can invite others to the event. Optional. The default is True. The value returned may be null.


setGuestsCanInviteOthers

public Event setGuestsCanInviteOthers(java.lang.Boolean guestsCanInviteOthers)
Whether attendees other than the organizer can invite others to the event. Optional. The default is True. The value set may be null.


getGuestsCanModify

public java.lang.Boolean getGuestsCanModify()
Whether attendees other than the organizer can modify the event. Optional. The default is False. The value returned may be null.


setGuestsCanModify

public Event setGuestsCanModify(java.lang.Boolean guestsCanModify)
Whether attendees other than the organizer can modify the event. Optional. The default is False. The value set may be null.


getGuestsCanSeeOtherGuests

public java.lang.Boolean getGuestsCanSeeOtherGuests()
Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. The value returned may be null.


setGuestsCanSeeOtherGuests

public Event setGuestsCanSeeOtherGuests(java.lang.Boolean guestsCanSeeOtherGuests)
Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. The value set may be null.


getHangoutLink

public java.lang.String getHangoutLink()
An absolute link to the Google+ hangout associated with this event. Read-only. The value returned may be null.


setHangoutLink

public Event setHangoutLink(java.lang.String hangoutLink)
An absolute link to the Google+ hangout associated with this event. Read-only. The value set may be null.


getHtmlLink

public java.lang.String getHtmlLink()
An absolute link to this event in the Google Calendar Web UI. Read-only. The value returned may be null.


setHtmlLink

public Event setHtmlLink(java.lang.String htmlLink)
An absolute link to this event in the Google Calendar Web UI. Read-only. The value set may be null.


getICalUID

public java.lang.String getICalUID()
Event ID in the iCalendar format. The value returned may be null.


setICalUID

public Event setICalUID(java.lang.String iCalUID)
Event ID in the iCalendar format. The value set may be null.


getId

public java.lang.String getId()
Identifier of the event. The value returned may be null.


setId

public Event setId(java.lang.String id)
Identifier of the event. The value set may be null.


getKind

public java.lang.String getKind()
Type of the resource ("calendar#event"). The value returned may be null.


setKind

public Event setKind(java.lang.String kind)
Type of the resource ("calendar#event"). The value set may be null.


getLocation

public java.lang.String getLocation()
Geographic location of the event as free-form text. Optional. The value returned may be null.


setLocation

public Event setLocation(java.lang.String location)
Geographic location of the event as free-form text. Optional. The value set may be null.


getLocked

public java.lang.Boolean getLocked()
Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only. The value returned may be null.


setLocked

public Event setLocked(java.lang.Boolean locked)
Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only. The value set may be null.


getOrganizer

public Event.Organizer 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. To change the organizer, use the "move" operation. Read-only, except when importing an event. The value returned may be null.


setOrganizer

public Event setOrganizer(Event.Organizer 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. To change the organizer, use the "move" operation. Read-only, except when importing an event. The value set may be null.


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. The value returned may be null.


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. The value set may be null.


getPrivateCopy

public java.lang.Boolean getPrivateCopy()
Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The value returned may be null.


setPrivateCopy

public Event setPrivateCopy(java.lang.Boolean privateCopy)
Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The value set may be null.


getRecurrence

public java.util.List<java.lang.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. The value returned may be null.


setRecurrence

public Event setRecurrence(java.util.List<java.lang.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. The value set may be null.


getRecurringEventId

public java.lang.String getRecurringEventId()
For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable. The value returned may be null.


setRecurringEventId

public Event setRecurringEventId(java.lang.String recurringEventId)
For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable. The value set may be null.


getReminders

public Event.Reminders getReminders()
Information about the event's reminders for the authenticated user. The value returned may be null.


setReminders

public Event setReminders(Event.Reminders reminders)
Information about the event's reminders for the authenticated user. The value set may be null.


getSequence

public java.lang.Integer getSequence()
Sequence number as per iCalendar. The value returned may be null.


setSequence

public Event setSequence(java.lang.Integer sequence)
Sequence number as per iCalendar. The value set may be null.


getStart

public EventDateTime getStart()
The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. The value returned may be null.


setStart

public Event setStart(EventDateTime start)
The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. The value set may be null.


getStatus

public java.lang.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. The value returned may be null.


setStatus

public Event setStatus(java.lang.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. The value set may be null.


getSummary

public java.lang.String getSummary()
Title of the event. The value returned may be null.


setSummary

public Event setSummary(java.lang.String summary)
Title of the event. The value set may be null.


getTransparency

public java.lang.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. The value returned may be null.


setTransparency

public Event setTransparency(java.lang.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. The value set may be null.


getUpdated

public DateTime getUpdated()
Last modification time of the event (as a RFC 3339 timestamp). Read-only. The value returned may be null.


setUpdated

public Event setUpdated(DateTime updated)
Last modification time of the event (as a RFC 3339 timestamp). Read-only. The value set may be null.


getVisibility

public java.lang.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. The value returned may be null.


setVisibility

public Event setVisibility(java.lang.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. The value set may be null.