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.ProximityBeacon.Beacons.Deactivate

Contents

REST Resource
Creating a Request
Request Lenses

Description

Deactivates a beacon. Once deactivated, the API will not return information nor attachment data for the beacon when queried via `beaconinfo.getforobserved`. Calling this method on an already inactive beacon will do nothing (but will return a successful response code). Authenticate using an OAuth access token from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.

See: Proximity Beacon API Reference for proximitybeacon.beacons.deactivate.

Synopsis

type BeaconsDeactivateResource = "v1beta1" :> (CaptureMode "beaconName" "deactivate" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "projectId" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Post '[JSON] Empty))))))))
beaconsDeactivate :: Text -> BeaconsDeactivate
data BeaconsDeactivate
bdXgafv :: Lens' BeaconsDeactivate (Maybe Xgafv)
bdUploadProtocol :: Lens' BeaconsDeactivate (Maybe Text)
bdAccessToken :: Lens' BeaconsDeactivate (Maybe Text)
bdBeaconName :: Lens' BeaconsDeactivate Text
bdUploadType :: Lens' BeaconsDeactivate (Maybe Text)
bdProjectId :: Lens' BeaconsDeactivate (Maybe Text)
bdCallback :: Lens' BeaconsDeactivate (Maybe Text)

REST Resource

type BeaconsDeactivateResource = "v1beta1" :> (CaptureMode "beaconName" "deactivate" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "projectId" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Post '[JSON] Empty)))))))) Source #

A resource alias for proximitybeacon.beacons.deactivate method which the BeaconsDeactivate request conforms to.

Creating a Request

beaconsDeactivate Source #

Arguments

:: Text	`bdBeaconName`
-> BeaconsDeactivate

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

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

data BeaconsDeactivate Source #

Deactivates a beacon. Once deactivated, the API will not return information nor attachment data for the beacon when queried via `beaconinfo.getforobserved`. Calling this method on an already inactive beacon will do nothing (but will return a successful response code). Authenticate using an OAuth access token from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.

See: beaconsDeactivate smart constructor.

Instances

Eq BeaconsDeactivate Source #
Instance details Defined in Network.Google.Resource.ProximityBeacon.Beacons.Deactivate Methods (==) :: BeaconsDeactivate -> BeaconsDeactivate -> Bool # (/=) :: BeaconsDeactivate -> BeaconsDeactivate -> Bool #
Data BeaconsDeactivate Source #
Instance details Defined in Network.Google.Resource.ProximityBeacon.Beacons.Deactivate Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> BeaconsDeactivate -> c BeaconsDeactivate # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c BeaconsDeactivate # toConstr :: BeaconsDeactivate -> Constr # dataTypeOf :: BeaconsDeactivate -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c BeaconsDeactivate) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c BeaconsDeactivate) # gmapT :: (forall b. Data b => b -> b) -> BeaconsDeactivate -> BeaconsDeactivate # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> BeaconsDeactivate -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> BeaconsDeactivate -> r # gmapQ :: (forall d. Data d => d -> u) -> BeaconsDeactivate -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> BeaconsDeactivate -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> BeaconsDeactivate -> m BeaconsDeactivate # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> BeaconsDeactivate -> m BeaconsDeactivate # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> BeaconsDeactivate -> m BeaconsDeactivate #
Show BeaconsDeactivate Source #
Instance details Defined in Network.Google.Resource.ProximityBeacon.Beacons.Deactivate Methods showsPrec :: Int -> BeaconsDeactivate -> ShowS # show :: BeaconsDeactivate -> String # showList :: [BeaconsDeactivate] -> ShowS #
Generic BeaconsDeactivate Source #
Instance details Defined in Network.Google.Resource.ProximityBeacon.Beacons.Deactivate Associated Types type Rep BeaconsDeactivate :: Type -> Type # Methods from :: BeaconsDeactivate -> Rep BeaconsDeactivate x # to :: Rep BeaconsDeactivate x -> BeaconsDeactivate #
GoogleRequest BeaconsDeactivate Source #
Instance details Defined in Network.Google.Resource.ProximityBeacon.Beacons.Deactivate Associated Types type Rs BeaconsDeactivate :: Type # type Scopes BeaconsDeactivate :: [Symbol] # Methods requestClient :: BeaconsDeactivate -> GClient (Rs BeaconsDeactivate) #
type Rep BeaconsDeactivate Source #
Instance details Defined in Network.Google.Resource.ProximityBeacon.Beacons.Deactivate type Rep BeaconsDeactivate = D1 (MetaData "BeaconsDeactivate" "Network.Google.Resource.ProximityBeacon.Beacons.Deactivate" "gogol-proximitybeacon-0.4.0-81RQBGEh3ZRFwA4LNDaUi1" False) (C1 (MetaCons "BeaconsDeactivate'" PrefixI True) ((S1 (MetaSel (Just "_bdXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: (S1 (MetaSel (Just "_bdUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_bdAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_bdBeaconName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_bdUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_bdProjectId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_bdCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes BeaconsDeactivate Source #
Instance details Defined in Network.Google.Resource.ProximityBeacon.Beacons.Deactivate type Scopes BeaconsDeactivate = "https://www.googleapis.com/auth/userlocation.beacon.registry" ': ([] :: [Symbol])
type Rs BeaconsDeactivate Source #
Instance details Defined in Network.Google.Resource.ProximityBeacon.Beacons.Deactivate type Rs BeaconsDeactivate = Empty

Request Lenses

bdXgafv :: Lens' BeaconsDeactivate (Maybe Xgafv) Source #

V1 error format.

bdUploadProtocol :: Lens' BeaconsDeactivate (Maybe Text) Source #

Upload protocol for media (e.g. "raw", "multipart").

bdAccessToken :: Lens' BeaconsDeactivate (Maybe Text) Source #

OAuth access token.

bdBeaconName :: Lens' BeaconsDeactivate Text Source #

Beacon that should be deactivated. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's "stable" UID. Required.

bdUploadType :: Lens' BeaconsDeactivate (Maybe Text) Source #

Legacy upload protocol for media (e.g. "media", "multipart").

bdProjectId :: Lens' BeaconsDeactivate (Maybe Text) Source #

The project id of the beacon to deactivate. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon. Optional.

bdCallback :: Lens' BeaconsDeactivate (Maybe Text) Source #

JSONP