Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
Google_Service_GamesManagement_Scores_Resource Class Reference

The "scores" collection of methods. More...

Inheritance diagram for Google_Service_GamesManagement_Scores_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 reset ($leaderboardId, $optParams=array())
 Resets scores for the leaderboard with the given ID for the currently authenticated player.
 
 resetAll ($optParams=array())
 Resets all scores for all leaderboards for the currently authenticated players.
 
 resetAllForAllPlayers ($optParams=array())
 Resets scores for all draft leaderboards for all players.
 
 resetForAllPlayers ($leaderboardId, $optParams=array())
 Resets scores for the leaderboard with the given ID for all players.
 
 resetMultipleForAllPlayers (Google_Service_GamesManagement_ScoresResetMultipleForAllRequest $postBody, $optParams=array())
 Resets scores for the leaderboards with the given IDs for all players.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "scores" collection of methods.

Typical usage is: $gamesManagementService = new Google_Service_GamesManagement(...); $scores = $gamesManagementService->scores;

Member Function Documentation

◆ call()

Google_Service_Resource::call ( $name,
$arguments,
$expected_class = null )
inherited

TODO: This function needs simplifying.

Parameters
$name
$arguments
$expected_class- optional, the expected class name
Return values
Google_Http_Request|expected_class
Exceptions
Google_Exception

◆ reset()

Google_Service_GamesManagement_Scores_Resource::reset ( $leaderboardId,
$optParams = array() )

Resets scores for the leaderboard with the given ID for the currently authenticated player.

This method is only accessible to whitelisted tester accounts for your application. (scores.reset)

Parameters
string$leaderboardIdThe ID of the leaderboard.
array$optParamsOptional parameters.
Return values
Google_Service_GamesManagement_PlayerScoreResetResponse

◆ resetAll()

Google_Service_GamesManagement_Scores_Resource::resetAll ( $optParams = array())

Resets all scores for all leaderboards for the currently authenticated players.

This method is only accessible to whitelisted tester accounts for your application. (scores.resetAll)

Parameters
array$optParamsOptional parameters.
Return values
Google_Service_GamesManagement_PlayerScoreResetAllResponse

◆ resetAllForAllPlayers()

Google_Service_GamesManagement_Scores_Resource::resetAllForAllPlayers ( $optParams = array())

Resets scores for all draft leaderboards for all players.

This method is only available to user accounts for your developer console. (scores.resetAllForAllPlayers)

Parameters
array$optParamsOptional parameters.

◆ resetForAllPlayers()

Google_Service_GamesManagement_Scores_Resource::resetForAllPlayers ( $leaderboardId,
$optParams = array() )

Resets scores for the leaderboard with the given ID for all players.

This method is only available to user accounts for your developer console. Only draft leaderboards can be reset. (scores.resetForAllPlayers)

Parameters
string$leaderboardIdThe ID of the leaderboard.
array$optParamsOptional parameters.

◆ resetMultipleForAllPlayers()

Google_Service_GamesManagement_Scores_Resource::resetMultipleForAllPlayers ( Google_Service_GamesManagement_ScoresResetMultipleForAllRequest $postBody,
$optParams = array() )

Resets scores for the leaderboards with the given IDs for all players.

This method is only available to user accounts for your developer console. Only draft leaderboards may be reset. (scores.resetMultipleForAllPlayers)

Parameters
Google_ScoresResetMultipleForAllRequest$postBody
array$optParamsOptional parameters.

The documentation for this class was generated from the following file: