gogol-appstate-0.3.0: Google App State 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.AppState.States.Clear

Contents

Description

Clears (sets to empty) the data for the passed key if and only if the passed version matches the currently stored version. This method results in a conflict error on version mismatch.

See: Google App State API Reference for appstate.states.clear.

Synopsis

REST Resource

type StatesClearResource = "appstate" :> ("v1" :> ("states" :> (Capture "stateKey" (Textual Int32) :> ("clear" :> (QueryParam "currentDataVersion" Text :> (QueryParam "alt" AltJSON :> Post '[JSON] WriteResult)))))) #

A resource alias for appstate.states.clear method which the StatesClear request conforms to.

Creating a Request

statesClear #

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

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

data StatesClear #

Clears (sets to empty) the data for the passed key if and only if the passed version matches the currently stored version. This method results in a conflict error on version mismatch.

See: statesClear smart constructor.

Instances

Eq StatesClear # 
Data StatesClear # 

Methods

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

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

toConstr :: StatesClear -> Constr #

dataTypeOf :: StatesClear -> DataType #

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

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

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

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

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

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

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

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

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

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

Show StatesClear # 
Generic StatesClear # 

Associated Types

type Rep StatesClear :: * -> * #

GoogleRequest StatesClear # 

Associated Types

type Rs StatesClear :: * #

type Scopes StatesClear :: [Symbol] #

type Rep StatesClear # 
type Rep StatesClear = D1 (MetaData "StatesClear" "Network.Google.Resource.AppState.States.Clear" "gogol-appstate-0.3.0-EGMeJlIxZhEFrEPUQklAKW" False) (C1 (MetaCons "StatesClear'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_scStateKey") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 (Textual Int32))) (S1 (MetaSel (Just Symbol "_scCurrentDataVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))
type Scopes StatesClear # 
type Scopes StatesClear = (:) Symbol "https://www.googleapis.com/auth/appstate" ([] Symbol)
type Rs StatesClear # 

Request Lenses

scStateKey :: Lens' StatesClear Int32 #

The key for the data to be retrieved.

scCurrentDataVersion :: Lens' StatesClear (Maybe Text) #

The version of the data to be cleared. Version strings are returned by the server.