gogol-games-0.2.0: Google Play Game Services SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.Games.Scores.ListWindow

Contents

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.

Synopsis

REST Resource

type ScoresListWindowResource = "games" :> ("v1" :> ("leaderboards" :> (Capture "leaderboardId" Text :> ("window" :> (Capture "collection" ScoresListWindowCollection :> (QueryParam "timeSpan" ScoresListWindowTimeSpan :> (QueryParam "consistencyToken" (Textual Int64) :> (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

data ScoresListWindow Source #

Lists the scores in a leaderboard around (and including) a player's score.

See: scoresListWindow smart constructor.

Instances

Eq ScoresListWindow Source # 
Data ScoresListWindow Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ScoresListWindow -> c ScoresListWindow #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ScoresListWindow #

toConstr :: ScoresListWindow -> Constr #

dataTypeOf :: ScoresListWindow -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ScoresListWindow) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ScoresListWindow) #

gmapT :: (forall b. Data b => b -> b) -> ScoresListWindow -> ScoresListWindow #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ScoresListWindow -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ScoresListWindow -> r #

gmapQ :: (forall d. Data d => d -> u) -> ScoresListWindow -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ScoresListWindow -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ScoresListWindow -> m ScoresListWindow #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ScoresListWindow -> m ScoresListWindow #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ScoresListWindow -> m ScoresListWindow #

Show ScoresListWindow Source # 
Generic ScoresListWindow Source # 
GoogleRequest ScoresListWindow Source # 
type Rep ScoresListWindow Source # 
type Scopes ScoresListWindow Source # 
type Scopes ScoresListWindow = (:) Symbol "https://www.googleapis.com/auth/games" ((:) Symbol "https://www.googleapis.com/auth/plus.login" ([] Symbol))
type Rs ScoresListWindow Source # 

Request Lenses

slwConsistencyToken :: Lens' ScoresListWindow (Maybe Int64) Source #

The last-seen mutation timestamp.

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.