Games.Players.List (Google Play Game Services API v1 (Rev. 232) 1.21.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
    - - com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
      - com.google.api.services.games.GamesRequest<PlayerListResponse>
        
        com.google.api.services.games.Games.Players.List

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

Games.Players
```
public class Games.Players.List
extends GamesRequest<PlayerListResponse>
```

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Field Summary
- Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
  USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected Games.Players.List(java.lang.String collection)
Get the collection of players for the currently authenticated user.

Constructors
Modifier	Constructor and Description
`protected`	`Games.Players.List(java.lang.String collection)` Get the collection of players for the currently authenticated user.

Method Summary

Methods
Modifier and Type	Method and Description
`com.google.api.client.http.HttpRequest`	`buildHttpRequestUsingHead()`
`com.google.api.client.http.HttpResponse`	`executeUsingHead()`
`java.lang.String`	`getCollection()` Collection of players being retrieved
`java.lang.Long`	`getConsistencyToken()` The last-seen mutation timestamp.
`java.lang.String`	`getLanguage()` The preferred language to use for strings returned by this method.
`java.lang.Integer`	`getMaxResults()` The maximum number of player resources to return in the response, used for paging.
`java.lang.String`	`getPageToken()` The token returned by the previous request.
`Games.Players.List`	`set(java.lang.String parameterName, java.lang.Object value)`
`Games.Players.List`	`setAlt(java.lang.String alt)` Data format for the response.
`Games.Players.List`	`setCollection(java.lang.String collection)` Collection of players being retrieved
`Games.Players.List`	`setConsistencyToken(java.lang.Long consistencyToken)` The last-seen mutation timestamp.
`Games.Players.List`	`setFields(java.lang.String fields)` Selector specifying which fields to include in a partial response.
`Games.Players.List`	`setKey(java.lang.String key)` API key.
`Games.Players.List`	`setLanguage(java.lang.String language)` The preferred language to use for strings returned by this method.
`Games.Players.List`	`setMaxResults(java.lang.Integer maxResults)` The maximum number of player resources to return in the response, used for paging.
`Games.Players.List`	`setOauthToken(java.lang.String oauthToken)` OAuth 2.0 token for the current user.
`Games.Players.List`	`setPageToken(java.lang.String pageToken)` The token returned by the previous request.
`Games.Players.List`	`setPrettyPrint(java.lang.Boolean prettyPrint)` Returns response with indentations and line breaks.
`Games.Players.List`	`setQuotaUser(java.lang.String quotaUser)` Available to use for quota purposes for server-side applications.
`Games.Players.List`	`setUserIp(java.lang.String userIp)` IP address of the site where the request originates.

Methods inherited from class com.google.api.services.games.GamesRequest
getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Games.Players.List
```
protected Games.Players.List(java.lang.String collection)
```
    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 the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    Games.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    collection - Collection of players being retrieved
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws java.io.IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<PlayerListResponse>
    
    Throws:
    
    java.io.IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws java.io.IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<PlayerListResponse>
    
    Throws:
    
    java.io.IOException
  - setAlt
```
public Games.Players.List setAlt(java.lang.String alt)
```
    Description copied from class: GamesRequest
    
    Data format for the response.
    
    Overrides:
    
    setAlt in class GamesRequest<PlayerListResponse>
  - setFields
```
public Games.Players.List setFields(java.lang.String fields)
```
    Description copied from class: GamesRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class GamesRequest<PlayerListResponse>
  - setKey
```
public Games.Players.List setKey(java.lang.String key)
```
    Description copied from class: GamesRequest
    
    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    
    Overrides:
    
    setKey in class GamesRequest<PlayerListResponse>
  - setOauthToken
```
public Games.Players.List setOauthToken(java.lang.String oauthToken)
```
    Description copied from class: GamesRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class GamesRequest<PlayerListResponse>
  - setPrettyPrint
```
public Games.Players.List setPrettyPrint(java.lang.Boolean prettyPrint)
```
    Description copied from class: GamesRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class GamesRequest<PlayerListResponse>
  - setQuotaUser
```
public Games.Players.List setQuotaUser(java.lang.String quotaUser)
```
    Description copied from class: GamesRequest
    
    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
    
    Overrides:
    
    setQuotaUser in class GamesRequest<PlayerListResponse>
  - setUserIp
```
public Games.Players.List setUserIp(java.lang.String userIp)
```
    Description copied from class: GamesRequest
    
    IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    
    Overrides:
    
    setUserIp in class GamesRequest<PlayerListResponse>
  - getCollection
```
public java.lang.String getCollection()
```
    Collection of players being retrieved
  - setCollection
```
public Games.Players.List setCollection(java.lang.String collection)
```
    Collection of players being retrieved
  - getConsistencyToken
```
public java.lang.Long getConsistencyToken()
```
    The last-seen mutation timestamp.
  - setConsistencyToken
```
public Games.Players.List setConsistencyToken(java.lang.Long consistencyToken)
```
    The last-seen mutation timestamp.
  - getLanguage
```
public java.lang.String getLanguage()
```
    The preferred language to use for strings returned by this method.
  - setLanguage
```
public Games.Players.List setLanguage(java.lang.String language)
```
    The preferred language to use for strings returned by this method.
  - getMaxResults
```
public java.lang.Integer getMaxResults()
```
    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. [minimum: 1] [maximum: 50]
  - setMaxResults
```
public Games.Players.List setMaxResults(java.lang.Integer 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.
  - getPageToken
```
public java.lang.String getPageToken()
```
    The token returned by the previous request.
  - setPageToken
```
public Games.Players.List setPageToken(java.lang.String pageToken)
```
    The token returned by the previous request.
  - set
```
public Games.Players.List set(java.lang.String parameterName,
                     java.lang.Object value)
```
    Overrides:
    
    set in class GamesRequest<PlayerListResponse>

Google Play Game Services API v1 (revision 232)

Class Games.Players.List

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.games.GamesRequest

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Constructor Detail

Games.Players.List

Method Detail

executeUsingHead

buildHttpRequestUsingHead

setAlt

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUserIp

getCollection

setCollection

getConsistencyToken

setConsistencyToken

getLanguage

setLanguage

getMaxResults

setMaxResults

getPageToken

setPageToken

set