Viewing file:  CalendarList.php (9.3 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/*
* Copyright 2014 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.
*/
/**
* The "calendarList" collection of methods.
* Typical usage is:
* <code>
* $calendarService = new Google_Service_Calendar(...);
* $calendarList = $calendarService->calendarList;
* </code>
*/
class Google_Service_Calendar_Resource_CalendarList extends Google_Service_Resource
{
/**
* Removes a calendar from 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 a calendar from 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");
}
/**
* Inserts an existing calendar into the user's calendar list.
* (calendarList.insert)
*
* @param Google_Service_Calendar_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 the calendars on the user's calendar list.
* (calendarList.listCalendarList)
*
* @param array $optParams Optional parameters.
*
* @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 minAccessRole The minimum access role for the user in the
* returned entries. Optional. The default is no restriction.
* @opt_param string pageToken Token specifying which result page to return.
* Optional.
* @opt_param bool showDeleted Whether to include deleted calendar list entries
* in the result. Optional. The default is False.
* @opt_param bool showHidden Whether to show hidden entries. Optional. The
* default is False.
* @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.
* @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 existing calendar 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_Service_Calendar_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 existing calendar 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_Service_Calendar_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_Service_Calendar_Channel $postBody
* @param array $optParams Optional parameters.
*
* @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 minAccessRole The minimum access role for the user in the
* returned entries. Optional. The default is no restriction.
* @opt_param string pageToken Token specifying which result page to return.
* Optional.
* @opt_param bool showDeleted Whether to include deleted calendar list entries
* in the result. Optional. The default is False.
* @opt_param bool showHidden Whether to show hidden entries. Optional. The
* default is False.
* @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.
* @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");
}
}
|