Package org.springframework.social.google.api.calendar

Class Calendar

java.lang.Object

org.springframework.social.google.api.ApiEntity

org.springframework.social.google.api.calendar.Calendar

public class Calendar
extends ApiEntity

Model class representing a calendar within Google Calendar.

See the reference documentation at https://developers.google.com/google-apps/calendar/v3/reference/calendarList#resource.

Author:

Martin Wink

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Calendar.EventReminder	Details of event reminders.
static class	Calendar.Notification	Details of an individual notification.
static class	Calendar.NotificationSettings	Details of notifications.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Calendar()	Constructor protected so instances must be retrieved from Google Calendar.

Method Summary

Modifier and Type	Method	Description
PermissionRole	getAccessRole()	The effective access role that the authenticated user has on this calendar.
String	getBackgroundColor()	The background colour of this calendar in hexadecimal format "#rrggbb".
String	getColorId()	The colour of this calendar.
List<Calendar.EventReminder>	getDefaultReminders()	The default reminders that the authenticated user has for this calendar.
String	getDescription()	The description of this calendar.
String	getForegroundColor()	The foreground colour of this calendar in hexadecimal format "#rrggbb".
String	getLocation()	The geographic location of this calendar as free-form text.
Calendar.NotificationSettings	getNotificationSettings()	The notifications that the authenticated user is receiving for this calendar.
String	getSummary()	The title of this calendar.
String	getSummaryOverride()	The overriding summary that the authenticated user has set for this calendar.
TimeZone	getTimeZone()	The time zone of this calendar.
boolean	isDeleted()	Whether this calendar has been deleted from the calendar list.
boolean	isHidden()	Whether this calendar has been hidden from the list.
boolean	isPrimary()	Whether this calendar is the primary calendar of the authenticated user.
boolean	isSelected()	Whether this calendar's content is displayed in the calendar UI.

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

Calendar

protected Calendar()

Constructor protected so instances must be retrieved from Google Calendar.

Method Detail

getSummary

public String getSummary()

The title of this calendar.

Returns:

the value or null if none.

getDescription

public String getDescription()

The description of this calendar.

Returns:

the value or null if none.

getLocation

public String getLocation()

The geographic location of this calendar as free-form text.

Returns:

the value or null if none.

getTimeZone

public TimeZone getTimeZone()

The time zone of this calendar.

Returns:

the value or null if none.

getSummaryOverride

public String getSummaryOverride()

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

Returns:

the value or null if none.

getColorId

public String getColorId()

The colour of this calendar.

Returns:

the value or null if none.

getBackgroundColor

public String getBackgroundColor()

The background colour of this calendar in hexadecimal format "#rrggbb".

Returns:

the value or null if none.

getForegroundColor

public String getForegroundColor()

The foreground colour of this calendar in hexadecimal format "#rrggbb".

Returns:

the value or null if none.

isHidden

public boolean isHidden()

Whether this calendar has been hidden from the list.

Returns:

the value.

isSelected

public boolean isSelected()

Whether this calendar's content is displayed in the calendar UI.

Returns:

the value.

getAccessRole

public PermissionRole getAccessRole()

The effective access role that the authenticated user has on this calendar.

Returns:

the value or null if none.

getDefaultReminders

public List<Calendar.EventReminder> getDefaultReminders()

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

Returns:

the value or null if none.

getNotificationSettings

public Calendar.NotificationSettings getNotificationSettings()

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

Returns:

the value or null if none.

isPrimary

public boolean isPrimary()

Whether this calendar is the primary calendar of the authenticated user.

Returns:

the value.

isDeleted

public boolean isDeleted()

Whether this calendar has been deleted from the calendar list.

Returns:

the value.