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

The "leaderboardConfigurations" collection of methods. More...

Inheritance diagram for Google_Service_GamesConfiguration_LeaderboardConfigurations_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 delete ($leaderboardId, $optParams=array())
 Delete the leaderboard configuration with the given ID.
 
 get ($leaderboardId, $optParams=array())
 Retrieves the metadata of the leaderboard configuration with the given ID.
 
 insert ($applicationId, Google_Service_GamesConfiguration_LeaderboardConfiguration $postBody, $optParams=array())
 Insert a new leaderboard configuration in this application.
 
 listLeaderboardConfigurations ($applicationId, $optParams=array())
 Returns a list of the leaderboard configurations in this application.
 
 patch ($leaderboardId, Google_Service_GamesConfiguration_LeaderboardConfiguration $postBody, $optParams=array())
 Update the metadata of the leaderboard configuration with the given ID.
 
 update ($leaderboardId, Google_Service_GamesConfiguration_LeaderboardConfiguration $postBody, $optParams=array())
 Update the metadata of the leaderboard configuration with the given ID.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "leaderboardConfigurations" collection of methods.

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

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

◆ delete()

Google_Service_GamesConfiguration_LeaderboardConfigurations_Resource::delete ( $leaderboardId,
$optParams = array() )

Delete the leaderboard configuration with the given ID.

(leaderboardConfigurations.delete)

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

◆ get()

Google_Service_GamesConfiguration_LeaderboardConfigurations_Resource::get ( $leaderboardId,
$optParams = array() )

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

(leaderboardConfigurations.get)

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

◆ insert()

Google_Service_GamesConfiguration_LeaderboardConfigurations_Resource::insert ( $applicationId,
Google_Service_GamesConfiguration_LeaderboardConfiguration $postBody,
$optParams = array() )

Insert a new leaderboard configuration in this application.

(leaderboardConfigurations.insert)

Parameters
string$applicationIdThe application ID from the Google Play developer console.
Google_LeaderboardConfiguration$postBody
array$optParamsOptional parameters.
Return values
Google_Service_GamesConfiguration_LeaderboardConfiguration

◆ listLeaderboardConfigurations()

Google_Service_GamesConfiguration_LeaderboardConfigurations_Resource::listLeaderboardConfigurations ( $applicationId,
$optParams = array() )

Returns a list of the leaderboard configurations in this application.

(leaderboardConfigurations.listLeaderboardConfigurations)

Parameters
string$applicationIdThe application ID from the Google Play developer console.
array$optParamsOptional parameters.

@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

◆ patch()

Google_Service_GamesConfiguration_LeaderboardConfigurations_Resource::patch ( $leaderboardId,
Google_Service_GamesConfiguration_LeaderboardConfiguration $postBody,
$optParams = array() )

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

This method supports patch semantics. (leaderboardConfigurations.patch)

Parameters
string$leaderboardIdThe ID of the leaderboard.
Google_LeaderboardConfiguration$postBody
array$optParamsOptional parameters.
Return values
Google_Service_GamesConfiguration_LeaderboardConfiguration

◆ update()

Google_Service_GamesConfiguration_LeaderboardConfigurations_Resource::update ( $leaderboardId,
Google_Service_GamesConfiguration_LeaderboardConfiguration $postBody,
$optParams = array() )

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

(leaderboardConfigurations.update)

Parameters
string$leaderboardIdThe ID of the leaderboard.
Google_LeaderboardConfiguration$postBody
array$optParamsOptional parameters.
Return values
Google_Service_GamesConfiguration_LeaderboardConfiguration

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