Documentation

Google_Service_GamesConfiguration_Resource_LeaderboardConfigurations extends Google_Service_Resource
in package

The "leaderboardConfigurations" collection of methods.

Typical usage is: $gamesConfigurationService = new Google_Service_GamesConfiguration(...); $leaderboardConfigurations = $gamesConfigurationService->leaderboardConfigurations;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : mixed
Delete the leaderboard configuration with the given ID.
get()  : Google_Service_GamesConfiguration_LeaderboardConfiguration
Retrieves the metadata of the leaderboard configuration with the given ID.
insert()  : Google_Service_GamesConfiguration_LeaderboardConfiguration
Insert a new leaderboard configuration in this application.
listLeaderboardConfigurations()  : Google_Service_GamesConfiguration_LeaderboardConfigurationListResponse
Returns a list of the leaderboard configurations in this application.
update()  : Google_Service_GamesConfiguration_LeaderboardConfiguration
Update the metadata of the leaderboard configuration with the given ID.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string

$requestUrl

delete()

Delete the leaderboard configuration with the given ID.

public delete(string $leaderboardId[, array<string|int, mixed> $optParams = array() ]) : mixed

(leaderboardConfigurations.delete)

Parameters
$leaderboardId : string

The ID of the leaderboard.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
mixed

get()

Retrieves the metadata of the leaderboard configuration with the given ID.

public get(string $leaderboardId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_GamesConfiguration_LeaderboardConfiguration

(leaderboardConfigurations.get)

Parameters
$leaderboardId : string

The ID of the leaderboard.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_GamesConfiguration_LeaderboardConfiguration

insert()

Insert a new leaderboard configuration in this application.

public insert(string $applicationId, Google_Service_GamesConfiguration_LeaderboardConfiguration $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_GamesConfiguration_LeaderboardConfiguration

(leaderboardConfigurations.insert)

Parameters
$applicationId : string

The application ID from the Google Play developer console.

$postBody : Google_Service_GamesConfiguration_LeaderboardConfiguration
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_GamesConfiguration_LeaderboardConfiguration

listLeaderboardConfigurations()

Returns a list of the leaderboard configurations in this application.

public listLeaderboardConfigurations(string $applicationId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_GamesConfiguration_LeaderboardConfigurationListResponse

(leaderboardConfigurations.listLeaderboardConfigurations)

Parameters
$applicationId : string

The application ID from the Google Play developer console.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string pageToken The token returned by the previous request.

opt_param

int maxResults The maximum number of resource configurations to return in the response, used for paging. For any response, the actual number of resources returned may be less than the specified maxResults.

Return values
Google_Service_GamesConfiguration_LeaderboardConfigurationListResponse

update()

Update the metadata of the leaderboard configuration with the given ID.

public update(string $leaderboardId, Google_Service_GamesConfiguration_LeaderboardConfiguration $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_GamesConfiguration_LeaderboardConfiguration

(leaderboardConfigurations.update)

Parameters
$leaderboardId : string

The ID of the leaderboard.

$postBody : Google_Service_GamesConfiguration_LeaderboardConfiguration
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_GamesConfiguration_LeaderboardConfiguration

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed

Search results