gogol-proximitybeacon-0.4.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.Attachments.Create

Contents

Description

Associates the given data with the specified beacon. Attachment data must contain two parts:

  • A namespaced type.
  • The actual attachment data itself.

The namespaced type consists of two parts, the namespace and the type. The namespace must be one of the values returned by the `namespaces` endpoint, while the type can be a string of any characters except for the forward slash (`/`) up to 100 characters in length. Attachment data can be up to 1024 bytes long. 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.attachments.create.

Synopsis

REST Resource

type BeaconsAttachmentsCreateResource = "v1beta1" :> (Capture "beaconName" Text :> ("attachments" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "projectId" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] BeaconAttachment :> Post '[JSON] BeaconAttachment)))))))))) Source #

A resource alias for proximitybeacon.beacons.attachments.create method which the BeaconsAttachmentsCreate request conforms to.

Creating a Request

beaconsAttachmentsCreate Source #

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

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

data BeaconsAttachmentsCreate Source #

Associates the given data with the specified beacon. Attachment data must contain two parts:

  • A namespaced type.
  • The actual attachment data itself.

The namespaced type consists of two parts, the namespace and the type. The namespace must be one of the values returned by the `namespaces` endpoint, while the type can be a string of any characters except for the forward slash (`/`) up to 100 characters in length. Attachment data can be up to 1024 bytes long. 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: beaconsAttachmentsCreate smart constructor.

Instances
Eq BeaconsAttachmentsCreate Source # 
Instance details

Defined in Network.Google.Resource.ProximityBeacon.Beacons.Attachments.Create

Data BeaconsAttachmentsCreate Source # 
Instance details

Defined in Network.Google.Resource.ProximityBeacon.Beacons.Attachments.Create

Methods

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

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

toConstr :: BeaconsAttachmentsCreate -> Constr #

dataTypeOf :: BeaconsAttachmentsCreate -> DataType #

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

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

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

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

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

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

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

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

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

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

Show BeaconsAttachmentsCreate Source # 
Instance details

Defined in Network.Google.Resource.ProximityBeacon.Beacons.Attachments.Create

Generic BeaconsAttachmentsCreate Source # 
Instance details

Defined in Network.Google.Resource.ProximityBeacon.Beacons.Attachments.Create

Associated Types

type Rep BeaconsAttachmentsCreate :: Type -> Type #

GoogleRequest BeaconsAttachmentsCreate Source # 
Instance details

Defined in Network.Google.Resource.ProximityBeacon.Beacons.Attachments.Create

type Rep BeaconsAttachmentsCreate Source # 
Instance details

Defined in Network.Google.Resource.ProximityBeacon.Beacons.Attachments.Create

type Rep BeaconsAttachmentsCreate = D1 (MetaData "BeaconsAttachmentsCreate" "Network.Google.Resource.ProximityBeacon.Beacons.Attachments.Create" "gogol-proximitybeacon-0.4.0-81RQBGEh3ZRFwA4LNDaUi1" False) (C1 (MetaCons "BeaconsAttachmentsCreate'" PrefixI True) (((S1 (MetaSel (Just "_bacXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: S1 (MetaSel (Just "_bacUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_bacAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_bacBeaconName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) :*: ((S1 (MetaSel (Just "_bacUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_bacPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 BeaconAttachment)) :*: (S1 (MetaSel (Just "_bacProjectId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_bacCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes BeaconsAttachmentsCreate Source # 
Instance details

Defined in Network.Google.Resource.ProximityBeacon.Beacons.Attachments.Create

type Scopes BeaconsAttachmentsCreate = "https://www.googleapis.com/auth/userlocation.beacon.registry" ': ([] :: [Symbol])
type Rs BeaconsAttachmentsCreate Source # 
Instance details

Defined in Network.Google.Resource.ProximityBeacon.Beacons.Attachments.Create

Request Lenses

bacUploadProtocol :: Lens' BeaconsAttachmentsCreate (Maybe Text) Source #

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

bacBeaconName :: Lens' BeaconsAttachmentsCreate Text Source #

Beacon on which the attachment should be created. 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.

bacUploadType :: Lens' BeaconsAttachmentsCreate (Maybe Text) Source #

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

bacProjectId :: Lens' BeaconsAttachmentsCreate (Maybe Text) Source #

The project id of the project the attachment will belong to. If the project id is not specified then the project making the request is used. Optional.