Documentation

Google_Service_Games_Resource_Achievements extends Google_Service_Resource
in package

Application

The "achievements" collection of methods.

Typical usage is: $gamesService = new Google_Service_Games(...); $achievements = $gamesService->achievements;

$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.
increment() : Google_Service_Games_AchievementIncrementResponse: Increments the steps of the achievement with the given ID for the currently authenticated player. (achievements.increment)
listAchievements() : Google_Service_Games_PlayerAchievementListResponse: Lists the progress for all your application's achievements for the currently authenticated player. (achievements.listAchievements)
reveal() : Google_Service_Games_AchievementRevealResponse: Sets the state of the achievement with the given ID to `REVEALED` for the currently authenticated player. (achievements.reveal)
setStepsAtLeast() : Google_Service_Games_AchievementSetStepsAtLeastResponse: Sets the steps for the currently authenticated player towards unlocking an achievement. If the steps parameter is less than the current number of steps that the player already gained for the achievement, the achievement is not modified. (achievements.setStepsAtLeast)
unlock() : Google_Service_Games_AchievementUnlockResponse: Unlocks this achievement for the currently authenticated player.
updateMultiple() : Google_Service_Games_AchievementUpdateMultipleResponse: Updates multiple achievements for the currently authenticated player.
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$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'))

__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

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>

Return values

string —

$requestUrl

increment()

Increments the steps of the achievement with the given ID for the currently authenticated player. (achievements.increment)


    public
                increment(string $achievementId, int $stepsToIncrement[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Games_AchievementIncrementResponse

Parameters

$achievementId : string: The ID of the achievement used by this method.
$stepsToIncrement : int: The number of steps to increment.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Games_AchievementIncrementResponse —

listAchievements()

Lists the progress for all your application's achievements for the currently authenticated player. (achievements.listAchievements)


    public
                listAchievements(string $playerId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Games_PlayerAchievementListResponse

Parameters

$playerId : string: A player ID. A value of me may be used in place of the authenticated player's ID.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Games_PlayerAchievementListResponse —

reveal()

Sets the state of the achievement with the given ID to `REVEALED` for the currently authenticated player. (achievements.reveal)


    public
                reveal(string $achievementId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Games_AchievementRevealResponse

Parameters

$achievementId : string: The ID of the achievement used by this method.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Games_AchievementRevealResponse —

setStepsAtLeast()

Sets the steps for the currently authenticated player towards unlocking an achievement. If the steps parameter is less than the current number of steps that the player already gained for the achievement, the achievement is not modified. (achievements.setStepsAtLeast)


    public
                setStepsAtLeast(string $achievementId, int $steps[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Games_AchievementSetStepsAtLeastResponse

Parameters

$achievementId : string: The ID of the achievement used by this method.
$steps : int: The minimum value to set the steps to.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Games_AchievementSetStepsAtLeastResponse —

unlock()

Unlocks this achievement for the currently authenticated player.


    public
                unlock(string $achievementId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Games_AchievementUnlockResponse

(achievements.unlock)

Parameters

$achievementId : string: The ID of the achievement used by this method.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Games_AchievementUnlockResponse —

updateMultiple()

Updates multiple achievements for the currently authenticated player.


    public
                updateMultiple(Google_Service_Games_AchievementUpdateMultipleRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Games_AchievementUpdateMultipleResponse

(achievements.updateMultiple)

Parameters

$postBody : Google_Service_Games_AchievementUpdateMultipleRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Games_AchievementUpdateMultipleResponse —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —