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

CalendarList

class CalendarList extends Resource (View source)

The "calendarList" collection of methods.

Typical usage is:

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

Methods

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

Removes a calendar from the user's calendar list. (calendarList.delete)

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

Returns a calendar from the user's calendar list. (calendarList.get)

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

Inserts an existing calendar into the user's calendar list.

CalendarList
listCalendarList(array $optParams = [])

Returns the calendars on the user's calendar list.

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

Updates an existing calendar on the user's calendar list. This method supports patch semantics. (calendarList.patch)

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

Updates an existing calendar on the user's calendar list.

Channel
watch(Channel $postBody, array $optParams = [])

Watch for changes to CalendarList resources. (calendarList.watch)

Details

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

Removes a calendar from the user's calendar list. (calendarList.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 59
CalendarListEntry get(string $calendarId, array $optParams = [])

Returns a calendar from the user's calendar list. (calendarList.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

CalendarListEntry

Exceptions

Exception

at line 79
CalendarListEntry insert(CalendarListEntry $postBody, array $optParams = [])

Inserts an existing calendar into the user's calendar list.

(calendarList.insert)

Parameters

CalendarListEntry $postBody
array $optParams

Optional parameters.

Return Value

CalendarListEntry

Exceptions

Exception

at line 117
CalendarList listCalendarList(array $optParams = [])

Returns the calendars on the user's calendar list.

(calendarList.listCalendarList)

Parameters

array $optParams

Optional parameters.

Return Value

CalendarList

Exceptions

Exception

at line 140
CalendarListEntry patch(string $calendarId, CalendarListEntry $postBody, array $optParams = [])

Updates an existing calendar on the user's calendar list. This method supports patch semantics. (calendarList.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.
CalendarListEntry $postBody
array $optParams

Optional parameters.

Return Value

CalendarListEntry

Exceptions

Exception

at line 163
CalendarListEntry update(string $calendarId, CalendarListEntry $postBody, array $optParams = [])

Updates an existing calendar on the user's calendar list.

(calendarList.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.
CalendarListEntry $postBody
array $optParams

Optional parameters.

Return Value

CalendarListEntry

Exceptions

Exception

at line 201
Channel watch(Channel $postBody, array $optParams = [])

Watch for changes to CalendarList resources. (calendarList.watch)

Parameters

Channel $postBody
array $optParams

Optional parameters.

Return Value

Channel

Exceptions

Exception