Documentation

Google_Service_Calendar_Resource_CalendarList extends Google_Service_Resource
in package

Application

The "calendarList" collection of methods.

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

$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.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : mixed: Removes a calendar from the user's calendar list. (calendarList.delete)
get() : Google_Service_Calendar_CalendarListEntry: Returns a calendar from the user's calendar list. (calendarList.get)
insert() : Google_Service_Calendar_CalendarListEntry: Inserts an existing calendar into the user's calendar list.
listCalendarList() : Google_Service_Calendar_CalendarList: Returns the calendars on the user's calendar list.
patch() : Google_Service_Calendar_CalendarListEntry: Updates an existing calendar on the user's calendar list. This method supports patch semantics. (calendarList.patch)
update() : Google_Service_Calendar_CalendarListEntry: Updates an existing calendar on the user's calendar list.
watch() : Google_Service_Calendar_Channel: Watch for changes to CalendarList resources. (calendarList.watch)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$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'))

__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

Return values

Google_Http_Request|expectedClass —

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>

Return values

string —

$requestUrl

delete()

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


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

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_CalendarListEntry —

insert()

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


    public
                insert(Google_Service_Calendar_CalendarListEntry $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Calendar_CalendarListEntry

(calendarList.insert)

Parameters

$postBody : Google_Service_Calendar_CalendarListEntry
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Calendar_CalendarListEntry —

listCalendarList()

Returns the calendars on the user's calendar list.


    public
                listCalendarList([array<string|int, mixed> $optParams = array() ]) : Google_Service_Calendar_CalendarList

(calendarList.listCalendarList)

Parameters

$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Calendar_CalendarList —

patch()

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


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

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_CalendarListEntry
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Calendar_CalendarListEntry —

update()

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


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

(calendarList.update)

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_CalendarListEntry
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Calendar_CalendarListEntry —

watch()

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


    public
                watch(Google_Service_Calendar_Channel $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Calendar_Channel

Parameters

$postBody : Google_Service_Calendar_Channel
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Calendar_Channel —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —