GCalendar

java.lang.Object
- gappsv3.GCalendar

```
public class GCalendar
extends Object
```
GCalendar is a wrapper around Google's CalendarListEntry and represents a single calendar. All filter fields for the getEvents() method default to null. If a field has been set, but the value of the filter is no longer desired, the field can be set to null() and the filter will no longer be applied.

Field Summary

Fields
Modifier and Type	Field and Description
`Boolean`	`AlwaysIncludeEmail!` Filter for getEvents() method: Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e.
`BBjString`	`ICalUID!` Filter for getEvents() method: Specifies event ID in the iCalendar format to be included in the response.
`BBjNumber`	`MaxAttendees!` Filter for getEvents() method: The maximum number of attendees to include in the response.
`BBjNumber`	`MaxResults!` Filter for getEvents() method: Maximum number of events returned on one result page.
`BBjString`	`OrderBy!` Filter for getEvents() method: The order of the events returned in the result.
`BBjString`	`PageToken!` Filter for getEvents() method: Token specifying which result page to return.
`BBjVector`	`PrivateExtendedProperty!` Extended properties constraint specified as propertyName = value.
`BBjString`	`Q!` Filter for getEvents() method: Free text search terms to find events that match these terms in any field, except for extended properties.
`BBjVector`	`SharedExtendedProperty!` Extended properties constraint specified as propertyName = value.
`Boolean`	`ShowDeleted!` Whether to include deleted events (with status equals "cancelled") in the result.
`Boolean`	`ShowHiddenInvitations!` Whether to include hidden invitations in the result.
`BBjNumber`	`SingleEvents!` Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves.
`BBjString`	`SyncToken!` Token obtained from the nextSyncToken field returned on the last page of results from the previous list request.
`Date`	`TimeMax!` Filter for getEvents() method: Upper bound (exclusive) for an event's start time to filter by.
`Date`	`TimeMin!` Lower bound (inclusive) for an event's end time to filter by.
`BBjString`	`TimeZone!` Filter for getEvents() method: Time zone used in the response.
`Date`	`UpdatedMin!` Lower bound for an event's last modification time (as a RFC 3339 timestamp) to filter by.

Constructor Summary

Constructors
Constructor and Description

GCalendar(GCalendarAPI api!, CalendarListEntry wrappedCalendar!)
Constructor

Constructors
Constructor and Description
`GCalendar(GCalendarAPI api!, CalendarListEntry wrappedCalendar!)` Constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GEvent`	`addEvent(GEvent event!)` Add an event to the calendar.
`void`	`deleteEvent(GEvent event!)` Delete an event in the calendar.
`BBjString`	`getAccessRole()` Get access role.
`BBjString`	`getBackgroundColor()` Get background color.
`BBjVector`	`getBusyTimes(Date startDate!, Date endDate!)`
`BBjString`	`getColorId()` Get color id.
`GEvents`	`getDeletedEvents()` Gets deleted events
`BBjString`	`getDescription()` Description of the calendar.
`BBjString`	`getEtag()` ETag for the calendar.
`GEvents`	`getEvents()` Get all events (like scheduled appointments) associated with this calendar.
`GEvents`	`getEvents(BBjString retrieveToken!)` Get all events (like scheduled appointments) associated with this calendar using a token that represents a datetime when events were last retrieved.
`GEvents`	`getEvents(DateTime timeMin!, DateTime timeMax!)` Get all events (like scheduled appointments) associated with this calendar that fall in between the specified date range.
`BBjString`	`getForegroundColor()` Get foreground color.
`BBjNumber`	`getHidden()` Returns whether calendar is suppressed from displaying.
`BBjString`	`getId()` Returns the calendar's Id string.
`BBjString`	`getKind()` Specifies the type of Google resource.
`BBjString`	`getLocation()` Get Calendar's location.
`static Date`	`getRelativeDate(BBjNumber field, BBjNumber amount)`
`BBjString`	`getSummary()` Retrieves the calendar's summary.
`BBjString`	`getSummaryOverride()` Retrieves the calendar's summary override.
`BBjString`	`getTimeZone()` Retrieves the calendar's timezone.
`BBjNumber`	`isDeleted()` Indicates whether this calendar has been deleted.
`BBjNumber`	`isPrimary()` Specifies whether this is the user's default calendar.
`BBjNumber`	`isSelected()` Indicates whether the calendar is selected.
`GCalendar`	`set(BBjString fieldName!, Object value!)` Can be used to set JSON properties in the calendar.
`GCalendar`	`setAccessRole(BBjString accessRole!)` Set access role.
`GCalendar`	`setBackgroundColor(BBjString backgroundColor!)` Set the background color of the calendar.
`GCalendar`	`setColorId(BBjString colorId!)` Set color id
`GCalendar`	`setDeleted(BBjNumber deleted!)` Set calendar's "deleted" attribute
`GCalendar`	`setDescription(BBjString description!)` Set calendar's description
`GCalendar`	`setEtag(BBjString etag!)` Set calendar's "deleted" attribute
`GEvent`	`updateEvent(GEvent event!)` Update an event in the calendar.

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

- Field Detail
  - AlwaysIncludeEmail!
```
public Boolean AlwaysIncludeEmail!
```
    Filter for getEvents() method: Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. If null(), value defaults to False. (boolean)
    
    See Also:
    
    https://developers.google.com/google-apps/calendar/v3/reference/events/list
  - ICalUID!
```
public BBjString ICalUID!
```
    Filter for getEvents() method: Specifies event ID in the iCalendar format to be included in the response. Optional. (string)
    
    See Also:
    
    https://developers.google.com/google-apps/calendar/v3/reference/events/list
  - MaxAttendees!
```
public BBjNumber MaxAttendees!
```
    Filter for getEvents() method: The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. (integer, 1+)
    
    See Also:
    
    https://developers.google.com/google-apps/calendar/v3/reference/events/list
  - MaxResults!
```
public BBjNumber MaxResults!
```
    Filter for getEvents() method: Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional. (integer, 1+)
    
    See Also:
    
    https://developers.google.com/google-apps/calendar/v3/reference/events/list
  - OrderBy!
```
public BBjString OrderBy!
```
    Filter for getEvents() method: The order of the events returned in the result. Optional. The default is an unspecified, stable order. (string) Valid values are "startTime" and "updated"
    
    See Also:
    
    https://developers.google.com/google-apps/calendar/v3/reference/events/list
  - PageToken!
```
public BBjString PageToken!
```
    Filter for getEvents() method: Token specifying which result page to return. Optional. (string)
    
    See Also:
    
    https://developers.google.com/google-apps/calendar/v3/reference/events/list
  - PrivateExtendedProperty!
```
public BBjVector PrivateExtendedProperty!
```
    Extended properties constraint specified as propertyName = value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints. (string)
    
    See Also:
    
    https://developers.google.com/google-apps/calendar/v3/reference/events/list
  - Q!
```
public BBjString Q!
```
    Filter for getEvents() method: Free text search terms to find events that match these terms in any field, except for extended properties. Optional. (string)
    
    See Also:
    
    https://developers.google.com/google-apps/calendar/v3/reference/events/list
  - SharedExtendedProperty!
```
public BBjVector SharedExtendedProperty!
```
    Extended properties constraint specified as propertyName = value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.
    
    See Also:
    
    https://developers.google.com/google-apps/calendar/v3/reference/events/list
  - ShowDeleted!
```
public Boolean ShowDeleted!
```
    Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False. (boolean)
    
    See Also:
    
    https://developers.google.com/google-apps/calendar/v3/reference/events/list
  - ShowHiddenInvitations!
```
public Boolean ShowHiddenInvitations!
```
    Whether to include hidden invitations in the result. Optional. The default is False. (boolean)
    
    See Also:
    
    https://developers.google.com/google-apps/calendar/v3/reference/events/list
  - SingleEvents!
```
public BBjNumber SingleEvents!
```
    Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False. (boolean)
    
    See Also:
    
    https://developers.google.com/google-apps/calendar/v3/reference/events/list
  - SyncToken!
```
public BBjString SyncToken!
```
    Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state. These are: ICalUID OrderBy PrivateExtendedProperty Q SharedExtendedProperty TimeMin TimeMax UpdatedMin If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Optional. The default is to return all entries. (string)
    
    See Also:
    
    https://developers.google.com/google-apps/calendar/v3/reference/events/list
  - TimeMax!
```
public Date TimeMax!
```
    Filter for getEvents() method: Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. (string)
    
    See Also:
    
    https://developers.google.com/google-apps/calendar/v3/reference/events/list
  - TimeMin!
```
public Date TimeMin!
```
    Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. (string)
    
    See Also:
    
    https://developers.google.com/google-apps/calendar/v3/reference/events/list
  - TimeZone!
```
public BBjString TimeZone!
```
    Filter for getEvents() method: Time zone used in the response. Optional. The default is the time zone of the calendar. (string)
    
    See Also:
    
    https://developers.google.com/google-apps/calendar/v3/reference/events/list
  - UpdatedMin!
```
public Date UpdatedMin!
```
    Lower bound for an event's last modification time (as a RFC 3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time. (string)
    
    See Also:
    
    https://developers.google.com/google-apps/calendar/v3/reference/events/list
- Constructor Detail
  - GCalendar
```
public GCalendar(GCalendarAPI api!,
CalendarListEntry wrappedCalendar!)
```
    Constructor
    
    Parameters:
    
    wrappedCalendar! - CalendarListEntry that will be wrapped by this class. Can not be null.
- Method Detail
  - getEvents
```
public GEvents getEvents()
```
    Get all events (like scheduled appointments) associated with this calendar.
    
    Returns:
    
    GEvents which contains the GEvent objects in the calendar.
  - getEvents
```
public GEvents getEvents(DateTime timeMin!,
DateTime timeMax!)
```
    Get all events (like scheduled appointments) associated with this calendar that fall in between the specified date range.
    
    Parameters:
    
    timeMin! - DateTime that specifies the lower data range.
    
    timeMax! - DateTime that specifies the higher data range.
    
    Returns:
    
    GEvents which contains the GEvent objects in the calendar.
  - getEvents
```
public GEvents getEvents(BBjString retrieveToken!)
```
    Get all events (like scheduled appointments) associated with this calendar using a token that represents a datetime when events were last retrieved.
    
    Parameters:
    
    retrieveToken! - token that represents a datetime when events were last retrieved.
    
    Returns:
    
    GEvents which contains the GEvent objects in the calendar.
  - addEvent
```
public GEvent addEvent(GEvent event!)
```
    Add an event to the calendar.
    
    Parameters:
    
    event! - Event to be added to the calendar.
    
    Returns:
    
    The event object as updated by the calendar. One thing the returned event will have is an ID, which is null() before the event is added to the calendar.
    
    Throws:
    
    !ERROR - = 300 A Google Calendar API Error has occurred
  - updateEvent
```
public GEvent updateEvent(GEvent event!)
```
    Update an event in the calendar.
    
    Parameters:
    
    event! - Event to be updated in the calendar. Event must already exist in the calendar. REM * @return The event object as updated by the calendar.
    
    Throws:
    
    !ERROR - = 300 A Google Calendar API Error has occurred
  - deleteEvent
```
public void deleteEvent(GEvent event!)
```
    Delete an event in the calendar.
    
    Parameters:
    
    event! - Event to be deleted in the calendar. Event must already exist in the calendar.
    
    Throws:
    
    !ERROR - = 300 A Google Calendar API Error has occurred
  - getAccessRole
```
public BBjString getAccessRole()
```
    Get access role.
    
    Returns:
    
    String representing access role.
  - getBackgroundColor
```
public BBjString getBackgroundColor()
```
    Get background color.
    
    Returns:
    
    String representing background color.
  - getColorId
```
public BBjString getColorId()
```
    Get color id.
    
    Returns:
    
    String representing color id.
  - isDeleted
```
public BBjNumber isDeleted()
```
    Indicates whether this calendar has been deleted.
    
    Returns:
    
    0 or 1.
    0 indicates the event is not deleted.
    1 indicates the event is deleted.
  - getDeletedEvents
```
public GEvents getDeletedEvents()
```
    Gets deleted events
    
    Returns:
    
    GEvents containing the deleted events in the calendar
  - getDescription
```
public BBjString getDescription()
```
    Description of the calendar.
    
    Returns:
    
    String containing the text of the calendar's description.
  - getEtag
```
public BBjString getEtag()
```
    ETag for the calendar. ETags are used in caching to determine whether a resource has changed.
    
    Returns:
    
    The ETag for the calendar.
    
    See Also:
    
    http://en.wikipedia.org/wiki/HTTP_ETag
  - getForegroundColor
```
public BBjString getForegroundColor()
```
    Get foreground color.
    
    Returns:
    
    String representing foreground color.
  - getHidden
```
public BBjNumber getHidden()
```
    Returns whether calendar is suppressed from displaying. User can have several calendars, but only show the desired calendars at any time.
    
    Returns:
    
    0 or 1:
    0 indicates the calendar is shown.
    1 indicates the calendar is hidden.
  - getId
```
public BBjString getId()
```
    Returns the calendar's Id string. Can be used to reference the calendar later. The special ID String "primary" refers to the Google account's default calendar.
    
    Returns:
    
    String representing the calendar id.
  - getKind
```
public BBjString getKind()
```
    Specifies the type of Google resource.
    
    Returns:
    
    Always returns "calendar#calendarListEntry".
  - getLocation
```
public BBjString getLocation()
```
    Get Calendar's location.
    
    Returns:
    
    String representing calendar's location.
  - isPrimary
```
public BBjNumber isPrimary()
```
    Specifies whether this is the user's default calendar. There is one primary calendar per Google Account.
    
    Returns:
    
    0 or 1:
    0 indicates this is not the primary calendar.
    1 indicates this is the primary calendar.
  - isSelected
```
public BBjNumber isSelected()
```
    Indicates whether the calendar is selected.
    
    Returns:
    
    0 or 1:
    0 indicates this is not the selected calendar.
    1 indicates this is the selected calendar.
  - getSummary
```
public BBjString getSummary()
```
    Retrieves the calendar's summary.
    
    Returns:
    
    String containing the text of the calendar's summary.
  - getSummaryOverride
```
public BBjString getSummaryOverride()
```
    Retrieves the calendar's summary override.
    
    Returns:
    
    String containing the text of the calendar's summary override.
  - getTimeZone
```
public BBjString getTimeZone()
```
    Retrieves the calendar's timezone.
    
    Returns:
    
    String representing the calendar's timezone.
  - set
```
public GCalendar set(BBjString fieldName!,
Object value!)
```
    Can be used to set JSON properties in the calendar.
    
    Parameters:
    
    fieldName! - Name of the property/variable/field to set
    
    value! - What value to set the property to.
    
    Returns:
    
    Resulting modified GCalendar.
    
    See Also:
    
    See the structure under the heading "Resource Representations"
  - setAccessRole
```
public GCalendar setAccessRole(BBjString accessRole!)
```
    Set access role.
    
    Parameters:
    
    accessRole! - String representing access role.
    
    Returns:
    
    Resulting modified GCalendar.
  - setBackgroundColor
```
public GCalendar setBackgroundColor(BBjString backgroundColor!)
```
    Set the background color of the calendar. param backgroundColor! String representing the color to set the calendar's background to.
    
    Returns:
    
    Resulting modified GCalendar.
  - setColorId
```
public GCalendar setColorId(BBjString colorId!)
```
    Set color id
    
    Parameters:
    
    colorId! - String representing the color ID.
    
    Returns:
    
    Resulting modified GCalendar.
  - setDeleted
```
public GCalendar setDeleted(BBjNumber deleted!)
```
    Set calendar's "deleted" attribute
    
    Parameters:
    
    deleted! - Can be 0 or non-zero:
    0 marks the calendar as not deleted, and non-zero marks the calendar as deleted.
    
    Returns:
    
    Resulting modified GCalendar.
  - setDescription
```
public GCalendar setDescription(BBjString description!)
```
    Set calendar's description
    
    Parameters:
    
    description! - A string containing the text of the calendar's description.
    
    Returns:
    
    Resulting modified GCalendar.
  - setEtag
```
public GCalendar setEtag(BBjString etag!)
```
    Set calendar's "deleted" attribute
    
    Parameters:
    
    deleted! - Can be 0 or non-zero:
    0 marks the calendar as not deleted, and non-zero marks the calendar as deleted.
    
    Returns:
    
    Resulting modified GCalendar.
  - getRelativeDate
```
public static Date getRelativeDate(BBjNumber field,
BBjNumber amount)
```
  - getBusyTimes
```
public BBjVector getBusyTimes(Date startDate!,
Date endDate!)
```

Class GCalendar

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

AlwaysIncludeEmail!

ICalUID!

MaxAttendees!

MaxResults!

OrderBy!

PageToken!

PrivateExtendedProperty!

Q!

SharedExtendedProperty!

ShowDeleted!

ShowHiddenInvitations!

SingleEvents!

SyncToken!

TimeMax!

TimeMin!

TimeZone!

UpdatedMin!

Constructor Detail

GCalendar

Method Detail

getEvents

getEvents

getEvents

addEvent

updateEvent

deleteEvent

getAccessRole

getBackgroundColor

getColorId

isDeleted

getDeletedEvents

getDescription

getEtag

getForegroundColor

getHidden

getId

getKind

getLocation

isPrimary

isSelected

getSummary

getSummaryOverride

getTimeZone

set

setAccessRole

setBackgroundColor

setColorId

setDeleted

setDescription

setEtag

getRelativeDate

getBusyTimes