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.Activate

Contents

Description

Activates a beacon. A beacon that is active will return information and attachment data when queried via `beaconinfo.getforobserved`. Calling this method on an already active 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.activate.

Synopsis

REST Resource

type BeaconsActivateResource = "v1beta1" :> (CaptureMode "beaconName" "activate" 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.activate method which the BeaconsActivate request conforms to.

Creating a Request

beaconsActivate #

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

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

data BeaconsActivate #

Activates a beacon. A beacon that is active will return information and attachment data when queried via `beaconinfo.getforobserved`. Calling this method on an already active 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: beaconsActivate smart constructor.

Instances

Eq BeaconsActivate # 
Data BeaconsActivate # 

Methods

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

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

toConstr :: BeaconsActivate -> Constr #

dataTypeOf :: BeaconsActivate -> DataType #

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

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

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

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

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

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

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

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

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

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

Show BeaconsActivate # 
Generic BeaconsActivate # 
GoogleRequest BeaconsActivate # 
type Rep BeaconsActivate # 
type Scopes BeaconsActivate # 
type Scopes BeaconsActivate = (:) Symbol "https://www.googleapis.com/auth/userlocation.beacon.registry" ([] Symbol)
type Rs BeaconsActivate # 

Request Lenses

baXgafv :: Lens' BeaconsActivate (Maybe Text) #

V1 error format.

baUploadProtocol :: Lens' BeaconsActivate (Maybe Text) #

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

baPp :: Lens' BeaconsActivate Bool #

Pretty-print response.

baAccessToken :: Lens' BeaconsActivate (Maybe Text) #

OAuth access token.

baBeaconName :: Lens' BeaconsActivate Text #

Beacon that should be activated. 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.

baUploadType :: Lens' BeaconsActivate (Maybe Text) #

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

baBearerToken :: Lens' BeaconsActivate (Maybe Text) #

OAuth bearer token.

baProjectId :: Lens' BeaconsActivate (Maybe Text) #

The project id of the beacon to activate. 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.