The "calendarList" collection of methods. Typical usage is:
$calendarService = new Google_Service_Calendar(...);
$calendarList = $calendarService->calendarList;
Methods summary
public
|
#
delete( string $calendarId, array $optParams = array() )
Removes a calendar from the user's calendar list. (calendarList.delete)
Removes a calendar from the user's calendar list. (calendarList.delete)
Parameters
- $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.
- $optParams
- Optional parameters.
|
public
Google_Service_Calendar_CalendarListEntry
|
#
get( string $calendarId, array $optParams = array() )
Returns a calendar from the user's calendar list. (calendarList.get)
Returns a calendar from the user's calendar list. (calendarList.get)
Parameters
- $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.
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_Calendar_CalendarListEntry
|
#
insert( Google_Service_Calendar_CalendarListEntry $postBody, array $optParams = array() )
Inserts an existing calendar into the user's calendar list.
(calendarList.insert)
Inserts an existing calendar into the user's calendar list.
(calendarList.insert)
Parameters
- $postBody
- $optParams
- Optional parameters.
Returns
Opt_param
bool colorRgbFormat Whether to use the foregroundColor and backgroundColor
fields to write the calendar colors (RGB). If this feature is used, the
index-based colorId field will be set to the best matching option automatically.
Optional. The default is False.
|
public
Google_Service_Calendar_CalendarList
|
#
listCalendarList( array $optParams = array() )
Returns the calendars on the user's calendar list.
(calendarList.listCalendarList)
Returns the calendars on the user's calendar list.
(calendarList.listCalendarList)
Parameters
- $optParams
- Optional parameters.
Returns
Opt_param
int maxResults Maximum number of entries returned on one result page. By default
the value is 100 entries. The page size can never be larger than 250 entries.
Optional.
string minAccessRole The minimum access role for the user in the returned
entries. Optional. The default is no restriction.
string pageToken Token specifying which result page to return. Optional.
bool showDeleted Whether to include deleted calendar list entries in the result.
Optional. The default is False.
bool showHidden Whether to show hidden entries. Optional. The default is False.
string 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. If only
read-only fields such as calendar properties or ACLs have changed, the entry
won't be returned. All entries deleted and hidden since the previous list
request will always be in the result set and it is not allowed to set
showDeleted neither showHidden to False. To ensure client state consistency
minAccessRole query parameter cannot be specified together with nextSyncToken.
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. Learn more about incremental synchronization. Optional.
The default is to return all entries.
|
public
Google_Service_Calendar_CalendarListEntry
|
#
patch( string $calendarId, Google_Service_Calendar_CalendarListEntry $postBody, array $optParams = array() )
Updates an existing calendar on the user's calendar list. This method
supports patch semantics. (calendarList.patch)
Updates an existing calendar on the user's calendar list. This method
supports patch semantics. (calendarList.patch)
Parameters
- $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.
- $postBody
- $optParams
- Optional parameters.
Returns
Opt_param
bool colorRgbFormat Whether to use the foregroundColor and backgroundColor
fields to write the calendar colors (RGB). If this feature is used, the
index-based colorId field will be set to the best matching option automatically.
Optional. The default is False.
|
public
Google_Service_Calendar_CalendarListEntry
|
#
update( string $calendarId, Google_Service_Calendar_CalendarListEntry $postBody, array $optParams = array() )
Updates an existing calendar on the user's calendar list.
(calendarList.update)
Updates an existing calendar on the user's calendar list.
(calendarList.update)
Parameters
- $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.
- $postBody
- $optParams
- Optional parameters.
Returns
Opt_param
bool colorRgbFormat Whether to use the foregroundColor and backgroundColor
fields to write the calendar colors (RGB). If this feature is used, the
index-based colorId field will be set to the best matching option automatically.
Optional. The default is False.
|
public
Google_Service_Calendar_Channel
|
#
watch( Google_Service_Calendar_Channel $postBody, array $optParams = array() )
Watch for changes to CalendarList resources. (calendarList.watch)
Watch for changes to CalendarList resources. (calendarList.watch)
Parameters
- $postBody
- $optParams
- Optional parameters.
Returns
Opt_param
int maxResults Maximum number of entries returned on one result page. By default
the value is 100 entries. The page size can never be larger than 250 entries.
Optional.
string minAccessRole The minimum access role for the user in the returned
entries. Optional. The default is no restriction.
string pageToken Token specifying which result page to return. Optional.
bool showDeleted Whether to include deleted calendar list entries in the result.
Optional. The default is False.
bool showHidden Whether to show hidden entries. Optional. The default is False.
string 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. If only
read-only fields such as calendar properties or ACLs have changed, the entry
won't be returned. All entries deleted and hidden since the previous list
request will always be in the result set and it is not allowed to set
showDeleted neither showHidden to False. To ensure client state consistency
minAccessRole query parameter cannot be specified together with nextSyncToken.
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. Learn more about incremental synchronization. Optional.
The default is to return all entries.
|
Google_Service_Calendar_CalendarList_Resource