gogol-proximitybeacon-0.3.0: Google Proximity Beacon 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.ProximityBeacon.Beacons.Deactivate

Contents

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: Google Proximity Beacon API Reference for proximitybeacon.beacons.deactivate.

Synopsis

REST Resource

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

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

Creating a Request

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 #

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 # 
Data BeaconsDeactivate # 

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 # 
Generic BeaconsDeactivate # 
GoogleRequest BeaconsDeactivate # 
type Rep BeaconsDeactivate # 
type Scopes BeaconsDeactivate # 
type Scopes BeaconsDeactivate = (:) Symbol "https://www.googleapis.com/auth/userlocation.beacon.registry" ([] Symbol)
type Rs BeaconsDeactivate # 

Request Lenses

bdXgafv :: Lens' BeaconsDeactivate (Maybe Text) #

V1 error format.

bdUploadProtocol :: Lens' BeaconsDeactivate (Maybe Text) #

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

bdPp :: Lens' BeaconsDeactivate Bool #

Pretty-print response.

bdBeaconName :: Lens' BeaconsDeactivate Text #

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) #

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

bdProjectId :: Lens' BeaconsDeactivate (Maybe Text) #

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.