Event (spring-social-google 1.1.3 API)

java.lang.Object
- org.springframework.social.google.api.ApiEntity
- - org.springframework.social.google.api.calendar.Event

```
public class Event
extends ApiEntity
```
Model class representing an event within Google Calendar.
See the reference documentation at https://developers.google.com/google-apps/calendar/v3/reference/events#resource.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Event.Attendee` Details of an attendee of an event.
`static class`	`Event.Creator` Information about the creator of an event.
`static class`	`Event.DateTimeTimezone` Details of the start or end of an event.
`static class`	`Event.ExtendedProperties` Extended properties of an event.
`static class`	`Event.Gadget` A gadget that extends an event.
`static class`	`Event.Organizer` Information about an event's organizer.
`static class`	`Event.ReminderOverride` Details of the overrides to reminders.
`static class`	`Event.Reminders` Information about the event's reminders for the authenticated user.
`static class`	`Event.Source` Source from which an event was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol.

Constructor Summary

Constructors
Modifier Constructor and Description

protected Event()
Constructor protected so instances must be retrieved from Google Calendar itself.

Constructors
Modifier	Constructor and Description
`protected`	`Event()` Constructor protected so instances must be retrieved from Google Calendar itself.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.List<Event.Attendee>`	`getAttendees()` The attendees of this event.
`java.lang.String`	`getColorId()` The colour of this event.
`java.util.Date`	`getCreated()` The creation time of this event.
`Event.Creator`	`getCreator()` The creator of this event.
`java.lang.String`	`getDescription()` The description of this event.
`Event.DateTimeTimezone`	`getEnd()` The (exclusive) end time of this event.
`Event.ExtendedProperties`	`getExtendedProperties()` The extended properties of this event.
`Event.Gadget`	`getGadget()` A gadget that extends this event.
`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()` This event's ID in the iCalendar format.
`java.lang.String`	`getLocation()` The geographic location of this event as free-form text.
`Event.Organizer`	`getOrganizer()` The organizer of this event.
`Event.DateTimeTimezone`	`getOriginalStartTime()` For an instance of a recurring event, return the time at which this event would start according to the recurrence data in the recurring event identified by `recurringEventId`.
`java.util.List<java.lang.String>`	`getRecurrence()` A list of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event.
`java.lang.String`	`getRecurringEventId()` For an instance of a recurring event, return this event ID of the recurring event itself.
`Event.Reminders`	`getReminders()` Information about this event's reminders for the authenticated user.
`java.lang.Integer`	`getSequence()` The sequence number as per iCalendar.
`Event.Source`	`getSource()` The source of an event from which this event was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol.
`Event.DateTimeTimezone`	`getStart()` The (inclusive) start time of this event.
`EventStatus`	`getStatus()` The status of this event.
`java.lang.String`	`getSummary()` The title of this event.
`Transparency`	`getTransparency()` Whether this event blocks time on the calendar.
`java.util.Date`	`getUpdated()` The last modification time of this event.
`Visibility`	`getVisibility()` The visibility of this event.
`java.lang.Boolean`	`isAnyoneCanAddSelf()` Whether anyone can invite themselves to this event.
`java.lang.Boolean`	`isAttendeesOmitted()` Whether attendees may have been omitted from this event's representation.
`java.lang.Boolean`	`isEndTimeUnspecified()` Whether the end time is actually unspecified.
`java.lang.Boolean`	`isGuestsCanInviteOthers()` Whether attendees other than the organizer can invite others to this event.
`java.lang.Boolean`	`isGuestsCanModify()` Whether attendees other than the organizer can modify this event.
`java.lang.Boolean`	`isGuestsCanSeeOtherGuests()` Whether attendees other than the organizer can see who this event's attendees are.
`java.lang.Boolean`	`isLocked()` 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".
`java.lang.Boolean`	`isPrivateCopy()` Whether this is a private event copy where changes are not shared with other copies on other calendars.
`Event`	`setGuestsCanInviteOthers(java.lang.Boolean guestsCanInviteOthers)` Sets whether attendees other than the organizer can invite others to the event.
`Event`	`setGuestsCanSeeOtherGuests(java.lang.Boolean guestsCanSeeOtherGuests)` Sets whether attendees other than the organizer can see who the event's attendees are.
`Event`	`setLocation(java.lang.String location)` Sets the location of this event.
`Event`	`setRecurrence(java.util.List<java.lang.String> list)` Replaces the list of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event.
`Event`	`setStatus(EventStatus status)` Sets the status of this event.
`Event`	`setSummary(java.lang.String summary)` Sets the title of this event.

Methods inherited from class org.springframework.social.google.api.ApiEntity
getEtag, getId

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Event
```
protected Event()
```
    Constructor protected so instances must be retrieved from Google Calendar itself. Only some of the possible modifications are currently implemented.
- Method Detail
  - getStatus
```
public EventStatus getStatus()
```
    The status of this event.
    
    Returns:
    
    the value or null if none.
  - setStatus
```
public Event setStatus(EventStatus status)
```
    Sets the status of this event.
    
    Parameters:
    
    status - the new status, or null for none.
    
    Returns:
    
    this event, for chaining.
  - getHtmlLink
```
public java.lang.String getHtmlLink()
```
    An absolute link to this event in the Google Calendar Web UI.
    
    Returns:
    
    the value or null if none.
  - getCreated
```
public java.util.Date getCreated()
```
    The creation time of this event.
    
    Returns:
    
    the value or null if none.
  - getUpdated
```
public java.util.Date getUpdated()
```
    The last modification time of this event.
    
    Returns:
    
    the value or null if none.
  - getSummary
```
public java.lang.String getSummary()
```
    The title of this event.
    
    Returns:
    
    the value or null if none.
  - setSummary
```
public Event setSummary(java.lang.String summary)
```
    Sets the title of this event.
    
    Parameters:
    
    summary - the new title.
    
    Returns:
    
    this event, to allow chaining.
  - getDescription
```
public java.lang.String getDescription()
```
    The description of this event.
    
    Returns:
    
    the value or null if none.
  - getLocation
```
public java.lang.String getLocation()
```
    The geographic location of this event as free-form text.
    
    Returns:
    
    the value or null if none.
  - setLocation
```
public Event setLocation(java.lang.String location)
```
    Sets the location of this event.
    
    Parameters:
    
    location - the new location, or null for none.
    
    Returns:
    
    this event, to allow chaining.
  - getColorId
```
public java.lang.String getColorId()
```
    The colour of this event.
    
    Returns:
    
    the value or null if none.
  - getCreator
```
public Event.Creator getCreator()
```
    The creator of this event.
    
    Returns:
    
    the value or null if none.
  - getOrganizer
```
public Event.Organizer getOrganizer()
```
    The organizer of this event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True.
    
    Returns:
    
    the value or null if none.
  - getStart
```
public Event.DateTimeTimezone getStart()
```
    The (inclusive) start time of this event. For a recurring event, this is the start time of the first instance.
    
    Returns:
    
    the value or null if none.
  - getEnd
```
public Event.DateTimeTimezone getEnd()
```
    The (exclusive) end time of this event. For a recurring event, this is the end time of the first instance.
    
    Returns:
    
    the value or null if none.
  - isEndTimeUnspecified
```
public java.lang.Boolean isEndTimeUnspecified()
```
    Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to true. If true, the end time should be disregarded.
    
    Returns:
    
    the value or null if none.
  - getRecurringEventId
```
public java.lang.String getRecurringEventId()
```
    For an instance of a recurring event, return this event ID of the recurring event itself.
    
    Returns:
    
    the value or null if none.
  - getOriginalStartTime
```
public Event.DateTimeTimezone getOriginalStartTime()
```
    For an instance of a recurring event, return the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId.
    
    Returns:
    
    the value or null if none.
  - getTransparency
```
public Transparency getTransparency()
```
    Whether this event blocks time on the calendar.
    
    Returns:
    
    the value or null if none.
  - getVisibility
```
public Visibility getVisibility()
```
    The visibility of this event.
    
    Returns:
    
    the value or null if none.
  - getiCalUid
```
public java.lang.String getiCalUid()
```
    This event's ID in the iCalendar format.
    
    Returns:
    
    the value or null if none.
  - getSequence
```
public java.lang.Integer getSequence()
```
    The sequence number as per iCalendar.
    
    Returns:
    
    the value or null if none.
  - isAttendeesOmitted
```
public java.lang.Boolean isAttendeesOmitted()
```
    Whether attendees may have been omitted from this event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter.
    
    Returns:
    
    the value or null if none.
  - getHangoutLink
```
public java.lang.String getHangoutLink()
```
    An absolute link to the Google+ hangout associated with this event.
    
    Returns:
    
    the value or null if none.
  - isAnyoneCanAddSelf
```
public java.lang.Boolean isAnyoneCanAddSelf()
```
    Whether anyone can invite themselves to this event.
    
    Returns:
    
    the value or null if none.
  - isGuestsCanInviteOthers
```
public java.lang.Boolean isGuestsCanInviteOthers()
```
    Whether attendees other than the organizer can invite others to this event.
    
    Returns:
    
    the value or null if none.
  - isGuestsCanModify
```
public java.lang.Boolean isGuestsCanModify()
```
    Whether attendees other than the organizer can modify this event.
    
    Returns:
    
    the value or null if none.
  - isGuestsCanSeeOtherGuests
```
public java.lang.Boolean isGuestsCanSeeOtherGuests()
```
    Whether attendees other than the organizer can see who this event's attendees are.
    
    Returns:
    
    the value or null if none.
  - isPrivateCopy
```
public java.lang.Boolean isPrivateCopy()
```
    Whether this is a private event copy where changes are not shared with other copies on other calendars.
    
    Returns:
    
    the value or null if none.
  - isLocked
```
public java.lang.Boolean isLocked()
```
    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".
    
    Returns:
    
    the value or null if none.
  - getRecurrence
```
public java.util.List<java.lang.String> getRecurrence()
```
    A list of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
    
    Returns:
    
    the value or null if none.
  - setRecurrence
```
public Event setRecurrence(java.util.List<java.lang.String> list)
```
    Replaces the list of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event.
    
    Parameters:
    
    list - the new list, or null for none.
    
    Returns:
    
    this event, to allow chaining.
  - getAttendees
```
public java.util.List<Event.Attendee> getAttendees()
```
    The attendees of this event.
    
    Returns:
    
    the value or null if none.
  - getExtendedProperties
```
public Event.ExtendedProperties getExtendedProperties()
```
    The extended properties of this event.
    
    Returns:
    
    the value or null if none.
  - getGadget
```
public Event.Gadget getGadget()
```
    A gadget that extends this event.
    
    Returns:
    
    the value or null if none.
  - getReminders
```
public Event.Reminders getReminders()
```
    Information about this event's reminders for the authenticated user.
    
    Returns:
    
    the value or null if none.
  - getSource
```
public Event.Source getSource()
```
    The source of an event from which this event was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of this event.
    
    Returns:
    
    the value or null if none.
  - setGuestsCanInviteOthers
```
public Event setGuestsCanInviteOthers(java.lang.Boolean guestsCanInviteOthers)
```
    Sets whether attendees other than the organizer can invite others to the event.
    
    Parameters:
    
    guestsCanInviteOthers - the new value.
    
    Returns:
    
    this event, to allow chaining.
  - setGuestsCanSeeOtherGuests
```
public Event setGuestsCanSeeOtherGuests(java.lang.Boolean guestsCanSeeOtherGuests)
```
    Sets whether attendees other than the organizer can see who the event's attendees are.
    
    Parameters:
    
    guestsCanSeeOtherGuests - the new value.
    
    Returns:
    
    this event, to allow chaining.

Class Event

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class org.springframework.social.google.api.ApiEntity

Methods inherited from class java.lang.Object

Constructor Detail

Event

Method Detail

getStatus

setStatus

getHtmlLink

getCreated

getUpdated

getSummary

setSummary

getDescription

getLocation

setLocation

getColorId

getCreator

getOrganizer

getStart

getEnd

isEndTimeUnspecified

getRecurringEventId

getOriginalStartTime

getTransparency

getVisibility

getiCalUid

getSequence

isAttendeesOmitted

getHangoutLink

isAnyoneCanAddSelf

isGuestsCanInviteOthers

isGuestsCanModify

isGuestsCanSeeOtherGuests

isPrivateCopy

isLocked

getRecurrence

setRecurrence

getAttendees

getExtendedProperties

getGadget

getReminders

getSource

setGuestsCanInviteOthers

setGuestsCanSeeOtherGuests