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.Attachments.Create

Contents

REST Resource
Creating a Request
Request Lenses

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

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))))))))))
beaconsAttachmentsCreate :: Text -> BeaconAttachment -> BeaconsAttachmentsCreate
data BeaconsAttachmentsCreate
bacXgafv :: Lens' BeaconsAttachmentsCreate (Maybe Xgafv)
bacUploadProtocol :: Lens' BeaconsAttachmentsCreate (Maybe Text)
bacAccessToken :: Lens' BeaconsAttachmentsCreate (Maybe Text)
bacBeaconName :: Lens' BeaconsAttachmentsCreate Text
bacUploadType :: Lens' BeaconsAttachmentsCreate (Maybe Text)
bacPayload :: Lens' BeaconsAttachmentsCreate BeaconAttachment
bacProjectId :: Lens' BeaconsAttachmentsCreate (Maybe Text)
bacCallback :: Lens' BeaconsAttachmentsCreate (Maybe Text)

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 #

Arguments

:: Text	`bacBeaconName`
-> BeaconAttachment	`bacPayload`
-> BeaconsAttachmentsCreate

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 Methods (==) :: BeaconsAttachmentsCreate -> BeaconsAttachmentsCreate -> Bool # (/=) :: BeaconsAttachmentsCreate -> BeaconsAttachmentsCreate -> Bool #
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 Methods showsPrec :: Int -> BeaconsAttachmentsCreate -> ShowS # show :: BeaconsAttachmentsCreate -> String # showList :: [BeaconsAttachmentsCreate] -> ShowS #
Generic BeaconsAttachmentsCreate Source #
Instance details Defined in Network.Google.Resource.ProximityBeacon.Beacons.Attachments.Create Associated Types type Rep BeaconsAttachmentsCreate :: Type -> Type # Methods from :: BeaconsAttachmentsCreate -> Rep BeaconsAttachmentsCreate x # to :: Rep BeaconsAttachmentsCreate x -> BeaconsAttachmentsCreate #
GoogleRequest BeaconsAttachmentsCreate Source #
Instance details Defined in Network.Google.Resource.ProximityBeacon.Beacons.Attachments.Create Associated Types type Rs BeaconsAttachmentsCreate :: Type # type Scopes BeaconsAttachmentsCreate :: [Symbol] # Methods requestClient :: BeaconsAttachmentsCreate -> GClient (Rs BeaconsAttachmentsCreate) #
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 type Rs BeaconsAttachmentsCreate = BeaconAttachment

Request Lenses

bacXgafv :: Lens' BeaconsAttachmentsCreate (Maybe Xgafv) Source #

V1 error format.

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

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

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

OAuth access token.

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").

bacPayload :: Lens' BeaconsAttachmentsCreate BeaconAttachment Source #

Multipart request metadata.

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.

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

JSONP