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.Rooms.Leave

Contents

REST Resource
Creating a Request
Request Lenses

Description

Leave a room. For internal use by the Games SDK only. Calling this method directly is unsupported.

See: Google Play Game Services API Reference for games.rooms.leave.

Synopsis

type RoomsLeaveResource = "games" :> ("v1" :> ("rooms" :> (Capture "roomId" Text :> ("leave" :> (QueryParam "language" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] RoomLeaveRequest :> Post '[JSON] Room)))))))
roomsLeave :: RoomLeaveRequest -> Text -> RoomsLeave
data RoomsLeave
rlPayload :: Lens' RoomsLeave RoomLeaveRequest
rlRoomId :: Lens' RoomsLeave Text
rlLanguage :: Lens' RoomsLeave (Maybe Text)

REST Resource

type RoomsLeaveResource = "games" :> ("v1" :> ("rooms" :> (Capture "roomId" Text :> ("leave" :> (QueryParam "language" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] RoomLeaveRequest :> Post '[JSON] Room))))))) Source #

A resource alias for games.rooms.leave method which the RoomsLeave request conforms to.

Creating a Request

roomsLeave Source #

Arguments

:: RoomLeaveRequest	`rlPayload`
-> Text	`rlRoomId`
-> RoomsLeave

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

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

data RoomsLeave Source #

Leave a room. For internal use by the Games SDK only. Calling this method directly is unsupported.

See: roomsLeave smart constructor.

Instances

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

Request Lenses

rlPayload :: Lens' RoomsLeave RoomLeaveRequest Source #

Multipart request metadata.

rlRoomId :: Lens' RoomsLeave Text Source #

The ID of the room.

rlLanguage :: Lens' RoomsLeave (Maybe Text) Source #

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