public final class Event extends GenericJson
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-http-java-client/wiki/JSON
Modifier and Type | Class and Description |
---|---|
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.
|
static class |
Event.Source
Source of an event from which it was created; for example a web page, an email message or any
document identifiable by an URL using HTTP/HTTPS protocol.
|
GenericData.Flags
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
Constructor and Description |
---|
Event() |
Modifier and Type | Method and Description |
---|---|
Event |
clone() |
Boolean |
getAnyoneCanAddSelf()
Whether anyone can invite themselves to the event.
|
List<EventAttendee> |
getAttendees()
The attendees of the event.
|
Boolean |
getAttendeesOmitted()
Whether attendees may have been omitted from the event's representation.
|
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.
|
String |
getDescription()
Description of the event.
|
EventDateTime |
getEnd()
The (exclusive) end time of the event.
|
Boolean |
getEndTimeUnspecified()
Whether the end time is actually unspecified.
|
String |
getEtag()
ETag of the resource.
|
Event.ExtendedProperties |
getExtendedProperties()
Extended properties of the event.
|
Event.Gadget |
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 |
getHangoutLink()
An absolute link to the Google+ hangout associated with this event.
|
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.
|
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.
|
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.
|
Event.Reminders |
getReminders()
Information about the event's reminders for the authenticated user.
|
Integer |
getSequence()
Sequence number as per iCalendar.
|
Event.Source |
getSource()
Source of an event from which it was created; for example a web page, an email message or any
document identifiable by an URL using HTTP/HTTPS protocol.
|
EventDateTime |
getStart()
The (inclusive) 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.
|
DateTime |
getUpdated()
Last modification time of the event (as a RFC 3339 timestamp).
|
String |
getVisibility()
Visibility of the event.
|
boolean |
isAnyoneCanAddSelf()
Convenience method that returns only
Boolean.TRUE or Boolean.FALSE . |
boolean |
isAttendeesOmitted()
Convenience method that returns only
Boolean.TRUE or Boolean.FALSE . |
boolean |
isEndTimeUnspecified()
Convenience method that returns only
Boolean.TRUE or Boolean.FALSE . |
boolean |
isGuestsCanInviteOthers()
Convenience method that returns only
Boolean.TRUE or Boolean.FALSE . |
boolean |
isGuestsCanModify()
Convenience method that returns only
Boolean.TRUE or Boolean.FALSE . |
boolean |
isGuestsCanSeeOtherGuests()
Convenience method that returns only
Boolean.TRUE or Boolean.FALSE . |
boolean |
isLocked()
Convenience method that returns only
Boolean.TRUE or Boolean.FALSE . |
boolean |
isPrivateCopy()
Convenience method that returns only
Boolean.TRUE or Boolean.FALSE . |
Event |
set(String fieldName,
Object value) |
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 may have been omitted from the event's representation.
|
Event |
setColorId(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(String description)
Description of the event.
|
Event |
setEnd(EventDateTime end)
The (exclusive) end time of the event.
|
Event |
setEndTimeUnspecified(Boolean endTimeUnspecified)
Whether the end time is actually unspecified.
|
Event |
setEtag(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(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 |
setHangoutLink(String hangoutLink)
An absolute link to the Google+ hangout associated with this event.
|
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 |
setLocked(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(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(Event.Reminders reminders)
Information about the event's reminders for the authenticated user.
|
Event |
setSequence(Integer sequence)
Sequence number as per iCalendar.
|
Event |
setSource(Event.Source source)
Source of an event from which it was created; for example a web page, an email message or any
document identifiable by an URL using HTTP/HTTPS protocol.
|
Event |
setStart(EventDateTime start)
The (inclusive) 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(DateTime updated)
Last modification time of the event (as a RFC 3339 timestamp).
|
Event |
setVisibility(String visibility)
Visibility of the event.
|
getFactory, setFactory, toPrettyString, toString
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values
public Boolean getAnyoneCanAddSelf()
null
for nonepublic Event setAnyoneCanAddSelf(Boolean anyoneCanAddSelf)
anyoneCanAddSelf
- anyoneCanAddSelf or null
for nonepublic boolean isAnyoneCanAddSelf()
Boolean.TRUE
or Boolean.FALSE
.
Boolean properties can have four possible values:
null
, Data.NULL_BOOLEAN
, Boolean.TRUE
or Boolean.FALSE
.
This method returns Boolean.TRUE
if the default of the property is Boolean.TRUE
and it is null
or Data.NULL_BOOLEAN
.
Boolean.FALSE
is returned if the default of the property is Boolean.FALSE
and
it is null
or Data.NULL_BOOLEAN
.
Whether anyone can invite themselves to the event. Optional. The default is False.
public List<EventAttendee> getAttendees()
null
for nonepublic Event setAttendees(List<EventAttendee> attendees)
attendees
- attendees or null
for nonepublic Boolean getAttendeesOmitted()
null
for nonepublic Event setAttendeesOmitted(Boolean attendeesOmitted)
attendeesOmitted
- attendeesOmitted or null
for nonepublic boolean isAttendeesOmitted()
Boolean.TRUE
or Boolean.FALSE
.
Boolean properties can have four possible values:
null
, Data.NULL_BOOLEAN
, Boolean.TRUE
or Boolean.FALSE
.
This method returns Boolean.TRUE
if the default of the property is Boolean.TRUE
and it is null
or Data.NULL_BOOLEAN
.
Boolean.FALSE
is returned if the default of the property is Boolean.FALSE
and
it is null
or Data.NULL_BOOLEAN
.
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.
public String getColorId()
null
for nonepublic Event setColorId(String colorId)
colorId
- colorId or null
for nonepublic DateTime getCreated()
null
for nonepublic Event setCreated(DateTime created)
created
- created or null
for nonepublic Event.Creator getCreator()
null
for nonepublic Event setCreator(Event.Creator creator)
creator
- creator or null
for nonepublic String getDescription()
null
for nonepublic Event setDescription(String description)
description
- description or null
for nonepublic EventDateTime getEnd()
null
for nonepublic Event setEnd(EventDateTime end)
end
- end or null
for nonepublic Boolean getEndTimeUnspecified()
null
for nonepublic Event setEndTimeUnspecified(Boolean endTimeUnspecified)
endTimeUnspecified
- endTimeUnspecified or null
for nonepublic boolean isEndTimeUnspecified()
Boolean.TRUE
or Boolean.FALSE
.
Boolean properties can have four possible values:
null
, Data.NULL_BOOLEAN
, Boolean.TRUE
or Boolean.FALSE
.
This method returns Boolean.TRUE
if the default of the property is Boolean.TRUE
and it is null
or Data.NULL_BOOLEAN
.
Boolean.FALSE
is returned if the default of the property is Boolean.FALSE
and
it is null
or Data.NULL_BOOLEAN
.
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.
public String getEtag()
null
for nonepublic Event setEtag(String etag)
etag
- etag or null
for nonepublic Event.ExtendedProperties getExtendedProperties()
null
for nonepublic Event setExtendedProperties(Event.ExtendedProperties extendedProperties)
extendedProperties
- extendedProperties or null
for nonepublic Event.Gadget getGadget()
null
for nonepublic Event setGadget(Event.Gadget gadget)
gadget
- gadget or null
for nonepublic Boolean getGuestsCanInviteOthers()
null
for nonepublic Event setGuestsCanInviteOthers(Boolean guestsCanInviteOthers)
guestsCanInviteOthers
- guestsCanInviteOthers or null
for nonepublic boolean isGuestsCanInviteOthers()
Boolean.TRUE
or Boolean.FALSE
.
Boolean properties can have four possible values:
null
, Data.NULL_BOOLEAN
, Boolean.TRUE
or Boolean.FALSE
.
This method returns Boolean.TRUE
if the default of the property is Boolean.TRUE
and it is null
or Data.NULL_BOOLEAN
.
Boolean.FALSE
is returned if the default of the property is Boolean.FALSE
and
it is null
or Data.NULL_BOOLEAN
.
Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
public Boolean getGuestsCanModify()
null
for nonepublic Event setGuestsCanModify(Boolean guestsCanModify)
guestsCanModify
- guestsCanModify or null
for nonepublic boolean isGuestsCanModify()
Boolean.TRUE
or Boolean.FALSE
.
Boolean properties can have four possible values:
null
, Data.NULL_BOOLEAN
, Boolean.TRUE
or Boolean.FALSE
.
This method returns Boolean.TRUE
if the default of the property is Boolean.TRUE
and it is null
or Data.NULL_BOOLEAN
.
Boolean.FALSE
is returned if the default of the property is Boolean.FALSE
and
it is null
or Data.NULL_BOOLEAN
.
Whether attendees other than the organizer can modify the event. Optional. The default is False.
public Boolean getGuestsCanSeeOtherGuests()
null
for nonepublic Event setGuestsCanSeeOtherGuests(Boolean guestsCanSeeOtherGuests)
guestsCanSeeOtherGuests
- guestsCanSeeOtherGuests or null
for nonepublic boolean isGuestsCanSeeOtherGuests()
Boolean.TRUE
or Boolean.FALSE
.
Boolean properties can have four possible values:
null
, Data.NULL_BOOLEAN
, Boolean.TRUE
or Boolean.FALSE
.
This method returns Boolean.TRUE
if the default of the property is Boolean.TRUE
and it is null
or Data.NULL_BOOLEAN
.
Boolean.FALSE
is returned if the default of the property is Boolean.FALSE
and
it is null
or Data.NULL_BOOLEAN
.
Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
public String getHangoutLink()
null
for nonepublic Event setHangoutLink(String hangoutLink)
hangoutLink
- hangoutLink or null
for nonepublic String getHtmlLink()
null
for nonepublic Event setHtmlLink(String htmlLink)
htmlLink
- htmlLink or null
for nonepublic String getICalUID()
null
for nonepublic Event setICalUID(String iCalUID)
iCalUID
- iCalUID or null
for nonepublic String getId()
null
for nonepublic Event setId(String id)
id
- id or null
for nonepublic String getKind()
null
for nonepublic Event setKind(String kind)
kind
- kind or null
for nonepublic String getLocation()
null
for nonepublic Event setLocation(String location)
location
- location or null
for nonepublic Boolean getLocked()
null
for nonepublic Event setLocked(Boolean locked)
locked
- locked or null
for nonepublic boolean isLocked()
Boolean.TRUE
or Boolean.FALSE
.
Boolean properties can have four possible values:
null
, Data.NULL_BOOLEAN
, Boolean.TRUE
or Boolean.FALSE
.
This method returns Boolean.TRUE
if the default of the property is Boolean.TRUE
and it is null
or Data.NULL_BOOLEAN
.
Boolean.FALSE
is returned if the default of the property is Boolean.FALSE
and
it is null
or Data.NULL_BOOLEAN
.
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.
public Event.Organizer getOrganizer()
null
for nonepublic Event setOrganizer(Event.Organizer organizer)
organizer
- organizer or null
for nonepublic EventDateTime getOriginalStartTime()
null
for nonepublic Event setOriginalStartTime(EventDateTime originalStartTime)
originalStartTime
- originalStartTime or null
for nonepublic Boolean getPrivateCopy()
null
for nonepublic Event setPrivateCopy(Boolean privateCopy)
privateCopy
- privateCopy or null
for nonepublic boolean isPrivateCopy()
Boolean.TRUE
or Boolean.FALSE
.
Boolean properties can have four possible values:
null
, Data.NULL_BOOLEAN
, Boolean.TRUE
or Boolean.FALSE
.
This method returns Boolean.TRUE
if the default of the property is Boolean.TRUE
and it is null
or Data.NULL_BOOLEAN
.
Boolean.FALSE
is returned if the default of the property is Boolean.FALSE
and
it is null
or Data.NULL_BOOLEAN
.
Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
public List<String> getRecurrence()
null
for nonepublic Event setRecurrence(List<String> recurrence)
recurrence
- recurrence or null
for nonepublic String getRecurringEventId()
null
for nonepublic Event setRecurringEventId(String recurringEventId)
recurringEventId
- recurringEventId or null
for nonepublic Event.Reminders getReminders()
null
for nonepublic Event setReminders(Event.Reminders reminders)
reminders
- reminders or null
for nonepublic Integer getSequence()
null
for nonepublic Event setSequence(Integer sequence)
sequence
- sequence or null
for nonepublic Event.Source getSource()
null
for nonepublic Event setSource(Event.Source source)
source
- source or null
for nonepublic EventDateTime getStart()
null
for nonepublic Event setStart(EventDateTime start)
start
- start or null
for nonepublic String getStatus()
null
for nonepublic Event setStatus(String status)
status
- status or null
for nonepublic String getSummary()
null
for nonepublic Event setSummary(String summary)
summary
- summary or null
for nonepublic String getTransparency()
null
for nonepublic Event setTransparency(String transparency)
transparency
- transparency or null
for nonepublic DateTime getUpdated()
null
for nonepublic Event setUpdated(DateTime updated)
updated
- updated or null
for nonepublic String getVisibility()
null
for nonepublic Event setVisibility(String visibility)
visibility
- visibility or null
for nonepublic Event set(String fieldName, Object value)
set
in class GenericJson
public Event clone()
clone
in class GenericJson