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.Join

Contents

REST Resource
Creating a Request
Request Lenses

Description

Join 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.join.

Synopsis

REST Resource

type RoomsJoinResource = "games" :> ("v1" :> ("rooms" :> (Capture "roomId" Text :> ("join" :> (QueryParam "consistencyToken" (Textual Int64) :> (QueryParam "language" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] RoomJoinRequest :> Post '[JSON] Room)))))))) Source #

A resource alias for games.rooms.join method which the RoomsJoin request conforms to.

Creating a Request

roomsJoin Source #

Arguments

:: RoomJoinRequest	`rjPayload`
-> Text	`rjRoomId`
-> RoomsJoin

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

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

data RoomsJoin Source #

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

See: roomsJoin smart constructor.

Instances

Eq RoomsJoin Source #
Methods (==) :: RoomsJoin -> RoomsJoin -> Bool # (/=) :: RoomsJoin -> RoomsJoin -> Bool #
Data RoomsJoin Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RoomsJoin -> c RoomsJoin # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RoomsJoin # toConstr :: RoomsJoin -> Constr # dataTypeOf :: RoomsJoin -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c RoomsJoin) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RoomsJoin) # gmapT :: (forall b. Data b => b -> b) -> RoomsJoin -> RoomsJoin # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RoomsJoin -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RoomsJoin -> r # gmapQ :: (forall d. Data d => d -> u) -> RoomsJoin -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> RoomsJoin -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> RoomsJoin -> m RoomsJoin # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RoomsJoin -> m RoomsJoin # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RoomsJoin -> m RoomsJoin #
Show RoomsJoin Source #
Methods showsPrec :: Int -> RoomsJoin -> ShowS # show :: RoomsJoin -> String # showList :: [RoomsJoin] -> ShowS #
Generic RoomsJoin Source #
Associated Types type Rep RoomsJoin :: * -> * # Methods from :: RoomsJoin -> Rep RoomsJoin x # to :: Rep RoomsJoin x -> RoomsJoin #
GoogleRequest RoomsJoin Source #
Associated Types type Rs RoomsJoin :: * # type Scopes RoomsJoin :: [Symbol] # Methods requestClient :: RoomsJoin -> Client (Rs RoomsJoin) #
type Rep RoomsJoin Source #
type Rep RoomsJoin = D1 (MetaData "RoomsJoin" "Network.Google.Resource.Games.Rooms.Join" "gogol-games-0.3.0-8BCKppY4rzpLLml8wyBtKz" False) (C1 (MetaCons "RoomsJoin'" PrefixI True) ((::) ((::) (S1 (MetaSel (Just Symbol "_rjConsistencyToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64)))) (S1 (MetaSel (Just Symbol "_rjPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 RoomJoinRequest))) ((:*:) (S1 (MetaSel (Just Symbol "_rjRoomId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_rjLanguage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes RoomsJoin Source #
type Scopes RoomsJoin = (:) Symbol "https://www.googleapis.com/auth/games" ((:) Symbol "https://www.googleapis.com/auth/plus.login" ([] Symbol))
type Rs RoomsJoin Source #
type Rs RoomsJoin = Room

Request Lenses

rjConsistencyToken :: Lens' RoomsJoin (Maybe Int64) Source #

The last-seen mutation timestamp.

rjPayload :: Lens' RoomsJoin RoomJoinRequest Source #

Multipart request metadata.

rjRoomId :: Lens' RoomsJoin Text Source #

The ID of the room.

rjLanguage :: Lens' RoomsJoin (Maybe Text) Source #

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