Copyright	(c) 2015-2016 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

Contents

REST Resource
Creating a Request
Request Lenses

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

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

scoresListWindow Source #

Arguments

:: ScoresListWindowCollection	`slwCollection`
-> ScoresListWindowTimeSpan	`slwTimeSpan`
-> Text	`slwLeaderboardId`
-> 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.

Instances

Eq ScoresListWindow Source #
Instance details Defined in Network.Google.Resource.Games.Scores.ListWindow Methods (==) :: ScoresListWindow -> ScoresListWindow -> Bool # (/=) :: ScoresListWindow -> ScoresListWindow -> Bool #
Data ScoresListWindow Source #
Instance details Defined in Network.Google.Resource.Games.Scores.ListWindow 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 #
Instance details Defined in Network.Google.Resource.Games.Scores.ListWindow Methods showsPrec :: Int -> ScoresListWindow -> ShowS # show :: ScoresListWindow -> String # showList :: [ScoresListWindow] -> ShowS #
Generic ScoresListWindow Source #
Instance details Defined in Network.Google.Resource.Games.Scores.ListWindow Associated Types type Rep ScoresListWindow :: Type -> Type # Methods from :: ScoresListWindow -> Rep ScoresListWindow x # to :: Rep ScoresListWindow x -> ScoresListWindow #
GoogleRequest ScoresListWindow Source #
Instance details Defined in Network.Google.Resource.Games.Scores.ListWindow Associated Types type Rs ScoresListWindow :: Type # type Scopes ScoresListWindow :: [Symbol] # Methods requestClient :: ScoresListWindow -> GClient (Rs ScoresListWindow) #
type Rep ScoresListWindow Source #
Instance details Defined in Network.Google.Resource.Games.Scores.ListWindow type Rep ScoresListWindow = D1 (MetaData "ScoresListWindow" "Network.Google.Resource.Games.Scores.ListWindow" "gogol-games-0.4.0-EPjClsFfNAGupIHqlLfHm" False) (C1 (MetaCons "ScoresListWindow'" PrefixI True) (((S1 (MetaSel (Just "_slwCollection") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ScoresListWindowCollection) :: S1 (MetaSel (Just "_slwTimeSpan") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ScoresListWindowTimeSpan)) :: (S1 (MetaSel (Just "_slwReturnTopIfAbsent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :: S1 (MetaSel (Just "_slwLeaderboardId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) :: ((S1 (MetaSel (Just "_slwLanguage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_slwResultsAbove") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32)))) :: (S1 (MetaSel (Just "_slwPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_slwMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32)))))))
type Scopes ScoresListWindow Source #
Instance details Defined in Network.Google.Resource.Games.Scores.ListWindow type Scopes ScoresListWindow = "https://www.googleapis.com/auth/games" ': ([] :: [Symbol])
type Rs ScoresListWindow Source #
Instance details Defined in Network.Google.Resource.Games.Scores.ListWindow type Rs ScoresListWindow = LeaderboardScores

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.