Moodle PHP Documentation 4.1
Moodle 4.1.11 (Build: 20240610) (c8c84b4af18)
Google_Service_Games_Leaderboards_Resource Class Reference

The "leaderboards" collection of methods. More...

Inheritance diagram for Google_Service_Games_Leaderboards_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 get ($leaderboardId, $optParams=array())
 Retrieves the metadata of the leaderboard with the given ID.
 
 listLeaderboards ($optParams=array())
 Lists all the leaderboard metadata for your application.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "leaderboards" collection of methods.

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

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

◆ get()

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

Retrieves the metadata of the leaderboard with the given ID.

(leaderboards.get)

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

@opt_param string language The preferred language to use for strings returned by this method.

Return values
Google_Service_Games_Leaderboard

◆ listLeaderboards()

Google_Service_Games_Leaderboards_Resource::listLeaderboards ( $optParams = array())

Lists all the leaderboard metadata for your application.

(leaderboards.listLeaderboards)

Parameters
array$optParamsOptional parameters.

@opt_param string pageToken The token returned by the previous request. @opt_param int maxResults The maximum number of leaderboards to return in the response. For any response, the actual number of leaderboards returned may be less than the specified maxResults. @opt_param string language The preferred language to use for strings returned by this method.

Return values
Google_Service_Games_LeaderboardListResponse

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