Google_LeaderboardsServiceResource
The "leaderboards" collection of methods.
Defined (1)
The class is defined in the following location(s).
- /google-api/src/contrib/Google_GamesService.php
- class Google_LeaderboardsServiceResource extends Google_ServiceResource {
- /**
- * Retrieves the metadata of the leaderboard with the given ID. (leaderboards.get)
- *
- * @param string $leaderboardId The ID of the leaderboard.
- * @param array $optParams Optional parameters.
- *
- * @opt_param string language The preferred language to use for strings returned by this method.
- * @return Google_Leaderboard
- */
- public function get($leaderboardId, $optParams = array()) {
- $params = array('leaderboardId' => $leaderboardId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('get', array($params));
- if ($this->useObjects()) {
- return new Google_Leaderboard($data);
- } else {
- return $data;
- }
- }
- /**
- * Lists all the leaderboard metadata for your application. (leaderboards.list)
- *
- * @param array $optParams Optional parameters.
- *
- * @opt_param string language The preferred language to use for strings returned by this method.
- * @opt_param int maxResults The maximum number of leaderboards to return in the response. For any response, the actual number of leaderboards returned may be less than the specified maxResults.
- * @opt_param string pageToken The token returned by the previous request.
- * @return Google_LeaderboardListResponse
- */
- public function listLeaderboards($optParams = array()) {
- $params = array();
- $params = array_merge($params, $optParams);
- $data = $this->__call('list', array($params));
- if ($this->useObjects()) {
- return new Google_LeaderboardListResponse($data);
- } else {
- return $data;
- }
- }
- }