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.Players.List

Contents

REST Resource
Creating a Request
Request Lenses

Description

Get the collection of players for the currently authenticated user.

See: Google Play Game Services API Reference for games.players.list.

Synopsis

type PlayersListResource = "games" :> ("v1" :> ("players" :> ("me" :> ("players" :> (Capture "collection" PlayersListCollection :> (QueryParam "language" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] PlayerListResponse)))))))))
playersList :: PlayersListCollection -> PlayersList
data PlayersList
plCollection :: Lens' PlayersList PlayersListCollection
plLanguage :: Lens' PlayersList (Maybe Text)
plPageToken :: Lens' PlayersList (Maybe Text)
plMaxResults :: Lens' PlayersList (Maybe Int32)

REST Resource

type PlayersListResource = "games" :> ("v1" :> ("players" :> ("me" :> ("players" :> (Capture "collection" PlayersListCollection :> (QueryParam "language" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] PlayerListResponse))))))))) Source #

A resource alias for games.players.list method which the PlayersList request conforms to.

Creating a Request

playersList Source #

Arguments

:: PlayersListCollection	`plCollection`
-> PlayersList

Creates a value of PlayersList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data PlayersList Source #

Get the collection of players for the currently authenticated user.

See: playersList smart constructor.

Instances

Eq PlayersList Source #
Instance details Defined in Network.Google.Resource.Games.Players.List Methods (==) :: PlayersList -> PlayersList -> Bool # (/=) :: PlayersList -> PlayersList -> Bool #
Data PlayersList Source #
Instance details Defined in Network.Google.Resource.Games.Players.List Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PlayersList -> c PlayersList # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PlayersList # toConstr :: PlayersList -> Constr # dataTypeOf :: PlayersList -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PlayersList) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PlayersList) # gmapT :: (forall b. Data b => b -> b) -> PlayersList -> PlayersList # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PlayersList -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PlayersList -> r # gmapQ :: (forall d. Data d => d -> u) -> PlayersList -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> PlayersList -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> PlayersList -> m PlayersList # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PlayersList -> m PlayersList # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PlayersList -> m PlayersList #
Show PlayersList Source #
Instance details Defined in Network.Google.Resource.Games.Players.List Methods showsPrec :: Int -> PlayersList -> ShowS # show :: PlayersList -> String # showList :: [PlayersList] -> ShowS #
Generic PlayersList Source #
Instance details Defined in Network.Google.Resource.Games.Players.List Associated Types type Rep PlayersList :: Type -> Type # Methods from :: PlayersList -> Rep PlayersList x # to :: Rep PlayersList x -> PlayersList #
GoogleRequest PlayersList Source #
Instance details Defined in Network.Google.Resource.Games.Players.List Associated Types type Rs PlayersList :: Type # type Scopes PlayersList :: [Symbol] # Methods requestClient :: PlayersList -> GClient (Rs PlayersList) #
type Rep PlayersList Source #
Instance details Defined in Network.Google.Resource.Games.Players.List type Rep PlayersList = D1 (MetaData "PlayersList" "Network.Google.Resource.Games.Players.List" "gogol-games-0.4.0-EPjClsFfNAGupIHqlLfHm" False) (C1 (MetaCons "PlayersList'" PrefixI True) ((S1 (MetaSel (Just "_plCollection") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 PlayersListCollection) :: S1 (MetaSel (Just "_plLanguage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_plPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_plMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))))))
type Scopes PlayersList Source #
Instance details Defined in Network.Google.Resource.Games.Players.List type Scopes PlayersList = "https://www.googleapis.com/auth/games" ': ([] :: [Symbol])
type Rs PlayersList Source #
Instance details Defined in Network.Google.Resource.Games.Players.List type Rs PlayersList = PlayerListResponse

Request Lenses

plCollection :: Lens' PlayersList PlayersListCollection Source #

Collection of players being retrieved

plLanguage :: Lens' PlayersList (Maybe Text) Source #

The preferred language to use for strings returned by this method.

plPageToken :: Lens' PlayersList (Maybe Text) Source #

The token returned by the previous request.

plMaxResults :: Lens' PlayersList (Maybe Int32) Source #

The maximum number of player resources to return in the response, used for paging. For any response, the actual number of player resources returned may be less than the specified maxResults.