Games.Scores.ListWindow (Google Play Games Services API v1-rev20251003-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,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:

Cloneable, Map<String,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
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

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

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ListWindow(String leaderboardId, String collection, String timeSpan)` Lists the scores in a leaderboard around (and including) a player's score.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.client.http.HttpRequest`	`buildHttpRequestUsingHead()`
`com.google.api.client.http.HttpResponse`	`executeUsingHead()`
`String`	`getCollection()` The collection of scores you're requesting.
`String`	`getLanguage()` The preferred language to use for strings returned by this method.
`String`	`getLeaderboardId()` The ID of the leaderboard.
`Integer`	`getMaxResults()` The maximum number of leaderboard scores to return in the response.
`String`	`getPageToken()` The token returned by the previous request.
`Integer`	`getResultsAbove()` The preferred number of scores to return above the player's score.
`Boolean`	`getReturnTopIfAbsent()` True if the top scores should be returned when the player is not in the leaderboard.
`String`	`getTimeSpan()` Required.
`Games.Scores.ListWindow`	`set(String parameterName, Object value)`
`Games.Scores.ListWindow`	`set$Xgafv(String $Xgafv)` V1 error format.
`Games.Scores.ListWindow`	`setAccessToken(String accessToken)` OAuth access token.
`Games.Scores.ListWindow`	`setAlt(String alt)` Data format for response.
`Games.Scores.ListWindow`	`setCallback(String callback)` JSONP
`Games.Scores.ListWindow`	`setCollection(String collection)` The collection of scores you're requesting.
`Games.Scores.ListWindow`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Games.Scores.ListWindow`	`setKey(String key)` API key.
`Games.Scores.ListWindow`	`setLanguage(String language)` The preferred language to use for strings returned by this method.
`Games.Scores.ListWindow`	`setLeaderboardId(String leaderboardId)` The ID of the leaderboard.
`Games.Scores.ListWindow`	`setMaxResults(Integer maxResults)` The maximum number of leaderboard scores to return in the response.
`Games.Scores.ListWindow`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Games.Scores.ListWindow`	`setPageToken(String pageToken)` The token returned by the previous request.
`Games.Scores.ListWindow`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Games.Scores.ListWindow`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Games.Scores.ListWindow`	`setResultsAbove(Integer resultsAbove)` The preferred number of scores to return above the player's score.
`Games.Scores.ListWindow`	`setReturnTopIfAbsent(Boolean returnTopIfAbsent)` True if the top scores should be returned when the player is not in the leaderboard.
`Games.Scores.ListWindow`	`setTimeSpan(String timeSpan)` Required.
`Games.Scores.ListWindow`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`Games.Scores.ListWindow`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.games.GamesRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, 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, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

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

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

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

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - ListWindow
```
protected ListWindow(String leaderboardId,
                     String collection,
                     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 - Required. 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 IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<LeaderboardScores>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<LeaderboardScores>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public Games.Scores.ListWindow set$Xgafv(String $Xgafv)
```
    Description copied from class: GamesRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class GamesRequest<LeaderboardScores>
  - setAccessToken
```
public Games.Scores.ListWindow setAccessToken(String accessToken)
```
    Description copied from class: GamesRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class GamesRequest<LeaderboardScores>
  - setAlt
```
public Games.Scores.ListWindow setAlt(String alt)
```
    Description copied from class: GamesRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class GamesRequest<LeaderboardScores>
  - setCallback
```
public Games.Scores.ListWindow setCallback(String callback)
```
    Description copied from class: GamesRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class GamesRequest<LeaderboardScores>
  - setFields
```
public Games.Scores.ListWindow setFields(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(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(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(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(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:
    
    setQuotaUser in class GamesRequest<LeaderboardScores>
  - setUploadType
```
public Games.Scores.ListWindow setUploadType(String uploadType)
```
    Description copied from class: GamesRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class GamesRequest<LeaderboardScores>
  - setUploadProtocol
```
public Games.Scores.ListWindow setUploadProtocol(String uploadProtocol)
```
    Description copied from class: GamesRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class GamesRequest<LeaderboardScores>
  - getLeaderboardId
```
public String getLeaderboardId()
```
    The ID of the leaderboard.
  - setLeaderboardId
```
public Games.Scores.ListWindow setLeaderboardId(String leaderboardId)
```
    The ID of the leaderboard.
  - getCollection
```
public String getCollection()
```
    The collection of scores you're requesting.
  - setCollection
```
public Games.Scores.ListWindow setCollection(String collection)
```
    The collection of scores you're requesting.
  - getTimeSpan
```
public String getTimeSpan()
```
    Required. The time span for the scores and ranks you're requesting.
  - setTimeSpan
```
public Games.Scores.ListWindow setTimeSpan(String timeSpan)
```
    Required. The time span for the scores and ranks you're requesting.
  - getLanguage
```
public String getLanguage()
```
    The preferred language to use for strings returned by this method.
  - setLanguage
```
public Games.Scores.ListWindow setLanguage(String language)
```
    The preferred language to use for strings returned by this method.
  - getMaxResults
```
public 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`.
  - setMaxResults
```
public Games.Scores.ListWindow setMaxResults(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 String getPageToken()
```
    The token returned by the previous request.
  - setPageToken
```
public Games.Scores.ListWindow setPageToken(String pageToken)
```
    The token returned by the previous request.
  - getResultsAbove
```
public 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(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 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(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(String parameterName,
                                   Object value)
```
    Overrides:
    
    set in class GamesRequest<LeaderboardScores>

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

Methods inherited from interface java.util.Map

Constructor Detail

ListWindow

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getLeaderboardId

setLeaderboardId

getCollection

setCollection

getTimeSpan

setTimeSpan

getLanguage

setLanguage

getMaxResults

setMaxResults

getPageToken

setPageToken

getResultsAbove

setResultsAbove

getReturnTopIfAbsent

setReturnTopIfAbsent

set