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\Classroom\Resource;
|
---|
19 |
|
---|
20 | use Google\Service\Classroom\UserProfile;
|
---|
21 |
|
---|
22 | /**
|
---|
23 | * The "userProfiles" collection of methods.
|
---|
24 | * Typical usage is:
|
---|
25 | * <code>
|
---|
26 | * $classroomService = new Google\Service\Classroom(...);
|
---|
27 | * $userProfiles = $classroomService->userProfiles;
|
---|
28 | * </code>
|
---|
29 | */
|
---|
30 | class UserProfiles extends \Google\Service\Resource
|
---|
31 | {
|
---|
32 | /**
|
---|
33 | * Returns a user profile. This method returns the following error codes: *
|
---|
34 | * `PERMISSION_DENIED` if the requesting user is not permitted to access this
|
---|
35 | * user profile, if no profile exists with the requested ID, or for access
|
---|
36 | * errors. (userProfiles.get)
|
---|
37 | *
|
---|
38 | * @param string $userId Identifier of the profile to return. The identifier can
|
---|
39 | * be one of the following: * the numeric identifier for the user * the email
|
---|
40 | * address of the user * the string literal `"me"`, indicating the requesting
|
---|
41 | * user
|
---|
42 | * @param array $optParams Optional parameters.
|
---|
43 | * @return UserProfile
|
---|
44 | * @throws \Google\Service\Exception
|
---|
45 | */
|
---|
46 | public function get($userId, $optParams = [])
|
---|
47 | {
|
---|
48 | $params = ['userId' => $userId];
|
---|
49 | $params = array_merge($params, $optParams);
|
---|
50 | return $this->call('get', [$params], UserProfile::class);
|
---|
51 | }
|
---|
52 | }
|
---|
53 |
|
---|
54 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
55 | class_alias(UserProfiles::class, 'Google_Service_Classroom_Resource_UserProfiles');
|
---|