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

Contents

REST Resource
Creating a Request
Request Lenses

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

Synopsis

type BeaconsActivateResource = "v1beta1" :> (CaptureMode "beaconName" "activate" 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))))))))
beaconsActivate :: Text -> BeaconsActivate
data BeaconsActivate
baXgafv :: Lens' BeaconsActivate (Maybe Xgafv)
baUploadProtocol :: Lens' BeaconsActivate (Maybe Text)
baAccessToken :: Lens' BeaconsActivate (Maybe Text)
baBeaconName :: Lens' BeaconsActivate Text
baUploadType :: Lens' BeaconsActivate (Maybe Text)
baProjectId :: Lens' BeaconsActivate (Maybe Text)
baCallback :: Lens' BeaconsActivate (Maybe Text)

REST Resource

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

Creating a Request

beaconsActivate Source #

Arguments

:: Text	`baBeaconName`
-> 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 Source #

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 Source #
Instance details Defined in Network.Google.Resource.ProximityBeacon.Beacons.Activate Methods (==) :: BeaconsActivate -> BeaconsActivate -> Bool # (/=) :: BeaconsActivate -> BeaconsActivate -> Bool #
Data BeaconsActivate Source #
Instance details Defined in Network.Google.Resource.ProximityBeacon.Beacons.Activate 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 Source #
Instance details Defined in Network.Google.Resource.ProximityBeacon.Beacons.Activate Methods showsPrec :: Int -> BeaconsActivate -> ShowS # show :: BeaconsActivate -> String # showList :: [BeaconsActivate] -> ShowS #
Generic BeaconsActivate Source #
Instance details Defined in Network.Google.Resource.ProximityBeacon.Beacons.Activate Associated Types type Rep BeaconsActivate :: Type -> Type # Methods from :: BeaconsActivate -> Rep BeaconsActivate x # to :: Rep BeaconsActivate x -> BeaconsActivate #
GoogleRequest BeaconsActivate Source #
Instance details Defined in Network.Google.Resource.ProximityBeacon.Beacons.Activate Associated Types type Rs BeaconsActivate :: Type # type Scopes BeaconsActivate :: [Symbol] # Methods requestClient :: BeaconsActivate -> GClient (Rs BeaconsActivate) #
type Rep BeaconsActivate Source #
Instance details Defined in Network.Google.Resource.ProximityBeacon.Beacons.Activate type Rep BeaconsActivate = D1 (MetaData "BeaconsActivate" "Network.Google.Resource.ProximityBeacon.Beacons.Activate" "gogol-proximitybeacon-0.4.0-81RQBGEh3ZRFwA4LNDaUi1" False) (C1 (MetaCons "BeaconsActivate'" PrefixI True) ((S1 (MetaSel (Just "_baXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: (S1 (MetaSel (Just "_baUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_baAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_baBeaconName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_baUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_baProjectId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_baCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes BeaconsActivate Source #
Instance details Defined in Network.Google.Resource.ProximityBeacon.Beacons.Activate type Scopes BeaconsActivate = "https://www.googleapis.com/auth/userlocation.beacon.registry" ': ([] :: [Symbol])
type Rs BeaconsActivate Source #
Instance details Defined in Network.Google.Resource.ProximityBeacon.Beacons.Activate type Rs BeaconsActivate = Empty

Request Lenses

baXgafv :: Lens' BeaconsActivate (Maybe Xgafv) Source #

V1 error format.

baUploadProtocol :: Lens' BeaconsActivate (Maybe Text) Source #

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

baAccessToken :: Lens' BeaconsActivate (Maybe Text) Source #

OAuth access token.

baBeaconName :: Lens' BeaconsActivate Text Source #

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

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

baProjectId :: Lens' BeaconsActivate (Maybe Text) Source #

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.

baCallback :: Lens' BeaconsActivate (Maybe Text) Source #

JSONP