gogol-games-0.4.0: Google Play Game Services SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.Games.TurnBasedMatches.Sync

Contents

Description

Returns turn-based matches the player is or was involved in that changed since the last sync call, with the least recent changes coming first. Matches that should be removed from the local cache will have a status of MATCH_DELETED.

See: Google Play Game Services API Reference for games.turnBasedMatches.sync.

Synopsis

REST Resource

type TurnBasedMatchesSyncResource = "games" :> ("v1" :> ("turnbasedmatches" :> ("sync" :> (QueryParam "maxCompletedMatches" (Textual Int32) :> (QueryParam "includeMatchData" Bool :> (QueryParam "language" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] TurnBasedMatchSync))))))))) Source #

A resource alias for games.turnBasedMatches.sync method which the TurnBasedMatchesSync request conforms to.

Creating a Request

turnBasedMatchesSync :: TurnBasedMatchesSync Source #

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

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

data TurnBasedMatchesSync Source #

Returns turn-based matches the player is or was involved in that changed since the last sync call, with the least recent changes coming first. Matches that should be removed from the local cache will have a status of MATCH_DELETED.

See: turnBasedMatchesSync smart constructor.

Instances
Eq TurnBasedMatchesSync Source # 
Instance details

Defined in Network.Google.Resource.Games.TurnBasedMatches.Sync

Data TurnBasedMatchesSync Source # 
Instance details

Defined in Network.Google.Resource.Games.TurnBasedMatches.Sync

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TurnBasedMatchesSync -> c TurnBasedMatchesSync #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TurnBasedMatchesSync #

toConstr :: TurnBasedMatchesSync -> Constr #

dataTypeOf :: TurnBasedMatchesSync -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c TurnBasedMatchesSync) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TurnBasedMatchesSync) #

gmapT :: (forall b. Data b => b -> b) -> TurnBasedMatchesSync -> TurnBasedMatchesSync #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TurnBasedMatchesSync -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TurnBasedMatchesSync -> r #

gmapQ :: (forall d. Data d => d -> u) -> TurnBasedMatchesSync -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> TurnBasedMatchesSync -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> TurnBasedMatchesSync -> m TurnBasedMatchesSync #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TurnBasedMatchesSync -> m TurnBasedMatchesSync #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TurnBasedMatchesSync -> m TurnBasedMatchesSync #

Show TurnBasedMatchesSync Source # 
Instance details

Defined in Network.Google.Resource.Games.TurnBasedMatches.Sync

Generic TurnBasedMatchesSync Source # 
Instance details

Defined in Network.Google.Resource.Games.TurnBasedMatches.Sync

Associated Types

type Rep TurnBasedMatchesSync :: Type -> Type #

GoogleRequest TurnBasedMatchesSync Source # 
Instance details

Defined in Network.Google.Resource.Games.TurnBasedMatches.Sync

Associated Types

type Rs TurnBasedMatchesSync :: Type #

type Scopes TurnBasedMatchesSync :: [Symbol] #

type Rep TurnBasedMatchesSync Source # 
Instance details

Defined in Network.Google.Resource.Games.TurnBasedMatches.Sync

type Rep TurnBasedMatchesSync = D1 (MetaData "TurnBasedMatchesSync" "Network.Google.Resource.Games.TurnBasedMatches.Sync" "gogol-games-0.4.0-EPjClsFfNAGupIHqlLfHm" False) (C1 (MetaCons "TurnBasedMatchesSync'" PrefixI True) ((S1 (MetaSel (Just "_tbmsMaxCompletedMatches") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_tbmsIncludeMatchData") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 (MetaSel (Just "_tbmsLanguage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_tbmsPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_tbmsMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32)))))))
type Scopes TurnBasedMatchesSync Source # 
Instance details

Defined in Network.Google.Resource.Games.TurnBasedMatches.Sync

type Scopes TurnBasedMatchesSync = "https://www.googleapis.com/auth/games" ': ([] :: [Symbol])
type Rs TurnBasedMatchesSync Source # 
Instance details

Defined in Network.Google.Resource.Games.TurnBasedMatches.Sync

Request Lenses

tbmsMaxCompletedMatches :: Lens' TurnBasedMatchesSync (Maybe Int32) Source #

The maximum number of completed or canceled matches to return in the response. If not set, all matches returned could be completed or canceled.

tbmsIncludeMatchData :: Lens' TurnBasedMatchesSync (Maybe Bool) Source #

True if match data should be returned in the response. Note that not all data will necessarily be returned if include_match_data is true; the server may decide to only return data for some of the matches to limit download size for the client. The remainder of the data for these matches will be retrievable on request.

tbmsLanguage :: Lens' TurnBasedMatchesSync (Maybe Text) Source #

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

tbmsPageToken :: Lens' TurnBasedMatchesSync (Maybe Text) Source #

The token returned by the previous request.

tbmsMaxResults :: Lens' TurnBasedMatchesSync (Maybe Int32) Source #

The maximum number of matches to return in the response, used for paging. For any response, the actual number of matches to return may be less than the specified maxResults.