Google_CalendarListServiceResource

The "calendarList" collection of methods.

Defined (1)

The class is defined in the following location(s).

/inc/google-api-php-client/src/contrib/Google_CalendarService.php  
  1. class Google_CalendarListServiceResource extends Google_ServiceResource { 
  2.  
  3.  
  4. /** 
  5. * Adds an entry to the user's calendar list. (calendarList.insert) 
  6. * @param Google_CalendarListEntry $postBody 
  7. * @param array $optParams Optional parameters. 
  8. * @opt_param bool colorRgbFormat Whether to use the 'frontendColor' and 'backgroundColor' fields to write the calendar colors (RGB). If this feature is used, the index-based 'color' field will be set to the best matching option automatically. Optional. The default is False. 
  9. * @return Google_CalendarListEntry 
  10. */ 
  11. public function insert(Google_CalendarListEntry $postBody, $optParams = array()) { 
  12. $params = array('postBody' => $postBody); 
  13. $params = array_merge($params, $optParams); 
  14. $data = $this->__call('insert', array($params)); 
  15. if ($this->useObjects()) { 
  16. return new Google_CalendarListEntry($data); 
  17. } else { 
  18. return $data; 
  19. /** 
  20. * Returns an entry on the user's calendar list. (calendarList.get) 
  21. * @param string $calendarId Calendar identifier. 
  22. * @param array $optParams Optional parameters. 
  23. * @return Google_CalendarListEntry 
  24. */ 
  25. public function get($calendarId, $optParams = array()) { 
  26. $params = array('calendarId' => $calendarId); 
  27. $params = array_merge($params, $optParams); 
  28. $data = $this->__call('get', array($params)); 
  29. if ($this->useObjects()) { 
  30. return new Google_CalendarListEntry($data); 
  31. } else { 
  32. return $data; 
  33. /** 
  34. * Returns entries on the user's calendar list. (calendarList.list) 
  35. * @param array $optParams Optional parameters. 
  36. * @opt_param string pageToken Token specifying which result page to return. Optional. 
  37. * @opt_param bool showHidden Whether to show hidden entries. Optional. The default is False. 
  38. * @opt_param int maxResults Maximum number of entries returned on one result page. Optional. 
  39. * @opt_param string minAccessRole The minimum access role for the user in the returned entires. Optional. The default is no restriction. 
  40. * @return Google_CalendarList 
  41. */ 
  42. public function listCalendarList($optParams = array()) { 
  43. $params = array(); 
  44. $params = array_merge($params, $optParams); 
  45. $data = $this->__call('list', array($params)); 
  46. if ($this->useObjects()) { 
  47. return new Google_CalendarList($data); 
  48. } else { 
  49. return $data; 
  50. /** 
  51. * Updates an entry on the user's calendar list. (calendarList.update) 
  52. * @param string $calendarId Calendar identifier. 
  53. * @param Google_CalendarListEntry $postBody 
  54. * @param array $optParams Optional parameters. 
  55. * @opt_param bool colorRgbFormat Whether to use the 'frontendColor' and 'backgroundColor' fields to write the calendar colors (RGB). If this feature is used, the index-based 'color' field will be set to the best matching option automatically. Optional. The default is False. 
  56. * @return Google_CalendarListEntry 
  57. */ 
  58. public function update($calendarId, Google_CalendarListEntry $postBody, $optParams = array()) { 
  59. $params = array('calendarId' => $calendarId, 'postBody' => $postBody); 
  60. $params = array_merge($params, $optParams); 
  61. $data = $this->__call('update', array($params)); 
  62. if ($this->useObjects()) { 
  63. return new Google_CalendarListEntry($data); 
  64. } else { 
  65. return $data; 
  66. /** 
  67. * Updates an entry on the user's calendar list. This method supports patch semantics. 
  68. * (calendarList.patch) 
  69. * @param string $calendarId Calendar identifier. 
  70. * @param Google_CalendarListEntry $postBody 
  71. * @param array $optParams Optional parameters. 
  72. * @opt_param bool colorRgbFormat Whether to use the 'frontendColor' and 'backgroundColor' fields to write the calendar colors (RGB). If this feature is used, the index-based 'color' field will be set to the best matching option automatically. Optional. The default is False. 
  73. * @return Google_CalendarListEntry 
  74. */ 
  75. public function patch($calendarId, Google_CalendarListEntry $postBody, $optParams = array()) { 
  76. $params = array('calendarId' => $calendarId, 'postBody' => $postBody); 
  77. $params = array_merge($params, $optParams); 
  78. $data = $this->__call('patch', array($params)); 
  79. if ($this->useObjects()) { 
  80. return new Google_CalendarListEntry($data); 
  81. } else { 
  82. return $data; 
  83. /** 
  84. * Deletes an entry on the user's calendar list. (calendarList.delete) 
  85. * @param string $calendarId Calendar identifier. 
  86. * @param array $optParams Optional parameters. 
  87. */ 
  88. public function delete($calendarId, $optParams = array()) { 
  89. $params = array('calendarId' => $calendarId); 
  90. $params = array_merge($params, $optParams); 
  91. $data = $this->__call('delete', array($params)); 
  92. return $data;