com.google.api.services.games

Class Games.Players

java.lang.Object

com.google.api.services.games.Games.Players

Enclosing class:

Games

public class Games.Players
extends Object

The "players" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Games.Players.Get
class	Games.Players.GetMultipleApplicationPlayerIds
class	Games.Players.GetScopedPlayerIds
class	Games.Players.List

Constructor Summary

Constructors

Constructor and Description
Players()

Method Summary

Modifier and Type	Method and Description
Games.Players.Get	get(String playerId) Retrieves the Player resource with the given ID.
Games.Players.GetMultipleApplicationPlayerIds	getMultipleApplicationPlayerIds() Get the application player ids for the currently authenticated player across all requested games by the same developer as the calling application.
Games.Players.GetScopedPlayerIds	getScopedPlayerIds() Retrieves scoped player identifiers for currently authenticated user.
Games.Players.List	list(String collection) Get the collection of players for the currently authenticated user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Players

public Players()

Method Detail

get

public Games.Players.Get get(String playerId)
                      throws IOException

Retrieves the Player resource with the given ID. To retrieve the player for the currently authenticated user, set `playerId` to `me`. Create a request for the method "players.get". This request holds the parameters needed by the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

playerId - A player ID. A value of `me` may be used in place of the authenticated player's ID.

Returns:

the request

Throws:

IOException

getMultipleApplicationPlayerIds

public Games.Players.GetMultipleApplicationPlayerIds getMultipleApplicationPlayerIds()
                                                                              throws IOException

Get the application player ids for the currently authenticated player across all requested games by the same developer as the calling application. This will only return ids for players that actually have an id (scoped or otherwise) with that game. Create a request for the method "players.getMultipleApplicationPlayerIds". This request holds the parameters needed by the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Returns:

the request

Throws:

IOException

getScopedPlayerIds

public Games.Players.GetScopedPlayerIds getScopedPlayerIds()
                                                    throws IOException

Retrieves scoped player identifiers for currently authenticated user. Create a request for the method "players.getScopedPlayerIds". This request holds the parameters needed by the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Returns:

the request

Throws:

IOException

list

public Games.Players.List list(String collection)
                        throws IOException

Get the collection of players for the currently authenticated user. Create a request for the method "players.list". This request holds the parameters needed by the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

collection - Collection of players being retrieved

Returns:

the request

Throws:

IOException