Acl.php
7 months ago
CalendarList.php
7 months ago
Calendars.php
7 months ago
Channels.php
7 months ago
Colors.php
7 months ago
Events.php
7 months ago
Freebusy.php
7 months ago
Settings.php
7 months ago
Events.php
538 lines
| 1 | <?php |
| 2 | /* |
| 3 | * Copyright 2014 Google Inc. |
| 4 | * |
| 5 | * Licensed under the Apache License, Version 2.0 (the "License"); you may not |
| 6 | * use this file except in compliance with the License. You may obtain a copy of |
| 7 | * the License at |
| 8 | * |
| 9 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | * |
| 11 | * Unless required by applicable law or agreed to in writing, software |
| 12 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| 13 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
| 14 | * License for the specific language governing permissions and limitations under |
| 15 | * the License. |
| 16 | */ |
| 17 | |
| 18 | namespace AmeliaVendor\Google\Service\Calendar\Resource; |
| 19 | |
| 20 | use AmeliaVendor\Google\Service\Calendar\Channel; |
| 21 | use AmeliaVendor\Google\Service\Calendar\Event; |
| 22 | use AmeliaVendor\Google\Service\Calendar\Events as EventsModel; |
| 23 | |
| 24 | /** |
| 25 | * The "events" collection of methods. |
| 26 | * Typical usage is: |
| 27 | * <code> |
| 28 | * $calendarService = new \AmeliaVendor\Google\Service\Calendar(...); |
| 29 | * $events = $calendarService->events; |
| 30 | * </code> |
| 31 | */ |
| 32 | class Events extends \AmeliaVendor\Google\Service\Resource |
| 33 | { |
| 34 | /** |
| 35 | * Deletes an event. (events.delete) |
| 36 | * |
| 37 | * @param string $calendarId Calendar identifier. To retrieve calendar IDs call |
| 38 | * the calendarList.list method. If you want to access the primary calendar of |
| 39 | * the currently logged in user, use the "primary" keyword. |
| 40 | * @param string $eventId Event identifier. |
| 41 | * @param array $optParams Optional parameters. |
| 42 | * |
| 43 | * @opt_param bool sendNotifications Deprecated. Please use sendUpdates instead. |
| 44 | * |
| 45 | * Whether to send notifications about the deletion of the event. Note that some |
| 46 | * emails might still be sent even if you set the value to false. The default is |
| 47 | * false. |
| 48 | * @opt_param string sendUpdates Guests who should receive notifications about |
| 49 | * the deletion of the event. |
| 50 | * @throws \AmeliaVendor\Google\Service\Exception |
| 51 | */ |
| 52 | public function delete($calendarId, $eventId, $optParams = []) |
| 53 | { |
| 54 | $params = ['calendarId' => $calendarId, 'eventId' => $eventId]; |
| 55 | $params = array_merge($params, $optParams); |
| 56 | return $this->call('delete', [$params]); |
| 57 | } |
| 58 | /** |
| 59 | * Returns an event based on its Google Calendar ID. To retrieve an event using |
| 60 | * its iCalendar ID, call the events.list method using the iCalUID parameter. |
| 61 | * (events.get) |
| 62 | * |
| 63 | * @param string $calendarId Calendar identifier. To retrieve calendar IDs call |
| 64 | * the calendarList.list method. If you want to access the primary calendar of |
| 65 | * the currently logged in user, use the "primary" keyword. |
| 66 | * @param string $eventId Event identifier. |
| 67 | * @param array $optParams Optional parameters. |
| 68 | * |
| 69 | * @opt_param bool alwaysIncludeEmail Deprecated and ignored. A value will |
| 70 | * always be returned in the email field for the organizer, creator and |
| 71 | * attendees, even if no real email address is available (i.e. a generated, non- |
| 72 | * working value will be provided). |
| 73 | * @opt_param int maxAttendees The maximum number of attendees to include in the |
| 74 | * response. If there are more than the specified number of attendees, only the |
| 75 | * participant is returned. Optional. |
| 76 | * @opt_param string timeZone Time zone used in the response. Optional. The |
| 77 | * default is the time zone of the calendar. |
| 78 | * @return Event |
| 79 | * @throws \AmeliaVendor\Google\Service\Exception |
| 80 | */ |
| 81 | public function get($calendarId, $eventId, $optParams = []) |
| 82 | { |
| 83 | $params = ['calendarId' => $calendarId, 'eventId' => $eventId]; |
| 84 | $params = array_merge($params, $optParams); |
| 85 | return $this->call('get', [$params], Event::class); |
| 86 | } |
| 87 | /** |
| 88 | * Imports an event. This operation is used to add a private copy of an existing |
| 89 | * event to a calendar. Only events with an eventType of default may be |
| 90 | * imported. Deprecated behavior: If a non-default event is imported, its type |
| 91 | * will be changed to default and any event-type-specific properties it may have |
| 92 | * will be dropped. (events.import) |
| 93 | * |
| 94 | * @param string $calendarId Calendar identifier. To retrieve calendar IDs call |
| 95 | * the calendarList.list method. If you want to access the primary calendar of |
| 96 | * the currently logged in user, use the "primary" keyword. |
| 97 | * @param Event $postBody |
| 98 | * @param array $optParams Optional parameters. |
| 99 | * |
| 100 | * @opt_param int conferenceDataVersion Version number of conference data |
| 101 | * supported by the API client. Version 0 assumes no conference data support and |
| 102 | * ignores conference data in the event's body. Version 1 enables support for |
| 103 | * copying of ConferenceData as well as for creating new conferences using the |
| 104 | * createRequest field of conferenceData. The default is 0. |
| 105 | * @opt_param bool supportsAttachments Whether API client performing operation |
| 106 | * supports event attachments. Optional. The default is False. |
| 107 | * @return Event |
| 108 | * @throws \AmeliaVendor\Google\Service\Exception |
| 109 | */ |
| 110 | public function import($calendarId, Event $postBody, $optParams = []) |
| 111 | { |
| 112 | $params = ['calendarId' => $calendarId, 'postBody' => $postBody]; |
| 113 | $params = array_merge($params, $optParams); |
| 114 | return $this->call('import', [$params], Event::class); |
| 115 | } |
| 116 | /** |
| 117 | * Creates an event. (events.insert) |
| 118 | * |
| 119 | * @param string $calendarId Calendar identifier. To retrieve calendar IDs call |
| 120 | * the calendarList.list method. If you want to access the primary calendar of |
| 121 | * the currently logged in user, use the "primary" keyword. |
| 122 | * @param Event $postBody |
| 123 | * @param array $optParams Optional parameters. |
| 124 | * |
| 125 | * @opt_param int conferenceDataVersion Version number of conference data |
| 126 | * supported by the API client. Version 0 assumes no conference data support and |
| 127 | * ignores conference data in the event's body. Version 1 enables support for |
| 128 | * copying of ConferenceData as well as for creating new conferences using the |
| 129 | * createRequest field of conferenceData. The default is 0. |
| 130 | * @opt_param int maxAttendees The maximum number of attendees to include in the |
| 131 | * response. If there are more than the specified number of attendees, only the |
| 132 | * participant is returned. Optional. |
| 133 | * @opt_param bool sendNotifications Deprecated. Please use sendUpdates instead. |
| 134 | * |
| 135 | * Whether to send notifications about the creation of the new event. Note that |
| 136 | * some emails might still be sent even if you set the value to false. The |
| 137 | * default is false. |
| 138 | * @opt_param string sendUpdates Whether to send notifications about the |
| 139 | * creation of the new event. Note that some emails might still be sent. The |
| 140 | * default is false. |
| 141 | * @opt_param bool supportsAttachments Whether API client performing operation |
| 142 | * supports event attachments. Optional. The default is False. |
| 143 | * @return Event |
| 144 | * @throws \AmeliaVendor\Google\Service\Exception |
| 145 | */ |
| 146 | public function insert($calendarId, Event $postBody, $optParams = []) |
| 147 | { |
| 148 | $params = ['calendarId' => $calendarId, 'postBody' => $postBody]; |
| 149 | $params = array_merge($params, $optParams); |
| 150 | return $this->call('insert', [$params], Event::class); |
| 151 | } |
| 152 | /** |
| 153 | * Returns instances of the specified recurring event. (events.instances) |
| 154 | * |
| 155 | * @param string $calendarId Calendar identifier. To retrieve calendar IDs call |
| 156 | * the calendarList.list method. If you want to access the primary calendar of |
| 157 | * the currently logged in user, use the "primary" keyword. |
| 158 | * @param string $eventId Recurring event identifier. |
| 159 | * @param array $optParams Optional parameters. |
| 160 | * |
| 161 | * @opt_param bool alwaysIncludeEmail Deprecated and ignored. A value will |
| 162 | * always be returned in the email field for the organizer, creator and |
| 163 | * attendees, even if no real email address is available (i.e. a generated, non- |
| 164 | * working value will be provided). |
| 165 | * @opt_param int maxAttendees The maximum number of attendees to include in the |
| 166 | * response. If there are more than the specified number of attendees, only the |
| 167 | * participant is returned. Optional. |
| 168 | * @opt_param int maxResults Maximum number of events returned on one result |
| 169 | * page. By default the value is 250 events. The page size can never be larger |
| 170 | * than 2500 events. Optional. |
| 171 | * @opt_param string originalStart The original start time of the instance in |
| 172 | * the result. Optional. |
| 173 | * @opt_param string pageToken Token specifying which result page to return. |
| 174 | * Optional. |
| 175 | * @opt_param bool showDeleted Whether to include deleted events (with status |
| 176 | * equals "cancelled") in the result. Cancelled instances of recurring events |
| 177 | * will still be included if singleEvents is False. Optional. The default is |
| 178 | * False. |
| 179 | * @opt_param string timeMax Upper bound (exclusive) for an event's start time |
| 180 | * to filter by. Optional. The default is not to filter by start time. Must be |
| 181 | * an RFC3339 timestamp with mandatory time zone offset. |
| 182 | * @opt_param string timeMin Lower bound (inclusive) for an event's end time to |
| 183 | * filter by. Optional. The default is not to filter by end time. Must be an |
| 184 | * RFC3339 timestamp with mandatory time zone offset. |
| 185 | * @opt_param string timeZone Time zone used in the response. Optional. The |
| 186 | * default is the time zone of the calendar. |
| 187 | * @return EventsModel |
| 188 | * @throws \AmeliaVendor\Google\Service\Exception |
| 189 | */ |
| 190 | public function instances($calendarId, $eventId, $optParams = []) |
| 191 | { |
| 192 | $params = ['calendarId' => $calendarId, 'eventId' => $eventId]; |
| 193 | $params = array_merge($params, $optParams); |
| 194 | return $this->call('instances', [$params], EventsModel::class); |
| 195 | } |
| 196 | /** |
| 197 | * Returns events on the specified calendar. (events.listEvents) |
| 198 | * |
| 199 | * @param string $calendarId Calendar identifier. To retrieve calendar IDs call |
| 200 | * the calendarList.list method. If you want to access the primary calendar of |
| 201 | * the currently logged in user, use the "primary" keyword. |
| 202 | * @param array $optParams Optional parameters. |
| 203 | * |
| 204 | * @opt_param bool alwaysIncludeEmail Deprecated and ignored. |
| 205 | * @opt_param string eventTypes Event types to return. Optional. This parameter |
| 206 | * can be repeated multiple times to return events of different types. If unset, |
| 207 | * returns all event types. |
| 208 | * @opt_param string iCalUID Specifies an event ID in the iCalendar format to be |
| 209 | * provided in the response. Optional. Use this if you want to search for an |
| 210 | * event by its iCalendar ID. |
| 211 | * @opt_param int maxAttendees The maximum number of attendees to include in the |
| 212 | * response. If there are more than the specified number of attendees, only the |
| 213 | * participant is returned. Optional. |
| 214 | * @opt_param int maxResults Maximum number of events returned on one result |
| 215 | * page. The number of events in the resulting page may be less than this value, |
| 216 | * or none at all, even if there are more events matching the query. Incomplete |
| 217 | * pages can be detected by a non-empty nextPageToken field in the response. By |
| 218 | * default the value is 250 events. The page size can never be larger than 2500 |
| 219 | * events. Optional. |
| 220 | * @opt_param string orderBy The order of the events returned in the result. |
| 221 | * Optional. The default is an unspecified, stable order. |
| 222 | * @opt_param string pageToken Token specifying which result page to return. |
| 223 | * Optional. |
| 224 | * @opt_param string privateExtendedProperty Extended properties constraint |
| 225 | * specified as propertyName=value. Matches only private properties. This |
| 226 | * parameter might be repeated multiple times to return events that match all |
| 227 | * given constraints. |
| 228 | * @opt_param string q Free text search terms to find events that match these |
| 229 | * terms in the following fields: |
| 230 | * |
| 231 | * - summary - description - location - attendee's displayName - attendee's |
| 232 | * email - organizer's displayName - organizer's email - |
| 233 | * workingLocationProperties.officeLocation.buildingId - |
| 234 | * workingLocationProperties.officeLocation.deskId - |
| 235 | * workingLocationProperties.officeLocation.label - |
| 236 | * workingLocationProperties.customLocation.label These search terms also match |
| 237 | * predefined keywords against all display title translations of working |
| 238 | * location, out-of-office, and focus-time events. For example, searching for |
| 239 | * "Office" or "Bureau" returns working location events of type officeLocation, |
| 240 | * whereas searching for "Out of office" or "Abwesend" returns out-of-office |
| 241 | * events. Optional. |
| 242 | * @opt_param string sharedExtendedProperty Extended properties constraint |
| 243 | * specified as propertyName=value. Matches only shared properties. This |
| 244 | * parameter might be repeated multiple times to return events that match all |
| 245 | * given constraints. |
| 246 | * @opt_param bool showDeleted Whether to include deleted events (with status |
| 247 | * equals "cancelled") in the result. Cancelled instances of recurring events |
| 248 | * (but not the underlying recurring event) will still be included if |
| 249 | * showDeleted and singleEvents are both False. If showDeleted and singleEvents |
| 250 | * are both True, only single instances of deleted events (but not the |
| 251 | * underlying recurring events) are returned. Optional. The default is False. |
| 252 | * @opt_param bool showHiddenInvitations Whether to include hidden invitations |
| 253 | * in the result. Optional. The default is False. |
| 254 | * @opt_param bool singleEvents Whether to expand recurring events into |
| 255 | * instances and only return single one-off events and instances of recurring |
| 256 | * events, but not the underlying recurring events themselves. Optional. The |
| 257 | * default is False. |
| 258 | * @opt_param string syncToken Token obtained from the nextSyncToken field |
| 259 | * returned on the last page of results from the previous list request. It makes |
| 260 | * the result of this list request contain only entries that have changed since |
| 261 | * then. All events deleted since the previous list request will always be in |
| 262 | * the result set and it is not allowed to set showDeleted to False. There are |
| 263 | * several query parameters that cannot be specified together with nextSyncToken |
| 264 | * to ensure consistency of the client state. |
| 265 | * |
| 266 | * These are: - iCalUID - orderBy - privateExtendedProperty - q - |
| 267 | * sharedExtendedProperty - timeMin - timeMax - updatedMin All other query |
| 268 | * parameters should be the same as for the initial synchronization to avoid |
| 269 | * undefined behavior. If the syncToken expires, the server will respond with a |
| 270 | * 410 GONE response code and the client should clear its storage and perform a |
| 271 | * full synchronization without any syncToken. Learn more about incremental |
| 272 | * synchronization. Optional. The default is to return all entries. |
| 273 | * @opt_param string timeMax Upper bound (exclusive) for an event's start time |
| 274 | * to filter by. Optional. The default is not to filter by start time. Must be |
| 275 | * an RFC3339 timestamp with mandatory time zone offset, for example, |
| 276 | * 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided |
| 277 | * but are ignored. If timeMin is set, timeMax must be greater than timeMin. |
| 278 | * @opt_param string timeMin Lower bound (exclusive) for an event's end time to |
| 279 | * filter by. Optional. The default is not to filter by end time. Must be an |
| 280 | * RFC3339 timestamp with mandatory time zone offset, for example, |
| 281 | * 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided |
| 282 | * but are ignored. If timeMax is set, timeMin must be smaller than timeMax. |
| 283 | * @opt_param string timeZone Time zone used in the response. Optional. The |
| 284 | * default is the time zone of the calendar. |
| 285 | * @opt_param string updatedMin Lower bound for an event's last modification |
| 286 | * time (as a RFC3339 timestamp) to filter by. When specified, entries deleted |
| 287 | * since this time will always be included regardless of showDeleted. Optional. |
| 288 | * The default is not to filter by last modification time. |
| 289 | * @return EventsModel |
| 290 | * @throws \AmeliaVendor\Google\Service\Exception |
| 291 | */ |
| 292 | public function listEvents($calendarId, $optParams = []) |
| 293 | { |
| 294 | $params = ['calendarId' => $calendarId]; |
| 295 | $params = array_merge($params, $optParams); |
| 296 | return $this->call('list', [$params], EventsModel::class); |
| 297 | } |
| 298 | /** |
| 299 | * Moves an event to another calendar, i.e. changes an event's organizer. Note |
| 300 | * that only default events can be moved; outOfOffice, focusTime and |
| 301 | * workingLocation events cannot be moved. (events.move) |
| 302 | * |
| 303 | * @param string $calendarId Calendar identifier of the source calendar where |
| 304 | * the event currently is on. |
| 305 | * @param string $eventId Event identifier. |
| 306 | * @param string $destination Calendar identifier of the target calendar where |
| 307 | * the event is to be moved to. |
| 308 | * @param array $optParams Optional parameters. |
| 309 | * |
| 310 | * @opt_param bool sendNotifications Deprecated. Please use sendUpdates instead. |
| 311 | * |
| 312 | * Whether to send notifications about the change of the event's organizer. Note |
| 313 | * that some emails might still be sent even if you set the value to false. The |
| 314 | * default is false. |
| 315 | * @opt_param string sendUpdates Guests who should receive notifications about |
| 316 | * the change of the event's organizer. |
| 317 | * @return Event |
| 318 | * @throws \AmeliaVendor\Google\Service\Exception |
| 319 | */ |
| 320 | public function move($calendarId, $eventId, $destination, $optParams = []) |
| 321 | { |
| 322 | $params = ['calendarId' => $calendarId, 'eventId' => $eventId, 'destination' => $destination]; |
| 323 | $params = array_merge($params, $optParams); |
| 324 | return $this->call('move', [$params], Event::class); |
| 325 | } |
| 326 | /** |
| 327 | * Updates an event. This method supports patch semantics. (events.patch) |
| 328 | * |
| 329 | * @param string $calendarId Calendar identifier. To retrieve calendar IDs call |
| 330 | * the calendarList.list method. If you want to access the primary calendar of |
| 331 | * the currently logged in user, use the "primary" keyword. |
| 332 | * @param string $eventId Event identifier. |
| 333 | * @param Event $postBody |
| 334 | * @param array $optParams Optional parameters. |
| 335 | * |
| 336 | * @opt_param bool alwaysIncludeEmail Deprecated and ignored. A value will |
| 337 | * always be returned in the email field for the organizer, creator and |
| 338 | * attendees, even if no real email address is available (i.e. a generated, non- |
| 339 | * working value will be provided). |
| 340 | * @opt_param int conferenceDataVersion Version number of conference data |
| 341 | * supported by the API client. Version 0 assumes no conference data support and |
| 342 | * ignores conference data in the event's body. Version 1 enables support for |
| 343 | * copying of ConferenceData as well as for creating new conferences using the |
| 344 | * createRequest field of conferenceData. The default is 0. |
| 345 | * @opt_param int maxAttendees The maximum number of attendees to include in the |
| 346 | * response. If there are more than the specified number of attendees, only the |
| 347 | * participant is returned. Optional. |
| 348 | * @opt_param bool sendNotifications Deprecated. Please use sendUpdates instead. |
| 349 | * |
| 350 | * Whether to send notifications about the event update (for example, |
| 351 | * description changes, etc.). Note that some emails might still be sent even if |
| 352 | * you set the value to false. The default is false. |
| 353 | * @opt_param string sendUpdates Guests who should receive notifications about |
| 354 | * the event update (for example, title changes, etc.). |
| 355 | * @opt_param bool supportsAttachments Whether API client performing operation |
| 356 | * supports event attachments. Optional. The default is False. |
| 357 | * @return Event |
| 358 | * @throws \AmeliaVendor\Google\Service\Exception |
| 359 | */ |
| 360 | public function patch($calendarId, $eventId, Event $postBody, $optParams = []) |
| 361 | { |
| 362 | $params = ['calendarId' => $calendarId, 'eventId' => $eventId, 'postBody' => $postBody]; |
| 363 | $params = array_merge($params, $optParams); |
| 364 | return $this->call('patch', [$params], Event::class); |
| 365 | } |
| 366 | /** |
| 367 | * Creates an event based on a simple text string. (events.quickAdd) |
| 368 | * |
| 369 | * @param string $calendarId Calendar identifier. To retrieve calendar IDs call |
| 370 | * the calendarList.list method. If you want to access the primary calendar of |
| 371 | * the currently logged in user, use the "primary" keyword. |
| 372 | * @param string $text The text describing the event to be created. |
| 373 | * @param array $optParams Optional parameters. |
| 374 | * |
| 375 | * @opt_param bool sendNotifications Deprecated. Please use sendUpdates instead. |
| 376 | * |
| 377 | * Whether to send notifications about the creation of the event. Note that some |
| 378 | * emails might still be sent even if you set the value to false. The default is |
| 379 | * false. |
| 380 | * @opt_param string sendUpdates Guests who should receive notifications about |
| 381 | * the creation of the new event. |
| 382 | * @return Event |
| 383 | * @throws \AmeliaVendor\Google\Service\Exception |
| 384 | */ |
| 385 | public function quickAdd($calendarId, $text, $optParams = []) |
| 386 | { |
| 387 | $params = ['calendarId' => $calendarId, 'text' => $text]; |
| 388 | $params = array_merge($params, $optParams); |
| 389 | return $this->call('quickAdd', [$params], Event::class); |
| 390 | } |
| 391 | /** |
| 392 | * Updates an event. (events.update) |
| 393 | * |
| 394 | * @param string $calendarId Calendar identifier. To retrieve calendar IDs call |
| 395 | * the calendarList.list method. If you want to access the primary calendar of |
| 396 | * the currently logged in user, use the "primary" keyword. |
| 397 | * @param string $eventId Event identifier. |
| 398 | * @param Event $postBody |
| 399 | * @param array $optParams Optional parameters. |
| 400 | * |
| 401 | * @opt_param bool alwaysIncludeEmail Deprecated and ignored. A value will |
| 402 | * always be returned in the email field for the organizer, creator and |
| 403 | * attendees, even if no real email address is available (i.e. a generated, non- |
| 404 | * working value will be provided). |
| 405 | * @opt_param int conferenceDataVersion Version number of conference data |
| 406 | * supported by the API client. Version 0 assumes no conference data support and |
| 407 | * ignores conference data in the event's body. Version 1 enables support for |
| 408 | * copying of ConferenceData as well as for creating new conferences using the |
| 409 | * createRequest field of conferenceData. The default is 0. |
| 410 | * @opt_param int maxAttendees The maximum number of attendees to include in the |
| 411 | * response. If there are more than the specified number of attendees, only the |
| 412 | * participant is returned. Optional. |
| 413 | * @opt_param bool sendNotifications Deprecated. Please use sendUpdates instead. |
| 414 | * |
| 415 | * Whether to send notifications about the event update (for example, |
| 416 | * description changes, etc.). Note that some emails might still be sent even if |
| 417 | * you set the value to false. The default is false. |
| 418 | * @opt_param string sendUpdates Guests who should receive notifications about |
| 419 | * the event update (for example, title changes, etc.). |
| 420 | * @opt_param bool supportsAttachments Whether API client performing operation |
| 421 | * supports event attachments. Optional. The default is False. |
| 422 | * @return Event |
| 423 | * @throws \AmeliaVendor\Google\Service\Exception |
| 424 | */ |
| 425 | public function update($calendarId, $eventId, Event $postBody, $optParams = []) |
| 426 | { |
| 427 | $params = ['calendarId' => $calendarId, 'eventId' => $eventId, 'postBody' => $postBody]; |
| 428 | $params = array_merge($params, $optParams); |
| 429 | return $this->call('update', [$params], Event::class); |
| 430 | } |
| 431 | /** |
| 432 | * Watch for changes to Events resources. (events.watch) |
| 433 | * |
| 434 | * @param string $calendarId Calendar identifier. To retrieve calendar IDs call |
| 435 | * the calendarList.list method. If you want to access the primary calendar of |
| 436 | * the currently logged in user, use the "primary" keyword. |
| 437 | * @param Channel $postBody |
| 438 | * @param array $optParams Optional parameters. |
| 439 | * |
| 440 | * @opt_param bool alwaysIncludeEmail Deprecated and ignored. |
| 441 | * @opt_param string eventTypes Event types to return. Optional. This parameter |
| 442 | * can be repeated multiple times to return events of different types. If unset, |
| 443 | * returns all event types. |
| 444 | * @opt_param string iCalUID Specifies an event ID in the iCalendar format to be |
| 445 | * provided in the response. Optional. Use this if you want to search for an |
| 446 | * event by its iCalendar ID. |
| 447 | * @opt_param int maxAttendees The maximum number of attendees to include in the |
| 448 | * response. If there are more than the specified number of attendees, only the |
| 449 | * participant is returned. Optional. |
| 450 | * @opt_param int maxResults Maximum number of events returned on one result |
| 451 | * page. The number of events in the resulting page may be less than this value, |
| 452 | * or none at all, even if there are more events matching the query. Incomplete |
| 453 | * pages can be detected by a non-empty nextPageToken field in the response. By |
| 454 | * default the value is 250 events. The page size can never be larger than 2500 |
| 455 | * events. Optional. |
| 456 | * @opt_param string orderBy The order of the events returned in the result. |
| 457 | * Optional. The default is an unspecified, stable order. |
| 458 | * @opt_param string pageToken Token specifying which result page to return. |
| 459 | * Optional. |
| 460 | * @opt_param string privateExtendedProperty Extended properties constraint |
| 461 | * specified as propertyName=value. Matches only private properties. This |
| 462 | * parameter might be repeated multiple times to return events that match all |
| 463 | * given constraints. |
| 464 | * @opt_param string q Free text search terms to find events that match these |
| 465 | * terms in the following fields: |
| 466 | * |
| 467 | * - summary - description - location - attendee's displayName - attendee's |
| 468 | * email - organizer's displayName - organizer's email - |
| 469 | * workingLocationProperties.officeLocation.buildingId - |
| 470 | * workingLocationProperties.officeLocation.deskId - |
| 471 | * workingLocationProperties.officeLocation.label - |
| 472 | * workingLocationProperties.customLocation.label These search terms also match |
| 473 | * predefined keywords against all display title translations of working |
| 474 | * location, out-of-office, and focus-time events. For example, searching for |
| 475 | * "Office" or "Bureau" returns working location events of type officeLocation, |
| 476 | * whereas searching for "Out of office" or "Abwesend" returns out-of-office |
| 477 | * events. Optional. |
| 478 | * @opt_param string sharedExtendedProperty Extended properties constraint |
| 479 | * specified as propertyName=value. Matches only shared properties. This |
| 480 | * parameter might be repeated multiple times to return events that match all |
| 481 | * given constraints. |
| 482 | * @opt_param bool showDeleted Whether to include deleted events (with status |
| 483 | * equals "cancelled") in the result. Cancelled instances of recurring events |
| 484 | * (but not the underlying recurring event) will still be included if |
| 485 | * showDeleted and singleEvents are both False. If showDeleted and singleEvents |
| 486 | * are both True, only single instances of deleted events (but not the |
| 487 | * underlying recurring events) are returned. Optional. The default is False. |
| 488 | * @opt_param bool showHiddenInvitations Whether to include hidden invitations |
| 489 | * in the result. Optional. The default is False. |
| 490 | * @opt_param bool singleEvents Whether to expand recurring events into |
| 491 | * instances and only return single one-off events and instances of recurring |
| 492 | * events, but not the underlying recurring events themselves. Optional. The |
| 493 | * default is False. |
| 494 | * @opt_param string syncToken Token obtained from the nextSyncToken field |
| 495 | * returned on the last page of results from the previous list request. It makes |
| 496 | * the result of this list request contain only entries that have changed since |
| 497 | * then. All events deleted since the previous list request will always be in |
| 498 | * the result set and it is not allowed to set showDeleted to False. There are |
| 499 | * several query parameters that cannot be specified together with nextSyncToken |
| 500 | * to ensure consistency of the client state. |
| 501 | * |
| 502 | * These are: - iCalUID - orderBy - privateExtendedProperty - q - |
| 503 | * sharedExtendedProperty - timeMin - timeMax - updatedMin All other query |
| 504 | * parameters should be the same as for the initial synchronization to avoid |
| 505 | * undefined behavior. If the syncToken expires, the server will respond with a |
| 506 | * 410 GONE response code and the client should clear its storage and perform a |
| 507 | * full synchronization without any syncToken. Learn more about incremental |
| 508 | * synchronization. Optional. The default is to return all entries. |
| 509 | * @opt_param string timeMax Upper bound (exclusive) for an event's start time |
| 510 | * to filter by. Optional. The default is not to filter by start time. Must be |
| 511 | * an RFC3339 timestamp with mandatory time zone offset, for example, |
| 512 | * 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided |
| 513 | * but are ignored. If timeMin is set, timeMax must be greater than timeMin. |
| 514 | * @opt_param string timeMin Lower bound (exclusive) for an event's end time to |
| 515 | * filter by. Optional. The default is not to filter by end time. Must be an |
| 516 | * RFC3339 timestamp with mandatory time zone offset, for example, |
| 517 | * 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided |
| 518 | * but are ignored. If timeMax is set, timeMin must be smaller than timeMax. |
| 519 | * @opt_param string timeZone Time zone used in the response. Optional. The |
| 520 | * default is the time zone of the calendar. |
| 521 | * @opt_param string updatedMin Lower bound for an event's last modification |
| 522 | * time (as a RFC3339 timestamp) to filter by. When specified, entries deleted |
| 523 | * since this time will always be included regardless of showDeleted. Optional. |
| 524 | * The default is not to filter by last modification time. |
| 525 | * @return Channel |
| 526 | * @throws \AmeliaVendor\Google\Service\Exception |
| 527 | */ |
| 528 | public function watch($calendarId, Channel $postBody, $optParams = []) |
| 529 | { |
| 530 | $params = ['calendarId' => $calendarId, 'postBody' => $postBody]; |
| 531 | $params = array_merge($params, $optParams); |
| 532 | return $this->call('watch', [$params], Channel::class); |
| 533 | } |
| 534 | } |
| 535 | |
| 536 | // Adding a class alias for backwards compatibility with the previous class name. |
| 537 | class_alias(Events::class, 'Google_Service_Calendar_Resource_Events'); |
| 538 |