Calendar API v3 (revision 30)



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

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.CalendarListEntry
All Implemented Interfaces:
java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public final class CalendarListEntry
extends 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: 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
 
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
CalendarListEntry()
           
 
Method Summary
 java.lang.String getAccessRole()
          The effective access role that the authenticated user has on the calendar.
 java.lang.String getBackgroundColor()
          The main color of the calendar in the format '#0088aa'.
 java.lang.String getColorId()
          The color of the calendar.
 java.util.List<EventReminder> getDefaultReminders()
          The default reminders that the authenticated user has for this calendar.
 java.lang.String getDescription()
          Description of the calendar.
 java.lang.String getEtag()
          ETag of the resource.
 java.lang.String getForegroundColor()
          The foreground color of the calendar in the format '#ffffff'.
 java.lang.Boolean getHidden()
          Whether the calendar has been hidden from the list.
 java.lang.String getId()
          Identifier of the calendar.
 java.lang.String getKind()
          Type of the resource ("calendar#calendarListEntry").
 java.lang.String getLocation()
          Geographic location of the calendar as free-form text.
 java.lang.Boolean getPrimary()
          Whether the calendar is the primary calendar of the authenticated user.
 java.lang.Boolean getSelected()
          Whether the calendar content shows up in the calendar UI.
 java.lang.String getSummary()
          Title of the calendar.
 java.lang.String getSummaryOverride()
          The summary that the authenticated user has set for this calendar.
 java.lang.String getTimeZone()
          The time zone of the calendar.
 CalendarListEntry setAccessRole(java.lang.String accessRole)
          The effective access role that the authenticated user has on the calendar.
 CalendarListEntry setBackgroundColor(java.lang.String backgroundColor)
          The main color of the calendar in the format '#0088aa'.
 CalendarListEntry setColorId(java.lang.String colorId)
          The color of the calendar.
 CalendarListEntry setDefaultReminders(java.util.List<EventReminder> defaultReminders)
          The default reminders that the authenticated user has for this calendar.
 CalendarListEntry setDescription(java.lang.String description)
          Description of the calendar.
 CalendarListEntry setEtag(java.lang.String etag)
          ETag of the resource.
 CalendarListEntry setForegroundColor(java.lang.String foregroundColor)
          The foreground color of the calendar in the format '#ffffff'.
 CalendarListEntry setHidden(java.lang.Boolean hidden)
          Whether the calendar has been hidden from the list.
 CalendarListEntry setId(java.lang.String id)
          Identifier of the calendar.
 CalendarListEntry setKind(java.lang.String kind)
          Type of the resource ("calendar#calendarListEntry").
 CalendarListEntry setLocation(java.lang.String location)
          Geographic location of the calendar as free-form text.
 CalendarListEntry setPrimary(java.lang.Boolean primary)
          Whether the calendar is the primary calendar of the authenticated user.
 CalendarListEntry setSelected(java.lang.Boolean selected)
          Whether the calendar content shows up in the calendar UI.
 CalendarListEntry setSummary(java.lang.String summary)
          Title of the calendar.
 CalendarListEntry setSummaryOverride(java.lang.String summaryOverride)
          The summary that the authenticated user has set for this calendar.
 CalendarListEntry setTimeZone(java.lang.String timeZone)
          The time zone of the calendar.
 
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

CalendarListEntry

public CalendarListEntry()
Method Detail

getAccessRole

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


setAccessRole

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


getBackgroundColor

public java.lang.String getBackgroundColor()
The main color of the calendar in the format '#0088aa'. This property supersedes the index- based colorId property. Optional. The value returned may be null.


setBackgroundColor

public CalendarListEntry setBackgroundColor(java.lang.String backgroundColor)
The main color of the calendar in the format '#0088aa'. This property supersedes the index- based colorId property. Optional. The value set may be null.


getColorId

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


setColorId

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


getDefaultReminders

public java.util.List<EventReminder> getDefaultReminders()
The default reminders that the authenticated user has for this calendar. The value returned may be null.


setDefaultReminders

public CalendarListEntry setDefaultReminders(java.util.List<EventReminder> defaultReminders)
The default reminders that the authenticated user has for this calendar. The value set may be null.


getDescription

public java.lang.String getDescription()
Description of the calendar. Optional. Read-only. The value returned may be null.


setDescription

public CalendarListEntry setDescription(java.lang.String description)
Description of the calendar. Optional. Read-only. The value set may be null.


getEtag

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


setEtag

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


getForegroundColor

public java.lang.String getForegroundColor()
The foreground color of the calendar in the format '#ffffff'. This property supersedes the index-based colorId property. Optional. The value returned may be null.


setForegroundColor

public CalendarListEntry setForegroundColor(java.lang.String foregroundColor)
The foreground color of the calendar in the format '#ffffff'. This property supersedes the index-based colorId property. Optional. The value set may be null.


getHidden

public java.lang.Boolean getHidden()
Whether the calendar has been hidden from the list. Optional. The default is False. The value returned may be null.


setHidden

public CalendarListEntry setHidden(java.lang.Boolean hidden)
Whether the calendar has been hidden from the list. Optional. The default is False. The value set may be null.


getId

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


setId

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


getKind

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


setKind

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


getLocation

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


setLocation

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


getPrimary

public java.lang.Boolean getPrimary()
Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False. The value returned may be null.


setPrimary

public CalendarListEntry setPrimary(java.lang.Boolean primary)
Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False. The value set may be null.


getSelected

public java.lang.Boolean getSelected()
Whether the calendar content shows up in the calendar UI. Optional. The default is False. The value returned may be null.


setSelected

public CalendarListEntry setSelected(java.lang.Boolean selected)
Whether the calendar content shows up in the calendar UI. Optional. The default is False. The value set may be null.


getSummary

public java.lang.String getSummary()
Title of the calendar. Read-only. The value returned may be null.


setSummary

public CalendarListEntry setSummary(java.lang.String summary)
Title of the calendar. Read-only. The value set may be null.


getSummaryOverride

public java.lang.String getSummaryOverride()
The summary that the authenticated user has set for this calendar. Optional. The value returned may be null.


setSummaryOverride

public CalendarListEntry setSummaryOverride(java.lang.String summaryOverride)
The summary that the authenticated user has set for this calendar. Optional. The value set may be null.


getTimeZone

public java.lang.String getTimeZone()
The time zone of the calendar. Optional. Read-only. The value returned may be null.


setTimeZone

public CalendarListEntry setTimeZone(java.lang.String timeZone)
The time zone of the calendar. Optional. Read-only. The value set may be null.