Network.Google.Resource.Games.Players.List

Get the collection of players for the currently authenticated user.

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

REST Resource

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

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

Creating a Request

playersList

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:

• plConsistencyToken
• plCollection
• plLanguage
• plPageToken
• plMaxResults

data PlayersList

Get the collection of players for the currently authenticated user.

See: playersList smart constructor.

Instances

Eq PlayersList

Methods

(==) :: PlayersList -> PlayersList -> Bool

(/=) :: PlayersList -> PlayersList -> Bool

Data PlayersList

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

Methods

showsPrec :: Int -> PlayersList -> ShowS

show :: PlayersList -> String

showList :: [PlayersList] -> ShowS

Generic PlayersList

Associated Types

type Rep PlayersList :: * -> *

Methods

from :: PlayersList -> Rep PlayersList x

to :: Rep PlayersList x -> PlayersList

GoogleRequest PlayersList

Associated Types

type Rs PlayersList :: *

type Scopes PlayersList :: [Symbol]

Methods

requestClient :: PlayersList -> Client (Rs PlayersList)

type Rep PlayersList

type Rep PlayersList = D1 (MetaData "PlayersList" "Network.Google.Resource.Games.Players.List" "gogol-games-0.3.0-8BCKppY4rzpLLml8wyBtKz" False) (C1 (MetaCons "PlayersList'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_plConsistencyToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64)))) (S1 (MetaSel (Just Symbol "_plCollection") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 PlayersListCollection))) ((:*:) (S1 (MetaSel (Just Symbol "_plLanguage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_plPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_plMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))))))))

type Scopes PlayersList

type Scopes PlayersList = (:) Symbol "https://www.googleapis.com/auth/games" ((:) Symbol "https://www.googleapis.com/auth/plus.login" ([] Symbol))

type Rs PlayersList

type Rs PlayersList = PlayerListResponse

Request Lenses

plConsistencyToken :: Lens' PlayersList (Maybe Int64)

The last-seen mutation timestamp.

plCollection :: Lens' PlayersList PlayersListCollection

Collection of players being retrieved

plLanguage :: Lens' PlayersList (Maybe Text)

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

plPageToken :: Lens' PlayersList (Maybe Text)

The token returned by the previous request.

plMaxResults :: Lens' PlayersList (Maybe Int32)

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.