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

The "players" collection of methods. More...

Inheritance diagram for Google_Service_Games_Players_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 get ($playerId, $optParams=array())
 Retrieves the Player resource with the given ID.
 
 listPlayers ($collection, $optParams=array())
 Get the collection of players for the currently authenticated user.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "players" collection of methods.

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

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_Players_Resource::get ( $playerId,
$optParams = array() )

Retrieves the Player resource with the given ID.

To retrieve the player for the currently authenticated user, set playerId to me. (players.get)

Parameters
string$playerIdA player ID. A value of me may be used in place of the authenticated player's ID.
array$optParamsOptional parameters.

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

Return values
Google_Service_Games_Player

◆ listPlayers()

Google_Service_Games_Players_Resource::listPlayers ( $collection,
$optParams = array() )

Get the collection of players for the currently authenticated user.

(players.listPlayers)

Parameters
string$collectionCollection of players being retrieved
array$optParamsOptional parameters.

@opt_param string pageToken The token returned by the previous request. @opt_param int maxResults The maximum number of player resources to return in the response, used for paging. For any response, the actual number of player resources 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_PlayerListResponse

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