Network.Google.Resource.Games.TurnBasedMatches.Sync

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.

REST Resource

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

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

Creating a Request

turnBasedMatchesSync :: TurnBasedMatchesSync

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:

• tbmsMaxCompletedMatches
• tbmsConsistencyToken
• tbmsIncludeMatchData
• tbmsLanguage
• tbmsPageToken
• tbmsMaxResults

data TurnBasedMatchesSync

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

Methods

(==) :: TurnBasedMatchesSync -> TurnBasedMatchesSync -> Bool

(/=) :: TurnBasedMatchesSync -> TurnBasedMatchesSync -> Bool

Data TurnBasedMatchesSync

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

Methods

showsPrec :: Int -> TurnBasedMatchesSync -> ShowS

show :: TurnBasedMatchesSync -> String

showList :: [TurnBasedMatchesSync] -> ShowS

Generic TurnBasedMatchesSync

Associated Types

type Rep TurnBasedMatchesSync :: * -> *

Methods

from :: TurnBasedMatchesSync -> Rep TurnBasedMatchesSync x

to :: Rep TurnBasedMatchesSync x -> TurnBasedMatchesSync

GoogleRequest TurnBasedMatchesSync

Associated Types

type Rs TurnBasedMatchesSync :: *

type Scopes TurnBasedMatchesSync :: [Symbol]

Methods

requestClient :: TurnBasedMatchesSync -> Client (Rs TurnBasedMatchesSync)

type Rep TurnBasedMatchesSync

type Rep TurnBasedMatchesSync = D1 (MetaData "TurnBasedMatchesSync" "Network.Google.Resource.Games.TurnBasedMatches.Sync" "gogol-games-0.3.0-8BCKppY4rzpLLml8wyBtKz" False) (C1 (MetaCons "TurnBasedMatchesSync'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_tbmsMaxCompletedMatches") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32)))) ((:*:) (S1 (MetaSel (Just Symbol "_tbmsConsistencyToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64)))) (S1 (MetaSel (Just Symbol "_tbmsIncludeMatchData") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))))) ((:*:) (S1 (MetaSel (Just Symbol "_tbmsLanguage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_tbmsPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_tbmsMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))))))))

type Scopes TurnBasedMatchesSync

type Scopes TurnBasedMatchesSync = (:) Symbol "https://www.googleapis.com/auth/games" ((:) Symbol "https://www.googleapis.com/auth/plus.login" ([] Symbol))

type Rs TurnBasedMatchesSync

type Rs TurnBasedMatchesSync = TurnBasedMatchSync

Request Lenses

tbmsMaxCompletedMatches :: Lens' TurnBasedMatchesSync (Maybe Int32)

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

tbmsConsistencyToken :: Lens' TurnBasedMatchesSync (Maybe Int64)

The last-seen mutation timestamp.

tbmsIncludeMatchData :: Lens' TurnBasedMatchesSync (Maybe Bool)

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)

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

tbmsPageToken :: Lens' TurnBasedMatchesSync (Maybe Text)

The token returned by the previous request.

tbmsMaxResults :: Lens' TurnBasedMatchesSync (Maybe Int32)

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.