1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Calendar
  7. \
  8. Resource
  9. \
  10. Calendars

Calendars

class Calendars extends Resource (View source)

The "calendars" collection of methods.

Typical usage is:

 $calendarService = new Google\Service\Calendar(...);
 $calendars = $calendarService->calendars;

Methods

clear(string $calendarId, array $optParams = [])

Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account. (calendars.clear)

delete(string $calendarId, array $optParams = [])

Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars. (calendars.delete)

Calendar
get(string $calendarId, array $optParams = [])

Returns metadata for a calendar. (calendars.get)

Calendar
insert(Calendar $postBody, array $optParams = [])

Creates a secondary calendar. (calendars.insert)

Calendar
patch(string $calendarId, Calendar $postBody, array $optParams = [])

Updates metadata for a calendar. This method supports patch semantics.

Calendar
update(string $calendarId, Calendar $postBody, array $optParams = [])

Updates metadata for a calendar. (calendars.update)

Details

at line 42
clear(string $calendarId, array $optParams = [])

Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account. (calendars.clear)

Parameters

string $calendarId

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
array $optParams

Optional parameters.

Exceptions

Exception

at line 58
delete(string $calendarId, array $optParams = [])

Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars. (calendars.delete)

Parameters

string $calendarId

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
array $optParams

Optional parameters.

Exceptions

Exception

at line 74
Calendar get(string $calendarId, array $optParams = [])

Returns metadata for a calendar. (calendars.get)

Parameters

string $calendarId

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
array $optParams

Optional parameters.

Return Value

Calendar

Exceptions

Exception

at line 88
Calendar insert(Calendar $postBody, array $optParams = [])

Creates a secondary calendar. (calendars.insert)

Parameters

Calendar $postBody
array $optParams

Optional parameters.

Return Value

Calendar

Exceptions

Exception

at line 106
Calendar patch(string $calendarId, Calendar $postBody, array $optParams = [])

Updates metadata for a calendar. This method supports patch semantics.

(calendars.patch)

Parameters

string $calendarId

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
Calendar $postBody
array $optParams

Optional parameters.

Return Value

Calendar

Exceptions

Exception

at line 123
Calendar update(string $calendarId, Calendar $postBody, array $optParams = [])

Updates metadata for a calendar. (calendars.update)

Parameters

string $calendarId

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
Calendar $postBody
array $optParams

Optional parameters.

Return Value

Calendar

Exceptions

Exception