| Copyright | (c) 2015 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.Google.Resource.Games.Scores.ListWindow
Description
Lists the scores in a leaderboard around (and including) a player's score.
See: Google Play Game Services API Reference for games.scores.listWindow.
- type ScoresListWindowResource = "games" :> ("v1" :> ("leaderboards" :> (Capture "leaderboardId" Text :> ("window" :> (Capture "collection" ScoresListWindowCollection :> (QueryParam "timeSpan" ScoresListWindowTimeSpan :> (QueryParam "returnTopIfAbsent" Bool :> (QueryParam "language" Text :> (QueryParam "resultsAbove" (Textual Int32) :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` LeaderboardScores))))))))))))
- scoresListWindow :: ScoresListWindowCollection -> ScoresListWindowTimeSpan -> Text -> ScoresListWindow
- data ScoresListWindow
- slwCollection :: Lens' ScoresListWindow ScoresListWindowCollection
- slwTimeSpan :: Lens' ScoresListWindow ScoresListWindowTimeSpan
- slwReturnTopIfAbsent :: Lens' ScoresListWindow (Maybe Bool)
- slwLeaderboardId :: Lens' ScoresListWindow Text
- slwLanguage :: Lens' ScoresListWindow (Maybe Text)
- slwResultsAbove :: Lens' ScoresListWindow (Maybe Int32)
- slwPageToken :: Lens' ScoresListWindow (Maybe Text)
- slwMaxResults :: Lens' ScoresListWindow (Maybe Int32)
REST Resource
type ScoresListWindowResource = "games" :> ("v1" :> ("leaderboards" :> (Capture "leaderboardId" Text :> ("window" :> (Capture "collection" ScoresListWindowCollection :> (QueryParam "timeSpan" ScoresListWindowTimeSpan :> (QueryParam "returnTopIfAbsent" Bool :> (QueryParam "language" Text :> (QueryParam "resultsAbove" (Textual Int32) :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` LeaderboardScores)))))))))))) Source
A resource alias for games.scores.listWindow method which the
ScoresListWindow request conforms to.
Creating a Request
Arguments
| :: ScoresListWindowCollection | |
| -> ScoresListWindowTimeSpan | |
| -> Text | |
| -> ScoresListWindow |
Creates a value of ScoresListWindow with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ScoresListWindow Source
Lists the scores in a leaderboard around (and including) a player's score.
See: scoresListWindow smart constructor.
Request Lenses
slwCollection :: Lens' ScoresListWindow ScoresListWindowCollection Source
The collection of scores you're requesting.
slwTimeSpan :: Lens' ScoresListWindow ScoresListWindowTimeSpan Source
The time span for the scores and ranks you're requesting.
slwReturnTopIfAbsent :: Lens' ScoresListWindow (Maybe Bool) Source
True if the top scores should be returned when the player is not in the leaderboard. Defaults to true.
slwLeaderboardId :: Lens' ScoresListWindow Text Source
The ID of the leaderboard.
slwLanguage :: Lens' ScoresListWindow (Maybe Text) Source
The preferred language to use for strings returned by this method.
slwResultsAbove :: Lens' ScoresListWindow (Maybe Int32) Source
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.
slwPageToken :: Lens' ScoresListWindow (Maybe Text) Source
The token returned by the previous request.
slwMaxResults :: Lens' ScoresListWindow (Maybe Int32) Source
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.