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\Directory\Resource;
|
---|
19 |
|
---|
20 | use Google\Service\Directory\UserPhoto;
|
---|
21 |
|
---|
22 | /**
|
---|
23 | * The "photos" collection of methods.
|
---|
24 | * Typical usage is:
|
---|
25 | * <code>
|
---|
26 | * $adminService = new Google\Service\Directory(...);
|
---|
27 | * $photos = $adminService->users_photos;
|
---|
28 | * </code>
|
---|
29 | */
|
---|
30 | class UsersPhotos extends \Google\Service\Resource
|
---|
31 | {
|
---|
32 | /**
|
---|
33 | * Removes the user's photo. (photos.delete)
|
---|
34 | *
|
---|
35 | * @param string $userKey Identifies the user in the API request. The value can
|
---|
36 | * be the user's primary email address, alias email address, or unique user ID.
|
---|
37 | * @param array $optParams Optional parameters.
|
---|
38 | * @throws \Google\Service\Exception
|
---|
39 | */
|
---|
40 | public function delete($userKey, $optParams = [])
|
---|
41 | {
|
---|
42 | $params = ['userKey' => $userKey];
|
---|
43 | $params = array_merge($params, $optParams);
|
---|
44 | return $this->call('delete', [$params]);
|
---|
45 | }
|
---|
46 | /**
|
---|
47 | * Retrieves the user's photo. (photos.get)
|
---|
48 | *
|
---|
49 | * @param string $userKey Identifies the user in the API request. The value can
|
---|
50 | * be the user's primary email address, alias email address, or unique user ID.
|
---|
51 | * @param array $optParams Optional parameters.
|
---|
52 | * @return UserPhoto
|
---|
53 | * @throws \Google\Service\Exception
|
---|
54 | */
|
---|
55 | public function get($userKey, $optParams = [])
|
---|
56 | {
|
---|
57 | $params = ['userKey' => $userKey];
|
---|
58 | $params = array_merge($params, $optParams);
|
---|
59 | return $this->call('get', [$params], UserPhoto::class);
|
---|
60 | }
|
---|
61 | /**
|
---|
62 | * Adds a photo for the user. This method supports [patch semantics](/admin-
|
---|
63 | * sdk/directory/v1/guides/performance#patch). (photos.patch)
|
---|
64 | *
|
---|
65 | * @param string $userKey Identifies the user in the API request. The value can
|
---|
66 | * be the user's primary email address, alias email address, or unique user ID.
|
---|
67 | * @param UserPhoto $postBody
|
---|
68 | * @param array $optParams Optional parameters.
|
---|
69 | * @return UserPhoto
|
---|
70 | * @throws \Google\Service\Exception
|
---|
71 | */
|
---|
72 | public function patch($userKey, UserPhoto $postBody, $optParams = [])
|
---|
73 | {
|
---|
74 | $params = ['userKey' => $userKey, 'postBody' => $postBody];
|
---|
75 | $params = array_merge($params, $optParams);
|
---|
76 | return $this->call('patch', [$params], UserPhoto::class);
|
---|
77 | }
|
---|
78 | /**
|
---|
79 | * Adds a photo for the user. (photos.update)
|
---|
80 | *
|
---|
81 | * @param string $userKey Identifies the user in the API request. The value can
|
---|
82 | * be the user's primary email address, alias email address, or unique user ID.
|
---|
83 | * @param UserPhoto $postBody
|
---|
84 | * @param array $optParams Optional parameters.
|
---|
85 | * @return UserPhoto
|
---|
86 | * @throws \Google\Service\Exception
|
---|
87 | */
|
---|
88 | public function update($userKey, UserPhoto $postBody, $optParams = [])
|
---|
89 | {
|
---|
90 | $params = ['userKey' => $userKey, 'postBody' => $postBody];
|
---|
91 | $params = array_merge($params, $optParams);
|
---|
92 | return $this->call('update', [$params], UserPhoto::class);
|
---|
93 | }
|
---|
94 | }
|
---|
95 |
|
---|
96 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
97 | class_alias(UsersPhotos::class, 'Google_Service_Directory_Resource_UsersPhotos');
|
---|