| 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.TurnBasedMatches.LeaveTurn
Description
Leave a turn-based match during the current player's turn, without canceling the match.
See: Google Play Game Services API Reference for games.turnBasedMatches.leaveTurn.
- type TurnBasedMatchesLeaveTurnResource = "games" :> ("v1" :> ("turnbasedmatches" :> (Capture "matchId" Text :> ("leaveTurn" :> (QueryParam "matchVersion" (Textual Int32) :> (QueryParam "language" Text :> (QueryParam "pendingParticipantId" Text :> (QueryParam "alt" AltJSON :> Put `[JSON]` TurnBasedMatch))))))))
- turnBasedMatchesLeaveTurn :: Text -> Int32 -> TurnBasedMatchesLeaveTurn
- data TurnBasedMatchesLeaveTurn
- tbmltLanguage :: Lens' TurnBasedMatchesLeaveTurn (Maybe Text)
- tbmltPendingParticipantId :: Lens' TurnBasedMatchesLeaveTurn (Maybe Text)
- tbmltMatchId :: Lens' TurnBasedMatchesLeaveTurn Text
- tbmltMatchVersion :: Lens' TurnBasedMatchesLeaveTurn Int32
REST Resource
type TurnBasedMatchesLeaveTurnResource = "games" :> ("v1" :> ("turnbasedmatches" :> (Capture "matchId" Text :> ("leaveTurn" :> (QueryParam "matchVersion" (Textual Int32) :> (QueryParam "language" Text :> (QueryParam "pendingParticipantId" Text :> (QueryParam "alt" AltJSON :> Put `[JSON]` TurnBasedMatch)))))))) Source
A resource alias for games.turnBasedMatches.leaveTurn method which the
TurnBasedMatchesLeaveTurn request conforms to.
Creating a Request
turnBasedMatchesLeaveTurn Source
Arguments
| :: Text | |
| -> Int32 | |
| -> TurnBasedMatchesLeaveTurn |
Creates a value of TurnBasedMatchesLeaveTurn with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data TurnBasedMatchesLeaveTurn Source
Leave a turn-based match during the current player's turn, without canceling the match.
See: turnBasedMatchesLeaveTurn smart constructor.
Instances
Request Lenses
tbmltLanguage :: Lens' TurnBasedMatchesLeaveTurn (Maybe Text) Source
The preferred language to use for strings returned by this method.
tbmltPendingParticipantId :: Lens' TurnBasedMatchesLeaveTurn (Maybe Text) Source
The ID of another participant who should take their turn next. If not set, the match will wait for other player(s) to join via automatching; this is only valid if automatch criteria is set on the match with remaining slots for automatched players.
tbmltMatchId :: Lens' TurnBasedMatchesLeaveTurn Text Source
The ID of the match.
tbmltMatchVersion :: Lens' TurnBasedMatchesLeaveTurn Int32 Source
The version of the match being updated.