| 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.Players.List
Description
Get the collection of players for the currently authenticated user.
See: Google Play Game Services API Reference for games.players.list.
- 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
Arguments
| :: PlayersListCollection | |
| -> 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.
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.