Games.Scores.ListWindow (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<LeaderboardScores>
        
        com.google.api.services.games.Games.Scores.ListWindow

All Implemented Interfaces:

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

Enclosing class:

Games.Scores
```
public class Games.Scores.ListWindow
extends GamesRequest<LeaderboardScores>
```

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.Scores.ListWindow(java.lang.String leaderboardId, java.lang.String collection, java.lang.String timeSpan)` Lists the scores in a leaderboard around (and including) a player's score.

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()` The collection of scores you're requesting.
`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.String`	`getLeaderboardId()` The ID of the leaderboard.
`java.lang.Integer`	`getMaxResults()` The maximum number of leaderboard scores to return in the response.
`java.lang.String`	`getPageToken()` The token returned by the previous request.
`java.lang.Integer`	`getResultsAbove()` The preferred number of scores to return above the player's score.
`java.lang.Boolean`	`getReturnTopIfAbsent()` True if the top scores should be returned when the player is not in the leaderboard.
`java.lang.String`	`getTimeSpan()` The time span for the scores and ranks you're requesting.
`Games.Scores.ListWindow`	`set(java.lang.String parameterName, java.lang.Object value)`
`Games.Scores.ListWindow`	`setAlt(java.lang.String alt)` Data format for the response.
`Games.Scores.ListWindow`	`setCollection(java.lang.String collection)` The collection of scores you're requesting.
`Games.Scores.ListWindow`	`setConsistencyToken(java.lang.Long consistencyToken)` The last-seen mutation timestamp.
`Games.Scores.ListWindow`	`setFields(java.lang.String fields)` Selector specifying which fields to include in a partial response.
`Games.Scores.ListWindow`	`setKey(java.lang.String key)` API key.
`Games.Scores.ListWindow`	`setLanguage(java.lang.String language)` The preferred language to use for strings returned by this method.
`Games.Scores.ListWindow`	`setLeaderboardId(java.lang.String leaderboardId)` The ID of the leaderboard.
`Games.Scores.ListWindow`	`setMaxResults(java.lang.Integer maxResults)` The maximum number of leaderboard scores to return in the response.
`Games.Scores.ListWindow`	`setOauthToken(java.lang.String oauthToken)` OAuth 2.0 token for the current user.
`Games.Scores.ListWindow`	`setPageToken(java.lang.String pageToken)` The token returned by the previous request.
`Games.Scores.ListWindow`	`setPrettyPrint(java.lang.Boolean prettyPrint)` Returns response with indentations and line breaks.
`Games.Scores.ListWindow`	`setQuotaUser(java.lang.String quotaUser)` Available to use for quota purposes for server-side applications.
`Games.Scores.ListWindow`	`setResultsAbove(java.lang.Integer resultsAbove)` The preferred number of scores to return above the player's score.
`Games.Scores.ListWindow`	`setReturnTopIfAbsent(java.lang.Boolean returnTopIfAbsent)` True if the top scores should be returned when the player is not in the leaderboard.
`Games.Scores.ListWindow`	`setTimeSpan(java.lang.String timeSpan)` The time span for the scores and ranks you're requesting.
`Games.Scores.ListWindow`	`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.Scores.ListWindow
```
protected Games.Scores.ListWindow(java.lang.String leaderboardId,
                       java.lang.String collection,
                       java.lang.String timeSpan)
```
    Lists the scores in a leaderboard around (and including) a player's score. Create a request for the method "scores.listWindow". 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:
    leaderboardId - The ID of the leaderboard.
    collection - The collection of scores you're requesting.
    timeSpan - The time span for the scores and ranks you're requesting.
    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<LeaderboardScores>
    
    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<LeaderboardScores>
    
    Throws:
    
    java.io.IOException
  - setAlt
```
public Games.Scores.ListWindow setAlt(java.lang.String alt)
```
    Description copied from class: GamesRequest
    
    Data format for the response.
    
    Overrides:
    
    setAlt in class GamesRequest<LeaderboardScores>
  - setFields
```
public Games.Scores.ListWindow 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<LeaderboardScores>
  - setKey
```
public Games.Scores.ListWindow 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<LeaderboardScores>
  - setOauthToken
```
public Games.Scores.ListWindow setOauthToken(java.lang.String oauthToken)
```
    Description copied from class: GamesRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class GamesRequest<LeaderboardScores>
  - setPrettyPrint
```
public Games.Scores.ListWindow setPrettyPrint(java.lang.Boolean prettyPrint)
```
    Description copied from class: GamesRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class GamesRequest<LeaderboardScores>
  - setQuotaUser
```
public Games.Scores.ListWindow 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<LeaderboardScores>
  - setUserIp
```
public Games.Scores.ListWindow 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<LeaderboardScores>
  - getLeaderboardId
```
public java.lang.String getLeaderboardId()
```
    The ID of the leaderboard.
  - setLeaderboardId
```
public Games.Scores.ListWindow setLeaderboardId(java.lang.String leaderboardId)
```
    The ID of the leaderboard.
  - getCollection
```
public java.lang.String getCollection()
```
    The collection of scores you're requesting.
  - setCollection
```
public Games.Scores.ListWindow setCollection(java.lang.String collection)
```
    The collection of scores you're requesting.
  - getTimeSpan
```
public java.lang.String getTimeSpan()
```
    The time span for the scores and ranks you're requesting.
  - setTimeSpan
```
public Games.Scores.ListWindow setTimeSpan(java.lang.String timeSpan)
```
    The time span for the scores and ranks you're requesting.
  - getConsistencyToken
```
public java.lang.Long getConsistencyToken()
```
    The last-seen mutation timestamp.
  - setConsistencyToken
```
public Games.Scores.ListWindow 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.Scores.ListWindow 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 leaderboard scores to return in the response. For any response, the actual number of leaderboard scores returned may be less than the specified maxResults. [minimum: 1] [maximum: 30]
  - setMaxResults
```
public Games.Scores.ListWindow setMaxResults(java.lang.Integer maxResults)
```
    The maximum number of leaderboard scores to return in the response. For any response, the actual number of leaderboard scores returned may be less than the specified maxResults.
  - getPageToken
```
public java.lang.String getPageToken()
```
    The token returned by the previous request.
  - setPageToken
```
public Games.Scores.ListWindow setPageToken(java.lang.String pageToken)
```
    The token returned by the previous request.
  - getResultsAbove
```
public java.lang.Integer getResultsAbove()
```
    The preferred number of scores to return above the player's score. More scores may be returned if the player is at the bottom of the leaderboard; fewer may be returned if the player is at the top. Must be less than or equal to maxResults.
  - setResultsAbove
```
public Games.Scores.ListWindow setResultsAbove(java.lang.Integer resultsAbove)
```
    The preferred number of scores to return above the player's score. More scores may be returned if the player is at the bottom of the leaderboard; fewer may be returned if the player is at the top. Must be less than or equal to maxResults.
  - getReturnTopIfAbsent
```
public java.lang.Boolean getReturnTopIfAbsent()
```
    True if the top scores should be returned when the player is not in the leaderboard. Defaults to true.
  - setReturnTopIfAbsent
```
public Games.Scores.ListWindow setReturnTopIfAbsent(java.lang.Boolean returnTopIfAbsent)
```
    True if the top scores should be returned when the player is not in the leaderboard. Defaults to true.
  - set
```
public Games.Scores.ListWindow set(java.lang.String parameterName,
                          java.lang.Object value)
```
    Overrides:
    
    set in class GamesRequest<LeaderboardScores>

Google Play Game Services API v1 (revision 232)

Class Games.Scores.ListWindow

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.Scores.ListWindow

Method Detail

executeUsingHead

buildHttpRequestUsingHead

setAlt

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUserIp

getLeaderboardId

setLeaderboardId

getCollection

setCollection

getTimeSpan

setTimeSpan

getConsistencyToken

setConsistencyToken

getLanguage

setLanguage

getMaxResults

setMaxResults

getPageToken

setPageToken

getResultsAbove

setResultsAbove

getReturnTopIfAbsent

setReturnTopIfAbsent

set