Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
Google_Service_GamesManagement_Achievements_Resource Class Reference

The "achievements" collection of methods. More...

Inheritance diagram for Google_Service_GamesManagement_Achievements_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 reset ($achievementId, $optParams=array())
 Resets the achievement with the given ID for the currently authenticated player.
 
 resetAll ($optParams=array())
 Resets all achievements for the currently authenticated player for your application.
 
 resetAllForAllPlayers ($optParams=array())
 Resets all draft achievements for all players.
 
 resetForAllPlayers ($achievementId, $optParams=array())
 Resets the achievement with the given ID for all players.
 
 resetMultipleForAllPlayers (Google_Service_GamesManagement_AchievementResetMultipleForAllRequest $postBody, $optParams=array())
 Resets achievements with the given IDs for all players.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "achievements" collection of methods.

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

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_Achievements_Resource::reset ( $achievementId,
$optParams = array() )

Resets the achievement with the given ID for the currently authenticated player.

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

Parameters
string$achievementIdThe ID of the achievement used by this method.
array$optParamsOptional parameters.
Return values
Google_Service_GamesManagement_AchievementResetResponse

◆ resetAll()

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

Resets all achievements for the currently authenticated player for your application.

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

Parameters
array$optParamsOptional parameters.
Return values
Google_Service_GamesManagement_AchievementResetAllResponse

◆ resetAllForAllPlayers()

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

Resets all draft achievements for all players.

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

Parameters
array$optParamsOptional parameters.

◆ resetForAllPlayers()

Google_Service_GamesManagement_Achievements_Resource::resetForAllPlayers ( $achievementId,
$optParams = array() )

Resets the achievement with the given ID for all players.

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

Parameters
string$achievementIdThe ID of the achievement used by this method.
array$optParamsOptional parameters.

◆ resetMultipleForAllPlayers()

Google_Service_GamesManagement_Achievements_Resource::resetMultipleForAllPlayers ( Google_Service_GamesManagement_AchievementResetMultipleForAllRequest $postBody,
$optParams = array() )

Resets achievements with the given IDs for all players.

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

Parameters
Google_AchievementResetMultipleForAllRequest$postBody
array$optParamsOptional parameters.

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