[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\GamesConfiguration\Resource;
|
---|
| 19 |
|
---|
| 20 | use Google\Service\GamesConfiguration\LeaderboardConfiguration;
|
---|
| 21 | use Google\Service\GamesConfiguration\LeaderboardConfigurationListResponse;
|
---|
| 22 |
|
---|
| 23 | /**
|
---|
| 24 | * The "leaderboardConfigurations" collection of methods.
|
---|
| 25 | * Typical usage is:
|
---|
| 26 | * <code>
|
---|
| 27 | * $gamesConfigurationService = new Google\Service\GamesConfiguration(...);
|
---|
| 28 | * $leaderboardConfigurations = $gamesConfigurationService->leaderboardConfigurations;
|
---|
| 29 | * </code>
|
---|
| 30 | */
|
---|
| 31 | class LeaderboardConfigurations extends \Google\Service\Resource
|
---|
| 32 | {
|
---|
| 33 | /**
|
---|
| 34 | * Delete the leaderboard configuration with the given ID.
|
---|
| 35 | * (leaderboardConfigurations.delete)
|
---|
| 36 | *
|
---|
| 37 | * @param string $leaderboardId The ID of the leaderboard.
|
---|
| 38 | * @param array $optParams Optional parameters.
|
---|
| 39 | * @throws \Google\Service\Exception
|
---|
| 40 | */
|
---|
| 41 | public function delete($leaderboardId, $optParams = [])
|
---|
| 42 | {
|
---|
| 43 | $params = ['leaderboardId' => $leaderboardId];
|
---|
| 44 | $params = array_merge($params, $optParams);
|
---|
| 45 | return $this->call('delete', [$params]);
|
---|
| 46 | }
|
---|
| 47 | /**
|
---|
| 48 | * Retrieves the metadata of the leaderboard configuration with the given ID.
|
---|
| 49 | * (leaderboardConfigurations.get)
|
---|
| 50 | *
|
---|
| 51 | * @param string $leaderboardId The ID of the leaderboard.
|
---|
| 52 | * @param array $optParams Optional parameters.
|
---|
| 53 | * @return LeaderboardConfiguration
|
---|
| 54 | * @throws \Google\Service\Exception
|
---|
| 55 | */
|
---|
| 56 | public function get($leaderboardId, $optParams = [])
|
---|
| 57 | {
|
---|
| 58 | $params = ['leaderboardId' => $leaderboardId];
|
---|
| 59 | $params = array_merge($params, $optParams);
|
---|
| 60 | return $this->call('get', [$params], LeaderboardConfiguration::class);
|
---|
| 61 | }
|
---|
| 62 | /**
|
---|
| 63 | * Insert a new leaderboard configuration in this application.
|
---|
| 64 | * (leaderboardConfigurations.insert)
|
---|
| 65 | *
|
---|
| 66 | * @param string $applicationId The application ID from the Google Play
|
---|
| 67 | * developer console.
|
---|
| 68 | * @param LeaderboardConfiguration $postBody
|
---|
| 69 | * @param array $optParams Optional parameters.
|
---|
| 70 | * @return LeaderboardConfiguration
|
---|
| 71 | * @throws \Google\Service\Exception
|
---|
| 72 | */
|
---|
| 73 | public function insert($applicationId, LeaderboardConfiguration $postBody, $optParams = [])
|
---|
| 74 | {
|
---|
| 75 | $params = ['applicationId' => $applicationId, 'postBody' => $postBody];
|
---|
| 76 | $params = array_merge($params, $optParams);
|
---|
| 77 | return $this->call('insert', [$params], LeaderboardConfiguration::class);
|
---|
| 78 | }
|
---|
| 79 | /**
|
---|
| 80 | * Returns a list of the leaderboard configurations in this application.
|
---|
| 81 | * (leaderboardConfigurations.listLeaderboardConfigurations)
|
---|
| 82 | *
|
---|
| 83 | * @param string $applicationId The application ID from the Google Play
|
---|
| 84 | * developer console.
|
---|
| 85 | * @param array $optParams Optional parameters.
|
---|
| 86 | *
|
---|
| 87 | * @opt_param int maxResults The maximum number of resource configurations to
|
---|
| 88 | * return in the response, used for paging. For any response, the actual number
|
---|
| 89 | * of resources returned may be less than the specified `maxResults`.
|
---|
| 90 | * @opt_param string pageToken The token returned by the previous request.
|
---|
| 91 | * @return LeaderboardConfigurationListResponse
|
---|
| 92 | * @throws \Google\Service\Exception
|
---|
| 93 | */
|
---|
| 94 | public function listLeaderboardConfigurations($applicationId, $optParams = [])
|
---|
| 95 | {
|
---|
| 96 | $params = ['applicationId' => $applicationId];
|
---|
| 97 | $params = array_merge($params, $optParams);
|
---|
| 98 | return $this->call('list', [$params], LeaderboardConfigurationListResponse::class);
|
---|
| 99 | }
|
---|
| 100 | /**
|
---|
| 101 | * Update the metadata of the leaderboard configuration with the given ID.
|
---|
| 102 | * (leaderboardConfigurations.update)
|
---|
| 103 | *
|
---|
| 104 | * @param string $leaderboardId The ID of the leaderboard.
|
---|
| 105 | * @param LeaderboardConfiguration $postBody
|
---|
| 106 | * @param array $optParams Optional parameters.
|
---|
| 107 | * @return LeaderboardConfiguration
|
---|
| 108 | * @throws \Google\Service\Exception
|
---|
| 109 | */
|
---|
| 110 | public function update($leaderboardId, LeaderboardConfiguration $postBody, $optParams = [])
|
---|
| 111 | {
|
---|
| 112 | $params = ['leaderboardId' => $leaderboardId, 'postBody' => $postBody];
|
---|
| 113 | $params = array_merge($params, $optParams);
|
---|
| 114 | return $this->call('update', [$params], LeaderboardConfiguration::class);
|
---|
| 115 | }
|
---|
| 116 | }
|
---|
| 117 |
|
---|
| 118 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
| 119 | class_alias(LeaderboardConfigurations::class, 'Google_Service_GamesConfiguration_Resource_LeaderboardConfigurations');
|
---|