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

Contents

Description

Returns detailed information about the specified beacon. Authenticate using an OAuth access token from a signed-in user with **viewer**, **Is owner** or **Can edit** permissions in the Google Developers Console project. Requests may supply an Eddystone-EID beacon name in the form: `beacons/4!beaconId` where the `beaconId` is the base16 ephemeral ID broadcast by the beacon. The returned `Beacon` object will contain the beacon's stable Eddystone-UID. Clients not authorized to resolve the beacon's ephemeral Eddystone-EID broadcast will receive an error.

See: Google Proximity Beacon API Reference for proximitybeacon.beacons.get.

Synopsis

REST Resource

type BeaconsGetResource = "v1beta1" :> (Capture "beaconName" 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 :> Get '[JSON] Beacon)))))))))) #

A resource alias for proximitybeacon.beacons.get method which the BeaconsGet request conforms to.

Creating a Request

beaconsGet #

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

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

data BeaconsGet #

Returns detailed information about the specified beacon. Authenticate using an OAuth access token from a signed-in user with **viewer**, **Is owner** or **Can edit** permissions in the Google Developers Console project. Requests may supply an Eddystone-EID beacon name in the form: `beacons/4!beaconId` where the `beaconId` is the base16 ephemeral ID broadcast by the beacon. The returned `Beacon` object will contain the beacon's stable Eddystone-UID. Clients not authorized to resolve the beacon's ephemeral Eddystone-EID broadcast will receive an error.

See: beaconsGet smart constructor.

Instances

Eq BeaconsGet # 
Data BeaconsGet # 

Methods

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

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

toConstr :: BeaconsGet -> Constr #

dataTypeOf :: BeaconsGet -> DataType #

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

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

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

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

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

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

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

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

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

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

Show BeaconsGet # 
Generic BeaconsGet # 

Associated Types

type Rep BeaconsGet :: * -> * #

GoogleRequest BeaconsGet # 

Associated Types

type Rs BeaconsGet :: * #

type Scopes BeaconsGet :: [Symbol] #

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

Request Lenses

bgXgafv :: Lens' BeaconsGet (Maybe Text) #

V1 error format.

bgUploadProtocol :: Lens' BeaconsGet (Maybe Text) #

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

bgPp :: Lens' BeaconsGet Bool #

Pretty-print response.

bgAccessToken :: Lens' BeaconsGet (Maybe Text) #

OAuth access token.

bgBeaconName :: Lens' BeaconsGet Text #

Resource name of this beacon. 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.

bgUploadType :: Lens' BeaconsGet (Maybe Text) #

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

bgBearerToken :: Lens' BeaconsGet (Maybe Text) #

OAuth bearer token.

bgProjectId :: Lens' BeaconsGet (Maybe Text) #

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