📂 File Browser

📁 Directories

📄 Files

📄 Source: Metagame.php

<?php
/*
 * Copyright 2014 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

namespace Google\Service\Games\Resource;

use Google\Service\Games\CategoryListResponse;
use Google\Service\Games\MetagameConfig;

/**
 * The "metagame" collection of methods.
 * Typical usage is:
 *  <code>
 *   $gamesService = new Google\Service\Games(...);
 *   $metagame = $gamesService->metagame;
 *  </code>
 */
class Metagame extends \Google\Service\Resource
{
  /**
   * Return the metagame configuration data for the calling application.
   * (metagame.getMetagameConfig)
   *
   * @param array $optParams Optional parameters.
   * @return MetagameConfig
   * @throws \Google\Service\Exception
   */
  public function getMetagameConfig($optParams = [])
  {
    $params = [];
    $params = array_merge($params, $optParams);
    return $this->call('getMetagameConfig', [$params], MetagameConfig::class);
  }
  /**
   * List play data aggregated per category for the player corresponding to
   * `playerId`. (metagame.listCategoriesByPlayer)
   *
   * @param string $playerId A player ID. A value of `me` may be used in place of
   * the authenticated player's ID.
   * @param string $collection The collection of categories for which data will be
   * returned.
   * @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 category resources to return
   * in the response, used for paging. For any response, the actual number of
   * category resources returned may be less than the specified `maxResults`.
   * @opt_param string pageToken The token returned by the previous request.
   * @return CategoryListResponse
   * @throws \Google\Service\Exception
   */
  public function listCategoriesByPlayer($playerId, $collection, $optParams = [])
  {
    $params = ['playerId' => $playerId, 'collection' => $collection];
    $params = array_merge($params, $optParams);
    return $this->call('listCategoriesByPlayer', [$params], CategoryListResponse::class);
  }
}

// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Metagame::class, 'Google_Service_Games_Resource_Metagame');