com.google.api.services.calendar.model

Class CalendarListEntry

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.calendar.model.CalendarListEntry

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Model definition for CalendarListEntry.

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: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CalendarListEntry.NotificationSettings The notifications that the authenticated user is receiving for this calendar.

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

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>

Constructor Summary

Constructors

Constructor and Description
CalendarListEntry()

Method Summary

Modifier and Type	Method and Description
CalendarListEntry	clone()
String	getAccessRole() The effective access role that the authenticated user has on the calendar.
String	getBackgroundColor() The main color of the calendar in the hexadecimal format "#0088aa".
String	getColorId() The color of the calendar.
ConferenceProperties	getConferenceProperties() Conferencing properties for this calendar, for example what types of conferences are allowed.
List<EventReminder>	getDefaultReminders() The default reminders that the authenticated user has for this calendar.
Boolean	getDeleted() Whether this calendar list entry has been deleted from the calendar list.
String	getDescription() Description of the calendar.
String	getEtag() ETag of the resource.
String	getForegroundColor() The foreground color of the calendar in the hexadecimal format "#ffffff".
Boolean	getHidden() Whether the calendar has been hidden from the list.
String	getId() Identifier of the calendar.
String	getKind() Type of the resource ("calendar#calendarListEntry").
String	getLocation() Geographic location of the calendar as free-form text.
CalendarListEntry.NotificationSettings	getNotificationSettings() The notifications that the authenticated user is receiving for this calendar.
Boolean	getPrimary() Whether the calendar is the primary calendar of the authenticated user.
Boolean	getSelected() Whether the calendar content shows up in the calendar UI.
String	getSummary() Title of the calendar.
String	getSummaryOverride() The summary that the authenticated user has set for this calendar.
String	getTimeZone() The time zone of the calendar.
boolean	isDeleted() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
boolean	isHidden() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
boolean	isPrimary() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
boolean	isSelected() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
CalendarListEntry	set(String fieldName, Object value)
CalendarListEntry	setAccessRole(String accessRole) The effective access role that the authenticated user has on the calendar.
CalendarListEntry	setBackgroundColor(String backgroundColor) The main color of the calendar in the hexadecimal format "#0088aa".
CalendarListEntry	setColorId(String colorId) The color of the calendar.
CalendarListEntry	setConferenceProperties(ConferenceProperties conferenceProperties) Conferencing properties for this calendar, for example what types of conferences are allowed.
CalendarListEntry	setDefaultReminders(List<EventReminder> defaultReminders) The default reminders that the authenticated user has for this calendar.
CalendarListEntry	setDeleted(Boolean deleted) Whether this calendar list entry has been deleted from the calendar list.
CalendarListEntry	setDescription(String description) Description of the calendar.
CalendarListEntry	setEtag(String etag) ETag of the resource.
CalendarListEntry	setForegroundColor(String foregroundColor) The foreground color of the calendar in the hexadecimal format "#ffffff".
CalendarListEntry	setHidden(Boolean hidden) Whether the calendar has been hidden from the list.
CalendarListEntry	setId(String id) Identifier of the calendar.
CalendarListEntry	setKind(String kind) Type of the resource ("calendar#calendarListEntry").
CalendarListEntry	setLocation(String location) Geographic location of the calendar as free-form text.
CalendarListEntry	setNotificationSettings(CalendarListEntry.NotificationSettings notificationSettings) The notifications that the authenticated user is receiving for this calendar.
CalendarListEntry	setPrimary(Boolean primary) Whether the calendar is the primary calendar of the authenticated user.
CalendarListEntry	setSelected(Boolean selected) Whether the calendar content shows up in the calendar UI.
CalendarListEntry	setSummary(String summary) Title of the calendar.
CalendarListEntry	setSummaryOverride(String summaryOverride) The summary that the authenticated user has set for this calendar.
CalendarListEntry	setTimeZone(String timeZone) The time zone of the calendar.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

CalendarListEntry

public CalendarListEntry()

Method Detail

getAccessRole

public String getAccessRole()

The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: - "freeBusyReader" - Provides read access to free/busy information. - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

Returns:

value or null for none

setAccessRole

public CalendarListEntry setAccessRole(String accessRole)

The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: - "freeBusyReader" - Provides read access to free/busy information. - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

Parameters:

accessRole - accessRole or null for none

getBackgroundColor

public String getBackgroundColor()

The main color of the calendar in the hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.

Returns:

value or null for none

setBackgroundColor

public CalendarListEntry setBackgroundColor(String backgroundColor)

The main color of the calendar in the hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.

Parameters:

backgroundColor - backgroundColor or null for none

getColorId

public String getColorId()

The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.

Returns:

value or null for none

setColorId

public CalendarListEntry setColorId(String colorId)

The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.

Parameters:

colorId - colorId or null for none

getConferenceProperties

public ConferenceProperties getConferenceProperties()

Conferencing properties for this calendar, for example what types of conferences are allowed.

Returns:

value or null for none

setConferenceProperties

public CalendarListEntry setConferenceProperties(ConferenceProperties conferenceProperties)

Conferencing properties for this calendar, for example what types of conferences are allowed.

Parameters:

conferenceProperties - conferenceProperties or null for none

getDefaultReminders

public List<EventReminder> getDefaultReminders()

The default reminders that the authenticated user has for this calendar.

Returns:

value or null for none

setDefaultReminders

public CalendarListEntry setDefaultReminders(List<EventReminder> defaultReminders)

The default reminders that the authenticated user has for this calendar.

Parameters:

defaultReminders - defaultReminders or null for none

getDeleted

public Boolean getDeleted()

Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.

Returns:

value or null for none

setDeleted

public CalendarListEntry setDeleted(Boolean deleted)

Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.

Parameters:

deleted - deleted or null for none

isDeleted

public boolean isDeleted()

Convenience method that returns only 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 calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.

getDescription

public String getDescription()

Description of the calendar. Optional. Read-only.

Returns:

value or null for none

setDescription

public CalendarListEntry setDescription(String description)

Description of the calendar. Optional. Read-only.

Parameters:

description - description or null for none

getEtag

public String getEtag()

ETag of the resource.

Returns:

value or null for none

setEtag

public CalendarListEntry setEtag(String etag)

ETag of the resource.

Parameters:

etag - etag or null for none

getForegroundColor

public String getForegroundColor()

The foreground color of the calendar in the hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.

Returns:

value or null for none

setForegroundColor

public CalendarListEntry setForegroundColor(String foregroundColor)

The foreground color of the calendar in the hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.

Parameters:

foregroundColor - foregroundColor or null for none

getHidden

public Boolean getHidden()

Whether the calendar has been hidden from the list. Optional. The attribute is only returned when the calendar is hidden, in which case the value is true.

Returns:

value or null for none

setHidden

public CalendarListEntry setHidden(Boolean hidden)

Whether the calendar has been hidden from the list. Optional. The attribute is only returned when the calendar is hidden, in which case the value is true.

Parameters:

hidden - hidden or null for none

isHidden

public boolean isHidden()

Convenience method that returns only 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 calendar has been hidden from the list. Optional. The attribute is only returned when the calendar is hidden, in which case the value is true.

getId

public String getId()

Identifier of the calendar.

Returns:

value or null for none

setId

public CalendarListEntry setId(String id)

Identifier of the calendar.

Parameters:

id - id or null for none

getKind

public String getKind()

Type of the resource ("calendar#calendarListEntry").

Returns:

value or null for none

setKind

public CalendarListEntry setKind(String kind)

Type of the resource ("calendar#calendarListEntry").

Parameters:

kind - kind or null for none

getLocation

public String getLocation()

Geographic location of the calendar as free-form text. Optional. Read-only.

Returns:

value or null for none

setLocation

public CalendarListEntry setLocation(String location)

Geographic location of the calendar as free-form text. Optional. Read-only.

Parameters:

location - location or null for none

getNotificationSettings

public CalendarListEntry.NotificationSettings getNotificationSettings()

The notifications that the authenticated user is receiving for this calendar.

Returns:

value or null for none

setNotificationSettings

public CalendarListEntry setNotificationSettings(CalendarListEntry.NotificationSettings notificationSettings)

The notifications that the authenticated user is receiving for this calendar.

Parameters:

notificationSettings - notificationSettings or null for none

getPrimary

public Boolean getPrimary()

Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.

Returns:

value or null for none

setPrimary

public CalendarListEntry setPrimary(Boolean primary)

Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.

Parameters:

primary - primary or null for none

isPrimary

public boolean isPrimary()

Convenience method that returns only 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 calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.

getSelected

public Boolean getSelected()

Whether the calendar content shows up in the calendar UI. Optional. The default is False.

Returns:

value or null for none

setSelected

public CalendarListEntry setSelected(Boolean selected)

Whether the calendar content shows up in the calendar UI. Optional. The default is False.

Parameters:

selected - selected or null for none

isSelected

public boolean isSelected()

Convenience method that returns only 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 calendar content shows up in the calendar UI. Optional. The default is False.

getSummary

public String getSummary()

Title of the calendar. Read-only.

Returns:

value or null for none

setSummary

public CalendarListEntry setSummary(String summary)

Title of the calendar. Read-only.

Parameters:

summary - summary or null for none

getSummaryOverride

public String getSummaryOverride()

The summary that the authenticated user has set for this calendar. Optional.

Returns:

value or null for none

setSummaryOverride

public CalendarListEntry setSummaryOverride(String summaryOverride)

The summary that the authenticated user has set for this calendar. Optional.

Parameters:

summaryOverride - summaryOverride or null for none

getTimeZone

public String getTimeZone()

The time zone of the calendar. Optional. Read-only.

Returns:

value or null for none

setTimeZone

public CalendarListEntry setTimeZone(String timeZone)

The time zone of the calendar. Optional. Read-only.

Parameters:

timeZone - timeZone or null for none

set

public CalendarListEntry set(String fieldName,
                             Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public CalendarListEntry clone()

Overrides:

clone in class com.google.api.client.json.GenericJson