[e3d4e0a] | 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 Google\Service\Meet\Resource;
|
---|
| 19 |
|
---|
| 20 | use Google\Service\Meet\EndActiveConferenceRequest;
|
---|
| 21 | use Google\Service\Meet\MeetEmpty;
|
---|
| 22 | use Google\Service\Meet\Space;
|
---|
| 23 |
|
---|
| 24 | /**
|
---|
| 25 | * The "spaces" collection of methods.
|
---|
| 26 | * Typical usage is:
|
---|
| 27 | * <code>
|
---|
| 28 | * $meetService = new Google\Service\Meet(...);
|
---|
| 29 | * $spaces = $meetService->spaces;
|
---|
| 30 | * </code>
|
---|
| 31 | */
|
---|
| 32 | class Spaces extends \Google\Service\Resource
|
---|
| 33 | {
|
---|
| 34 | /**
|
---|
| 35 | * Creates a space. (spaces.create)
|
---|
| 36 | *
|
---|
| 37 | * @param Space $postBody
|
---|
| 38 | * @param array $optParams Optional parameters.
|
---|
| 39 | * @return Space
|
---|
| 40 | * @throws \Google\Service\Exception
|
---|
| 41 | */
|
---|
| 42 | public function create(Space $postBody, $optParams = [])
|
---|
| 43 | {
|
---|
| 44 | $params = ['postBody' => $postBody];
|
---|
| 45 | $params = array_merge($params, $optParams);
|
---|
| 46 | return $this->call('create', [$params], Space::class);
|
---|
| 47 | }
|
---|
| 48 | /**
|
---|
| 49 | * Ends an active conference (if there's one). For an example, see [End active
|
---|
| 50 | * conference](https://developers.google.com/meet/api/guides/meeting-spaces#end-
|
---|
| 51 | * active-conference). (spaces.endActiveConference)
|
---|
| 52 | *
|
---|
| 53 | * @param string $name Required. Resource name of the space. Format:
|
---|
| 54 | * `spaces/{space}`. `{space}` is the resource identifier for the space. It's a
|
---|
| 55 | * unique, server-generated ID and is case sensitive. For example,
|
---|
| 56 | * `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting
|
---|
| 57 | * space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-
|
---|
| 58 | * meeting-space).
|
---|
| 59 | * @param EndActiveConferenceRequest $postBody
|
---|
| 60 | * @param array $optParams Optional parameters.
|
---|
| 61 | * @return MeetEmpty
|
---|
| 62 | * @throws \Google\Service\Exception
|
---|
| 63 | */
|
---|
| 64 | public function endActiveConference($name, EndActiveConferenceRequest $postBody, $optParams = [])
|
---|
| 65 | {
|
---|
| 66 | $params = ['name' => $name, 'postBody' => $postBody];
|
---|
| 67 | $params = array_merge($params, $optParams);
|
---|
| 68 | return $this->call('endActiveConference', [$params], MeetEmpty::class);
|
---|
| 69 | }
|
---|
| 70 | /**
|
---|
| 71 | * Gets details about a meeting space. For an example, see [Get a meeting
|
---|
| 72 | * space](https://developers.google.com/meet/api/guides/meeting-spaces#get-
|
---|
| 73 | * meeting-space). (spaces.get)
|
---|
| 74 | *
|
---|
| 75 | * @param string $name Required. Resource name of the space. Format:
|
---|
| 76 | * `spaces/{space}` or `spaces/{meetingCode}`. `{space}` is the resource
|
---|
| 77 | * identifier for the space. It's a unique, server-generated ID and is case
|
---|
| 78 | * sensitive. For example, `jQCFfuBOdN5z`. `{meetingCode}` is an alias for the
|
---|
| 79 | * space. It's a typeable, unique character string and is non-case sensitive.
|
---|
| 80 | * For example, `abc-mnop-xyz`. The maximum length is 128 characters. A
|
---|
| 81 | * `meetingCode` shouldn't be stored long term as it can become dissociated from
|
---|
| 82 | * a meeting space and can be reused for different meeting spaces in the future.
|
---|
| 83 | * Generally, a `meetingCode` expires 365 days after last use. For more
|
---|
| 84 | * information, see [Learn about meeting codes in Google
|
---|
| 85 | * Meet](https://support.google.com/meet/answer/10710509). For more information,
|
---|
| 86 | * see [How Meet identifies a meeting
|
---|
| 87 | * space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-
|
---|
| 88 | * meeting-space).
|
---|
| 89 | * @param array $optParams Optional parameters.
|
---|
| 90 | * @return Space
|
---|
| 91 | * @throws \Google\Service\Exception
|
---|
| 92 | */
|
---|
| 93 | public function get($name, $optParams = [])
|
---|
| 94 | {
|
---|
| 95 | $params = ['name' => $name];
|
---|
| 96 | $params = array_merge($params, $optParams);
|
---|
| 97 | return $this->call('get', [$params], Space::class);
|
---|
| 98 | }
|
---|
| 99 | /**
|
---|
| 100 | * Updates details about a meeting space. For an example, see [Update a meeting
|
---|
| 101 | * space](https://developers.google.com/meet/api/guides/meeting-spaces#update-
|
---|
| 102 | * meeting-space). (spaces.patch)
|
---|
| 103 | *
|
---|
| 104 | * @param string $name Immutable. Resource name of the space. Format:
|
---|
| 105 | * `spaces/{space}`. `{space}` is the resource identifier for the space. It's a
|
---|
| 106 | * unique, server-generated ID and is case sensitive. For example,
|
---|
| 107 | * `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting
|
---|
| 108 | * space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-
|
---|
| 109 | * meeting-space).
|
---|
| 110 | * @param Space $postBody
|
---|
| 111 | * @param array $optParams Optional parameters.
|
---|
| 112 | *
|
---|
| 113 | * @opt_param string updateMask Optional. Field mask used to specify the fields
|
---|
| 114 | * to be updated in the space. If update_mask isn't provided(not set, set with
|
---|
| 115 | * empty paths, or only has "" as paths), it defaults to update all fields
|
---|
| 116 | * provided with values in the request. Using "*" as update_mask will update all
|
---|
| 117 | * fields, including deleting fields not set in the request.
|
---|
| 118 | * @return Space
|
---|
| 119 | * @throws \Google\Service\Exception
|
---|
| 120 | */
|
---|
| 121 | public function patch($name, Space $postBody, $optParams = [])
|
---|
| 122 | {
|
---|
| 123 | $params = ['name' => $name, 'postBody' => $postBody];
|
---|
| 124 | $params = array_merge($params, $optParams);
|
---|
| 125 | return $this->call('patch', [$params], Space::class);
|
---|
| 126 | }
|
---|
| 127 | }
|
---|
| 128 |
|
---|
| 129 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
| 130 | class_alias(Spaces::class, 'Google_Service_Meet_Resource_Spaces');
|
---|