/lib/google/src/Google/Service/Calendar.php
PHP | 3890 lines | 2939 code | 158 blank | 793 comment | 0 complexity | 90ef837be4c5f4a543881ccf004852e3 MD5 | raw file
Possible License(s): MIT, AGPL-3.0, MPL-2.0-no-copyleft-exception, LGPL-3.0, GPL-3.0, Apache-2.0, LGPL-2.1, BSD-3-Clause
Large files files are truncated, but you can click here to view the full file
- <?php
- /*
- * Copyright 2010 Google Inc.
- *
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License. You may obtain a copy of
- * the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- * License for the specific language governing permissions and limitations under
- * the License.
- */
- /**
- * Service definition for Calendar (v3).
- *
- * <p>
- * Lets you manipulate events and other calendar data.</p>
- *
- * <p>
- * For more information about this service, see the API
- * <a href="https://developers.google.com/google-apps/calendar/firstapp" target="_blank">Documentation</a>
- * </p>
- *
- * @author Google, Inc.
- */
- class Google_Service_Calendar extends Google_Service
- {
- /** Manage your calendars. */
- const CALENDAR =
- "https://www.googleapis.com/auth/calendar";
- /** View your calendars. */
- const CALENDAR_READONLY =
- "https://www.googleapis.com/auth/calendar.readonly";
- public $acl;
- public $calendarList;
- public $calendars;
- public $channels;
- public $colors;
- public $events;
- public $freebusy;
- public $settings;
-
- /**
- * Constructs the internal representation of the Calendar service.
- *
- * @param Google_Client $client
- */
- public function __construct(Google_Client $client)
- {
- parent::__construct($client);
- $this->rootUrl = 'https://www.googleapis.com/';
- $this->servicePath = 'calendar/v3/';
- $this->version = 'v3';
- $this->serviceName = 'calendar';
- $this->acl = new Google_Service_Calendar_Acl_Resource(
- $this,
- $this->serviceName,
- 'acl',
- array(
- 'methods' => array(
- 'delete' => array(
- 'path' => 'calendars/{calendarId}/acl/{ruleId}',
- 'httpMethod' => 'DELETE',
- 'parameters' => array(
- 'calendarId' => array(
- 'location' => 'path',
- 'type' => 'string',
- 'required' => true,
- ),
- 'ruleId' => array(
- 'location' => 'path',
- 'type' => 'string',
- 'required' => true,
- ),
- ),
- ),'get' => array(
- 'path' => 'calendars/{calendarId}/acl/{ruleId}',
- 'httpMethod' => 'GET',
- 'parameters' => array(
- 'calendarId' => array(
- 'location' => 'path',
- 'type' => 'string',
- 'required' => true,
- ),
- 'ruleId' => array(
- 'location' => 'path',
- 'type' => 'string',
- 'required' => true,
- ),
- ),
- ),'insert' => array(
- 'path' => 'calendars/{calendarId}/acl',
- 'httpMethod' => 'POST',
- 'parameters' => array(
- 'calendarId' => array(
- 'location' => 'path',
- 'type' => 'string',
- 'required' => true,
- ),
- ),
- ),'list' => array(
- 'path' => 'calendars/{calendarId}/acl',
- 'httpMethod' => 'GET',
- 'parameters' => array(
- 'calendarId' => array(
- 'location' => 'path',
- 'type' => 'string',
- 'required' => true,
- ),
- 'pageToken' => array(
- 'location' => 'query',
- 'type' => 'string',
- ),
- 'syncToken' => array(
- 'location' => 'query',
- 'type' => 'string',
- ),
- 'maxResults' => array(
- 'location' => 'query',
- 'type' => 'integer',
- ),
- 'showDeleted' => array(
- 'location' => 'query',
- 'type' => 'boolean',
- ),
- ),
- ),'patch' => array(
- 'path' => 'calendars/{calendarId}/acl/{ruleId}',
- 'httpMethod' => 'PATCH',
- 'parameters' => array(
- 'calendarId' => array(
- 'location' => 'path',
- 'type' => 'string',
- 'required' => true,
- ),
- 'ruleId' => array(
- 'location' => 'path',
- 'type' => 'string',
- 'required' => true,
- ),
- ),
- ),'update' => array(
- 'path' => 'calendars/{calendarId}/acl/{ruleId}',
- 'httpMethod' => 'PUT',
- 'parameters' => array(
- 'calendarId' => array(
- 'location' => 'path',
- 'type' => 'string',
- 'required' => true,
- ),
- 'ruleId' => array(
- 'location' => 'path',
- 'type' => 'string',
- 'required' => true,
- ),
- ),
- ),'watch' => array(
- 'path' => 'calendars/{calendarId}/acl/watch',
- 'httpMethod' => 'POST',
- 'parameters' => array(
- 'calendarId' => array(
- 'location' => 'path',
- 'type' => 'string',
- 'required' => true,
- ),
- 'pageToken' => array(
- 'location' => 'query',
- 'type' => 'string',
- ),
- 'syncToken' => array(
- 'location' => 'query',
- 'type' => 'string',
- ),
- 'maxResults' => array(
- 'location' => 'query',
- 'type' => 'integer',
- ),
- 'showDeleted' => array(
- 'location' => 'query',
- 'type' => 'boolean',
- ),
- ),
- ),
- )
- )
- );
- $this->calendarList = new Google_Service_Calendar_CalendarList_Resource(
- $this,
- $this->serviceName,
- 'calendarList',
- array(
- 'methods' => array(
- 'delete' => array(
- 'path' => 'users/me/calendarList/{calendarId}',
- 'httpMethod' => 'DELETE',
- 'parameters' => array(
- 'calendarId' => array(
- 'location' => 'path',
- 'type' => 'string',
- 'required' => true,
- ),
- ),
- ),'get' => array(
- 'path' => 'users/me/calendarList/{calendarId}',
- 'httpMethod' => 'GET',
- 'parameters' => array(
- 'calendarId' => array(
- 'location' => 'path',
- 'type' => 'string',
- 'required' => true,
- ),
- ),
- ),'insert' => array(
- 'path' => 'users/me/calendarList',
- 'httpMethod' => 'POST',
- 'parameters' => array(
- 'colorRgbFormat' => array(
- 'location' => 'query',
- 'type' => 'boolean',
- ),
- ),
- ),'list' => array(
- 'path' => 'users/me/calendarList',
- 'httpMethod' => 'GET',
- 'parameters' => array(
- 'syncToken' => array(
- 'location' => 'query',
- 'type' => 'string',
- ),
- 'showDeleted' => array(
- 'location' => 'query',
- 'type' => 'boolean',
- ),
- 'minAccessRole' => array(
- 'location' => 'query',
- 'type' => 'string',
- ),
- 'maxResults' => array(
- 'location' => 'query',
- 'type' => 'integer',
- ),
- 'pageToken' => array(
- 'location' => 'query',
- 'type' => 'string',
- ),
- 'showHidden' => array(
- 'location' => 'query',
- 'type' => 'boolean',
- ),
- ),
- ),'patch' => array(
- 'path' => 'users/me/calendarList/{calendarId}',
- 'httpMethod' => 'PATCH',
- 'parameters' => array(
- 'calendarId' => array(
- 'location' => 'path',
- 'type' => 'string',
- 'required' => true,
- ),
- 'colorRgbFormat' => array(
- 'location' => 'query',
- 'type' => 'boolean',
- ),
- ),
- ),'update' => array(
- 'path' => 'users/me/calendarList/{calendarId}',
- 'httpMethod' => 'PUT',
- 'parameters' => array(
- 'calendarId' => array(
- 'location' => 'path',
- 'type' => 'string',
- 'required' => true,
- ),
- 'colorRgbFormat' => array(
- 'location' => 'query',
- 'type' => 'boolean',
- ),
- ),
- ),'watch' => array(
- 'path' => 'users/me/calendarList/watch',
- 'httpMethod' => 'POST',
- 'parameters' => array(
- 'syncToken' => array(
- 'location' => 'query',
- 'type' => 'string',
- ),
- 'showDeleted' => array(
- 'location' => 'query',
- 'type' => 'boolean',
- ),
- 'minAccessRole' => array(
- 'location' => 'query',
- 'type' => 'string',
- ),
- 'maxResults' => array(
- 'location' => 'query',
- 'type' => 'integer',
- ),
- 'pageToken' => array(
- 'location' => 'query',
- 'type' => 'string',
- ),
- 'showHidden' => array(
- 'location' => 'query',
- 'type' => 'boolean',
- ),
- ),
- ),
- )
- )
- );
- $this->calendars = new Google_Service_Calendar_Calendars_Resource(
- $this,
- $this->serviceName,
- 'calendars',
- array(
- 'methods' => array(
- 'clear' => array(
- 'path' => 'calendars/{calendarId}/clear',
- 'httpMethod' => 'POST',
- 'parameters' => array(
- 'calendarId' => array(
- 'location' => 'path',
- 'type' => 'string',
- 'required' => true,
- ),
- ),
- ),'delete' => array(
- 'path' => 'calendars/{calendarId}',
- 'httpMethod' => 'DELETE',
- 'parameters' => array(
- 'calendarId' => array(
- 'location' => 'path',
- 'type' => 'string',
- 'required' => true,
- ),
- ),
- ),'get' => array(
- 'path' => 'calendars/{calendarId}',
- 'httpMethod' => 'GET',
- 'parameters' => array(
- 'calendarId' => array(
- 'location' => 'path',
- 'type' => 'string',
- 'required' => true,
- ),
- ),
- ),'insert' => array(
- 'path' => 'calendars',
- 'httpMethod' => 'POST',
- 'parameters' => array(),
- ),'patch' => array(
- 'path' => 'calendars/{calendarId}',
- 'httpMethod' => 'PATCH',
- 'parameters' => array(
- 'calendarId' => array(
- 'location' => 'path',
- 'type' => 'string',
- 'required' => true,
- ),
- ),
- ),'update' => array(
- 'path' => 'calendars/{calendarId}',
- 'httpMethod' => 'PUT',
- 'parameters' => array(
- 'calendarId' => array(
- 'location' => 'path',
- 'type' => 'string',
- 'required' => true,
- ),
- ),
- ),
- )
- )
- );
- $this->channels = new Google_Service_Calendar_Channels_Resource(
- $this,
- $this->serviceName,
- 'channels',
- array(
- 'methods' => array(
- 'stop' => array(
- 'path' => 'channels/stop',
- 'httpMethod' => 'POST',
- 'parameters' => array(),
- ),
- )
- )
- );
- $this->colors = new Google_Service_Calendar_Colors_Resource(
- $this,
- $this->serviceName,
- 'colors',
- array(
- 'methods' => array(
- 'get' => array(
- 'path' => 'colors',
- 'httpMethod' => 'GET',
- 'parameters' => array(),
- ),
- )
- )
- );
- $this->events = new Google_Service_Calendar_Events_Resource(
- $this,
- $this->serviceName,
- 'events',
- array(
- 'methods' => array(
- 'delete' => array(
- 'path' => 'calendars/{calendarId}/events/{eventId}',
- 'httpMethod' => 'DELETE',
- 'parameters' => array(
- 'calendarId' => array(
- 'location' => 'path',
- 'type' => 'string',
- 'required' => true,
- ),
- 'eventId' => array(
- 'location' => 'path',
- 'type' => 'string',
- 'required' => true,
- ),
- 'sendNotifications' => array(
- 'location' => 'query',
- 'type' => 'boolean',
- ),
- ),
- ),'get' => array(
- 'path' => 'calendars/{calendarId}/events/{eventId}',
- 'httpMethod' => 'GET',
- 'parameters' => array(
- 'calendarId' => array(
- 'location' => 'path',
- 'type' => 'string',
- 'required' => true,
- ),
- 'eventId' => array(
- 'location' => 'path',
- 'type' => 'string',
- 'required' => true,
- ),
- 'timeZone' => array(
- 'location' => 'query',
- 'type' => 'string',
- ),
- 'alwaysIncludeEmail' => array(
- 'location' => 'query',
- 'type' => 'boolean',
- ),
- 'maxAttendees' => array(
- 'location' => 'query',
- 'type' => 'integer',
- ),
- ),
- ),'import' => array(
- 'path' => 'calendars/{calendarId}/events/import',
- 'httpMethod' => 'POST',
- 'parameters' => array(
- 'calendarId' => array(
- 'location' => 'path',
- 'type' => 'string',
- 'required' => true,
- ),
- 'supportsAttachments' => array(
- 'location' => 'query',
- 'type' => 'boolean',
- ),
- ),
- ),'insert' => array(
- 'path' => 'calendars/{calendarId}/events',
- 'httpMethod' => 'POST',
- 'parameters' => array(
- 'calendarId' => array(
- 'location' => 'path',
- 'type' => 'string',
- 'required' => true,
- ),
- 'supportsAttachments' => array(
- 'location' => 'query',
- 'type' => 'boolean',
- ),
- 'sendNotifications' => array(
- 'location' => 'query',
- 'type' => 'boolean',
- ),
- 'maxAttendees' => array(
- 'location' => 'query',
- 'type' => 'integer',
- ),
- ),
- ),'instances' => array(
- 'path' => 'calendars/{calendarId}/events/{eventId}/instances',
- 'httpMethod' => 'GET',
- 'parameters' => array(
- 'calendarId' => array(
- 'location' => 'path',
- 'type' => 'string',
- 'required' => true,
- ),
- 'eventId' => array(
- 'location' => 'path',
- 'type' => 'string',
- 'required' => true,
- ),
- 'showDeleted' => array(
- 'location' => 'query',
- 'type' => 'boolean',
- ),
- 'timeMax' => array(
- 'location' => 'query',
- 'type' => 'string',
- ),
- 'alwaysIncludeEmail' => array(
- 'location' => 'query',
- 'type' => 'boolean',
- ),
- 'maxResults' => array(
- 'location' => 'query',
- 'type' => 'integer',
- ),
- 'pageToken' => array(
- 'location' => 'query',
- 'type' => 'string',
- ),
- 'timeMin' => array(
- 'location' => 'query',
- 'type' => 'string',
- ),
- 'timeZone' => array(
- 'location' => 'query',
- 'type' => 'string',
- ),
- 'originalStart' => array(
- 'location' => 'query',
- 'type' => 'string',
- ),
- 'maxAttendees' => array(
- 'location' => 'query',
- 'type' => 'integer',
- ),
- ),
- ),'list' => array(
- 'path' => 'calendars/{calendarId}/events',
- 'httpMethod' => 'GET',
- 'parameters' => array(
- 'calendarId' => array(
- 'location' => 'path',
- 'type' => 'string',
- 'required' => true,
- ),
- 'orderBy' => array(
- 'location' => 'query',
- 'type' => 'string',
- ),
- 'showHiddenInvitations' => array(
- 'location' => 'query',
- 'type' => 'boolean',
- ),
- 'syncToken' => array(
- 'location' => 'query',
- 'type' => 'string',
- ),
- 'showDeleted' => array(
- 'location' => 'query',
- 'type' => 'boolean',
- ),
- 'iCalUID' => array(
- 'location' => 'query',
- 'type' => 'string',
- ),
- 'updatedMin' => array(
- 'location' => 'query',
- 'type' => 'string',
- ),
- 'singleEvents' => array(
- 'location' => 'query',
- 'type' => 'boolean',
- ),
- 'timeMax' => array(
- 'location' => 'query',
- 'type' => 'string',
- ),
- 'alwaysIncludeEmail' => array(
- 'location' => 'query',
- 'type' => 'boolean',
- ),
- 'maxResults' => array(
- 'location' => 'query',
- 'type' => 'integer',
- ),
- 'q' => array(
- 'location' => 'query',
- 'type' => 'string',
- ),
- 'pageToken' => array(
- 'location' => 'query',
- 'type' => 'string',
- ),
- 'timeMin' => array(
- 'location' => 'query',
- 'type' => 'string',
- ),
- 'timeZone' => array(
- 'location' => 'query',
- 'type' => 'string',
- ),
- 'privateExtendedProperty' => array(
- 'location' => 'query',
- 'type' => 'string',
- 'repeated' => true,
- ),
- 'sharedExtendedProperty' => array(
- 'location' => 'query',
- 'type' => 'string',
- 'repeated' => true,
- ),
- 'maxAttendees' => array(
- 'location' => 'query',
- 'type' => 'integer',
- ),
- ),
- ),'move' => array(
- 'path' => 'calendars/{calendarId}/events/{eventId}/move',
- 'httpMethod' => 'POST',
- 'parameters' => array(
- 'calendarId' => array(
- 'location' => 'path',
- 'type' => 'string',
- 'required' => true,
- ),
- 'eventId' => array(
- 'location' => 'path',
- 'type' => 'string',
- 'required' => true,
- ),
- 'destination' => array(
- 'location' => 'query',
- 'type' => 'string',
- 'required' => true,
- ),
- 'sendNotifications' => array(
- 'location' => 'query',
- 'type' => 'boolean',
- ),
- ),
- ),'patch' => array(
- 'path' => 'calendars/{calendarId}/events/{eventId}',
- 'httpMethod' => 'PATCH',
- 'parameters' => array(
- 'calendarId' => array(
- 'location' => 'path',
- 'type' => 'string',
- 'required' => true,
- ),
- 'eventId' => array(
- 'location' => 'path',
- 'type' => 'string',
- 'required' => true,
- ),
- 'sendNotifications' => array(
- 'location' => 'query',
- 'type' => 'boolean',
- ),
- 'alwaysIncludeEmail' => array(
- 'location' => 'query',
- 'type' => 'boolean',
- ),
- 'supportsAttachments' => array(
- 'location' => 'query',
- 'type' => 'boolean',
- ),
- 'maxAttendees' => array(
- 'location' => 'query',
- 'type' => 'integer',
- ),
- ),
- ),'quickAdd' => array(
- 'path' => 'calendars/{calendarId}/events/quickAdd',
- 'httpMethod' => 'POST',
- 'parameters' => array(
- 'calendarId' => array(
- 'location' => 'path',
- 'type' => 'string',
- 'required' => true,
- ),
- 'text' => array(
- 'location' => 'query',
- 'type' => 'string',
- 'required' => true,
- ),
- 'sendNotifications' => array(
- 'location' => 'query',
- 'type' => 'boolean',
- ),
- ),
- ),'update' => array(
- 'path' => 'calendars/{calendarId}/events/{eventId}',
- 'httpMethod' => 'PUT',
- 'parameters' => array(
- 'calendarId' => array(
- 'location' => 'path',
- 'type' => 'string',
- 'required' => true,
- ),
- 'eventId' => array(
- 'location' => 'path',
- 'type' => 'string',
- 'required' => true,
- ),
- 'sendNotifications' => array(
- 'location' => 'query',
- 'type' => 'boolean',
- ),
- 'alwaysIncludeEmail' => array(
- 'location' => 'query',
- 'type' => 'boolean',
- ),
- 'supportsAttachments' => array(
- 'location' => 'query',
- 'type' => 'boolean',
- ),
- 'maxAttendees' => array(
- 'location' => 'query',
- 'type' => 'integer',
- ),
- ),
- ),'watch' => array(
- 'path' => 'calendars/{calendarId}/events/watch',
- 'httpMethod' => 'POST',
- 'parameters' => array(
- 'calendarId' => array(
- 'location' => 'path',
- 'type' => 'string',
- 'required' => true,
- ),
- 'orderBy' => array(
- 'location' => 'query',
- 'type' => 'string',
- ),
- 'showHiddenInvitations' => array(
- 'location' => 'query',
- 'type' => 'boolean',
- ),
- 'syncToken' => array(
- 'location' => 'query',
- 'type' => 'string',
- ),
- 'showDeleted' => array(
- 'location' => 'query',
- 'type' => 'boolean',
- ),
- 'iCalUID' => array(
- 'location' => 'query',
- 'type' => 'string',
- ),
- 'updatedMin' => array(
- 'location' => 'query',
- 'type' => 'string',
- ),
- 'singleEvents' => array(
- 'location' => 'query',
- 'type' => 'boolean',
- ),
- 'timeMax' => array(
- 'location' => 'query',
- 'type' => 'string',
- ),
- 'alwaysIncludeEmail' => array(
- 'location' => 'query',
- 'type' => 'boolean',
- ),
- 'maxResults' => array(
- 'location' => 'query',
- 'type' => 'integer',
- ),
- 'q' => array(
- 'location' => 'query',
- 'type' => 'string',
- ),
- 'pageToken' => array(
- 'location' => 'query',
- 'type' => 'string',
- ),
- 'timeMin' => array(
- 'location' => 'query',
- 'type' => 'string',
- ),
- 'timeZone' => array(
- 'location' => 'query',
- 'type' => 'string',
- ),
- 'privateExtendedProperty' => array(
- 'location' => 'query',
- 'type' => 'string',
- 'repeated' => true,
- ),
- 'sharedExtendedProperty' => array(
- 'location' => 'query',
- 'type' => 'string',
- 'repeated' => true,
- ),
- 'maxAttendees' => array(
- 'location' => 'query',
- 'type' => 'integer',
- ),
- ),
- ),
- )
- )
- );
- $this->freebusy = new Google_Service_Calendar_Freebusy_Resource(
- $this,
- $this->serviceName,
- 'freebusy',
- array(
- 'methods' => array(
- 'query' => array(
- 'path' => 'freeBusy',
- 'httpMethod' => 'POST',
- 'parameters' => array(),
- ),
- )
- )
- );
- $this->settings = new Google_Service_Calendar_Settings_Resource(
- $this,
- $this->serviceName,
- 'settings',
- array(
- 'methods' => array(
- 'get' => array(
- 'path' => 'users/me/settings/{setting}',
- 'httpMethod' => 'GET',
- 'parameters' => array(
- 'setting' => array(
- 'location' => 'path',
- 'type' => 'string',
- 'required' => true,
- ),
- ),
- ),'list' => array(
- 'path' => 'users/me/settings',
- 'httpMethod' => 'GET',
- 'parameters' => array(
- 'pageToken' => array(
- 'location' => 'query',
- 'type' => 'string',
- ),
- 'maxResults' => array(
- 'location' => 'query',
- 'type' => 'integer',
- ),
- 'syncToken' => array(
- 'location' => 'query',
- 'type' => 'string',
- ),
- ),
- ),'watch' => array(
- 'path' => 'users/me/settings/watch',
- 'httpMethod' => 'POST',
- 'parameters' => array(
- 'pageToken' => array(
- 'location' => 'query',
- 'type' => 'string',
- ),
- 'maxResults' => array(
- 'location' => 'query',
- 'type' => 'integer',
- ),
- 'syncToken' => array(
- 'location' => 'query',
- 'type' => 'string',
- ),
- ),
- ),
- )
- )
- );
- }
- }
- /**
- * The "acl" collection of methods.
- * Typical usage is:
- * <code>
- * $calendarService = new Google_Service_Calendar(...);
- * $acl = $calendarService->acl;
- * </code>
- */
- class Google_Service_Calendar_Acl_Resource extends Google_Service_Resource
- {
- /**
- * Deletes an access control rule. (acl.delete)
- *
- * @param 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.
- * @param string $ruleId ACL rule identifier.
- * @param array $optParams Optional parameters.
- */
- public function delete($calendarId, $ruleId, $optParams = array())
- {
- $params = array('calendarId' => $calendarId, 'ruleId' => $ruleId);
- $params = array_merge($params, $optParams);
- return $this->call('delete', array($params));
- }
- /**
- * Returns an access control rule. (acl.get)
- *
- * @param 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.
- * @param string $ruleId ACL rule identifier.
- * @param array $optParams Optional parameters.
- * @return Google_Service_Calendar_AclRule
- */
- public function get($calendarId, $ruleId, $optParams = array())
- {
- $params = array('calendarId' => $calendarId, 'ruleId' => $ruleId);
- $params = array_merge($params, $optParams);
- return $this->call('get', array($params), "Google_Service_Calendar_AclRule");
- }
- /**
- * Creates an access control rule. (acl.insert)
- *
- * @param 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.
- * @param Google_AclRule $postBody
- * @param array $optParams Optional parameters.
- * @return Google_Service_Calendar_AclRule
- */
- public function insert($calendarId, Google_Service_Calendar_AclRule $postBody, $optParams = array())
- {
- $params = array('calendarId' => $calendarId, 'postBody' => $postBody);
- $params = array_merge($params, $optParams);
- return $this->call('insert', array($params), "Google_Service_Calendar_AclRule");
- }
- /**
- * Returns the rules in the access control list for the calendar. (acl.listAcl)
- *
- * @param 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.
- * @param array $optParams Optional parameters.
- *
- * @opt_param string pageToken Token specifying which result page to return.
- * Optional.
- * @opt_param 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. All entries deleted since the previous list request will always be in
- * the result set and it is not allowed to set showDeleted to False. 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.
- * @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.
- * @opt_param bool showDeleted Whether to include deleted ACLs in the result.
- * Deleted ACLs are represented by role equal to "none". Deleted ACLs will
- * always be included if syncToken is provided. Optional. The default is False.
- * @return Google_Service_Calendar_Acl
- */
- public function listAcl($calendarId, $optParams = array())
- {
- $params = array('calendarId' => $calendarId);
- $params = array_merge($params, $optParams);
- return $this->call('list', array($params), "Google_Service_Calendar_Acl");
- }
- /**
- * Updates an access control rule. This method supports patch semantics.
- * (acl.patch)
- *
- * @param 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.
- * @param string $ruleId ACL rule identifier.
- * @param Google_AclRule $postBody
- * @param array $optParams Optional parameters.
- * @return Google_Service_Calendar_AclRule
- */
- public function patch($calendarId, $ruleId, Google_Service_Calendar_AclRule $postBody, $optParams = array())
- {
- $params = array('calendarId' => $calendarId, 'ruleId' => $ruleId, 'postBody' => $postBody);
- $params = array_merge($params, $optParams);
- return $this->call('patch', array($params), "Google_Service_Calendar_AclRule");
- }
- /**
- * Updates an access control rule. (acl.update)
- *
- * @param 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.
- * @param string $ruleId ACL rule identifier.
- * @param Google_AclRule $postBody
- * @param array $optParams Optional parameters.
- * @return Google_Service_Calendar_AclRule
- */
- public function update($calendarId, $ruleId, Google_Service_Calendar_AclRule $postBody, $optParams = array())
- {
- $params = array('calendarId' => $calendarId, 'ruleId' => $ruleId, 'postBody' => $postBody);
- $params = array_merge($params, $optParams);
- return $this->call('update', array($params), "Google_Service_Calendar_AclRule");
- }
- /**
- * Watch for changes to ACL resources. (acl.watch)
- *
- * @param 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.
- * @param Google_Channel $postBody
- * @param array $optParams Optional parameters.
- *
- * @opt_param string pageToken Token specifying which result page to return.
- * Optional.
- * @opt_param 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. All entries deleted since the previous list request will always be in
- * the result set and it is not allowed to set showDeleted to False. 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.
- * @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.
- * @opt_param bool showDeleted Whether to include deleted ACLs in the result.
- * Deleted ACLs are represented by role equal to "none". Deleted ACLs will
- * always be included if syncToken is provided. Optional. The default is False.
- * @return Google_Service_Calendar_Channel
- */
- public function watch($calendarId, Google_Service_Calendar_Channel $postBody, $optParams = array())
- {
- $params = array('calendarId' => $calendarId, 'postBody' => $postBody);
- $params = array_merge($params, $optParams);
- return $this->call('watch', array($params), "Google_Service_Calendar_Channel");
- }
- }
- /**
- * The "calendarList" collection of methods.
- * Typical usage is:
- * <code>
- * $calendarService = new Google_Service_Calendar(...);
- * $calendarList = $calendarService->calendarList;
- * </code>
- */
- class Google_Service_Calendar_CalendarList_Resource extends Google_Service_Resource
- {
- /**
- * Deletes an entry on the user's calendar list. (calendarList.delete)
- *
- * @param 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.
- * @param array $optParams Optional parameters.
- */
- public function delete($calendarId, $optParams = array())
- {
- $params = array('calendarId' => $calendarId);
- $params = array_merge($params, $optParams);
- return $this->call('delete', array($params));
- }
- /**
- * Returns an entry on the user's calendar list. (calendarList.get)
- *
- * @param 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.
- * @param array $optParams Optional parameters.
- * @return Google_Service_Calendar_CalendarListEntry
- */
- public function get($calendarId, $optParams = array())
- {
- $params = array('calendarId' => $calendarId);
- $params = array_merge($params, $optParams);
- return $this->call('get', array($params), "Google_Service_Calendar_CalendarListEntry");
- }
- /**
- * Adds an entry to the user's calendar list. (calendarList.insert)
- *
- * @param Google_CalendarListEntry $postBody
- * @param array $optParams Optional parameters.
- *
- * @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.
- * @return Google_Service_Calendar_CalendarListEntry
- */
- public function insert(Google_Service_Calendar_CalendarListEntry $postBody, $optParams = array())
- {
- $params = array('postBody' => $postBody);
- $params = array_merge($params, $optParams);
- return $this->call('insert', array($params), "Google_Service_Calendar_CalendarListEntry");
- }
- /**
- * Returns entries on the user's calendar list. (calendarList.listCalendarList)
- *
- * @param array $optParams Optional parameters.
- *
- * @opt_param 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.
- * @opt_param bool showDeleted Whether to include deleted calendar list entries
- * in the result. Optional. The default is False.
- * @opt_param string minAccessRole The minimum access role for the user in the
- * returned entries. Optional. The default is no restriction.
- * @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.
- * @opt_param string pageToken Token specifying which result page to return.
- * Optional.
- * @opt_param bool showHidden Whether to show hidden entries. Optional. The
- * default is False.
- * @return Google_Service_Calendar_CalendarList
- */
- public function listCalendarList($optParams = array())
- {
- $params = array();
- $params = array_merge($params, $optParams);
- return $this->call('list', array($params), "Google_Service_Calendar_CalendarList");
- }
- /**
- * Updates an entry on the user's calendar list. This method supports patch
- * semantics. (calendarList.patch)
- *
- * @param 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.
- * @param Google_CalendarListEntry $postBody
- * @param array $optParams Optional parameters.
- *
- * @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.
- * @return Google_Service_Calendar_CalendarListEntry
- */
- public function patch($calendarId, Google_Service_Calendar_CalendarListEntry $postBody, $optParams = array())
- {
- $params = array('calendarId' => $calendarId, 'postBody' => $postBody);
- $params = array_merge($params, $optParams);
- return $this->call('patch', array($params), "Google_Service_Calendar_CalendarListEntry");
- }
- /**
- * Updates an entry on the user's calendar list. (calendarList.update)
- *
- * @param 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.
- * @param Google_CalendarListEntry $postBody
- * @param array $optParams Optional parameters.
- *
- * @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.
- * @return Google_Service_Calendar_CalendarListEntry
- */
- public function update($calendarId, Google_Service_Calendar_CalendarListEntry $postBody, $optParams = array())
- {
- $params = array('calendarId' => $calendarId, 'postBody' => $postBody);
- $params = array_merge($params, $optParams);
- return $this->call('update', array($params), "Google_Service_Calendar_CalendarListEntry");
- }
- /**
- * Watch for changes to CalendarList resources. (calendarList.watch)
- *
- * @param Google_Channel $postBody
- * @param array $optParams Optional parameters.
- *
- * @opt_param 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.
- * @opt_param bool showDeleted Whether to include deleted calendar list entries
- * in the result. Optional. The default is False.
- * @opt_param string minAccessRole The minimum access role for the user in the
- * returned entries. Optional. The default is no restriction.
- * @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.
- * @opt_param string pageToken Token specifying which result page to return.
- * Optional.
- * @opt_param bool showHidden Whether to show hidden entries. Optional. The
- * default is False.
- * @return Google_Service_Calendar_Channel
- */
- public function watch(Google_Service_Calendar_Channel $postBody, $optParams = array())
- {
- $params = array('postBody' => $postBody);
- $params = array_merge($params, $optParams);
- return $this->call('watch', array($params), "Google_Service_Calendar_Channel");
- }
- }
- /**
- * The "calendars" collection of methods.
- * Typical usage is:
- * <code>
- * $calendarService = new Google_Service_Calendar(...);
- * $calendars = $calendarService->calendars;
- * </code>
- */
- class Google_Service_Calendar_Calendars_Resource extends Google_Service_Resource
- {
- /**
- * Clears a primary calendar. This operation deletes all events associated with
- * the primary calendar of an account. (calendars.clear)
- *
- * @param 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.
- * @param array $optParams Optional parameters.
- */
- public function clear($calendarId, $optParams = array())
- {
- $params = array('calendarId' => $calendarId);
- $params = array_merge($params, $optParams);
- return $this->call('clear', array($params));
- }
- /**
- * Deletes a secondary calendar. Use calendars.clear for clearing all events on
- * primary calendars. (calendars.delete)
- *
- * @param 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.
- * @param array $optParams Optional parameters.
- */
- public function delete($calendarId, $optParams = array())
- {
- $params = array('calendarId' => $calendarId);
- $params = array_merge($params, $optParams);
- return $this->call('delete', array($params));
- }
- /**
- * Returns metadata for a calendar. (calendars.get)
- *
- * @param 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.
- * @param array $optParams Optional parameters.
- * @return Google_Service_Calendar_Calendar
- */
- public function get($calendarId, $optParams = array())
- {
- $params = array('calendarId' => $calendarId);
- $params = array_merge($params, $optParams);
- return $this->call('get', array($params), "Google_Service_Calendar_Calendar");
- }
- /**
- * Creates a secondary calendar. (calendars.insert)
- *
- * @param Google_Calendar $postBody
- * @param array $optParams Optional parameters.
- * @return Google_Service_Calendar_Calendar
- */
- public function insert(Google_Service_Calendar_Calendar $postBody, $optParams = array())
- {
- $params = array('postBody' => $postBody);
- $params = array_merge($params, $optParams);
- return $this->call('insert', array($params), "Google_Service_Calendar_Calendar");
- }
- /**
- * Updates metadata for a calendar. This method supports patch semantics.
- * (calendars.patch)
- *
- * @param 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.
- * @param Google_Calendar $postBody
- * @param array $optParams Optional parameters.
- * @return Google_Service_Calendar_Calendar
- */
- public function patch($calendarId, Google_Service_Calendar_Calendar $postBody, $optParams = array())
- {
- $params = array('calendarId' => $calendarId, 'postBody' => $postBody);
- $params = array_merge($params, $optParams);
- return $this->call('patch', array($params), "Google_Service_Calendar_Calendar");
- }
- /**
- * Updates metadata for a calendar. (calendars.update)
- *
- * @param string $calendarId Calendar identifie…
Large files files are truncated, but you can click here to view the full file