Documentation

Google_Service_Calendar_Resource_Calendars extends Google_Service_Resource
in package

The "calendars" collection of methods.

Typical usage is: $calendarService = new Google_Service_Calendar(...); $calendars = $calendarService->calendars;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
clear()  : mixed
Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account. (calendars.clear)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : mixed
Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars. (calendars.delete)
get()  : Google_Service_Calendar_Calendar
Returns metadata for a calendar. (calendars.get)
insert()  : Google_Service_Calendar_Calendar
Creates a secondary calendar. (calendars.insert)
patch()  : Google_Service_Calendar_Calendar
Updates metadata for a calendar. This method supports patch semantics.
update()  : Google_Service_Calendar_Calendar
Updates metadata for a calendar. (calendars.update)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

clear()

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

public clear(string $calendarId[, array<string|int, mixed> $optParams = array() ]) : mixed
Parameters
$calendarId : string

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 : array<string|int, mixed> = array()

Optional parameters.

Return values
mixed —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

delete()

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

public delete(string $calendarId[, array<string|int, mixed> $optParams = array() ]) : mixed
Parameters
$calendarId : string

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 : array<string|int, mixed> = array()

Optional parameters.

Return values
mixed —

get()

Returns metadata for a calendar. (calendars.get)

public get(string $calendarId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Calendar_Calendar
Parameters
$calendarId : string

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 : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Calendar_Calendar —

patch()

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

public patch(string $calendarId, Google_Service_Calendar_Calendar $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Calendar_Calendar

(calendars.patch)

Parameters
$calendarId : string

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 : Google_Service_Calendar_Calendar
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Calendar_Calendar —

update()

Updates metadata for a calendar. (calendars.update)

public update(string $calendarId, Google_Service_Calendar_Calendar $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Calendar_Calendar
Parameters
$calendarId : string

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 : Google_Service_Calendar_Calendar
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Calendar_Calendar —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results