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

Contents

Description

Returns the attachments for the specified beacon that match the specified namespaced-type pattern. To control which namespaced types are returned, you add the `namespacedType` query parameter to the request. You must either use `*/*`, to return all attachments, or the namespace must be one of the ones returned from the `namespaces` endpoint. 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.

See: Proximity Beacon API Reference for proximitybeacon.beacons.attachments.list.

Synopsis

REST Resource

type BeaconsAttachmentsListResource = "v1beta1" :> (Capture "beaconName" Text :> ("attachments" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "namespacedType" Text :> (QueryParam "projectId" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListBeaconAttachmentsResponse)))))))))) Source #

A resource alias for proximitybeacon.beacons.attachments.list method which the BeaconsAttachmentsList request conforms to.

Creating a Request

beaconsAttachmentsList Source #

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

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

data BeaconsAttachmentsList Source #

Returns the attachments for the specified beacon that match the specified namespaced-type pattern. To control which namespaced types are returned, you add the `namespacedType` query parameter to the request. You must either use `*/*`, to return all attachments, or the namespace must be one of the ones returned from the `namespaces` endpoint. 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.

See: beaconsAttachmentsList smart constructor.

Instances
Eq BeaconsAttachmentsList Source # 
Instance details

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

Data BeaconsAttachmentsList Source # 
Instance details

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

Methods

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

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

toConstr :: BeaconsAttachmentsList -> Constr #

dataTypeOf :: BeaconsAttachmentsList -> DataType #

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

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

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

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

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

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

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

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

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

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

Show BeaconsAttachmentsList Source # 
Instance details

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

Generic BeaconsAttachmentsList Source # 
Instance details

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

Associated Types

type Rep BeaconsAttachmentsList :: Type -> Type #

GoogleRequest BeaconsAttachmentsList Source # 
Instance details

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

type Rep BeaconsAttachmentsList Source # 
Instance details

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

type Rep BeaconsAttachmentsList = D1 (MetaData "BeaconsAttachmentsList" "Network.Google.Resource.ProximityBeacon.Beacons.Attachments.List" "gogol-proximitybeacon-0.4.0-81RQBGEh3ZRFwA4LNDaUi1" False) (C1 (MetaCons "BeaconsAttachmentsList'" PrefixI True) (((S1 (MetaSel (Just "_balXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: S1 (MetaSel (Just "_balUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_balAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_balBeaconName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) :*: ((S1 (MetaSel (Just "_balUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_balNamespacedType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_balProjectId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_balCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes BeaconsAttachmentsList Source # 
Instance details

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

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

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

Request Lenses

balUploadProtocol :: Lens' BeaconsAttachmentsList (Maybe Text) Source #

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

balBeaconName :: Lens' BeaconsAttachmentsList Text Source #

Beacon whose attachments should be fetched. 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.

balUploadType :: Lens' BeaconsAttachmentsList (Maybe Text) Source #

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

balNamespacedType :: Lens' BeaconsAttachmentsList (Maybe Text) Source #

Specifies the namespace and type of attachment to include in response in namespace/type format. Accepts `*/*` to specify "all types in all namespaces".

balProjectId :: Lens' BeaconsAttachmentsList (Maybe Text) Source #

The project id to list beacon attachments under. This field can be used when "*" is specified to mean all attachment namespaces. Projects may have multiple attachments with multiple namespaces. If "*" is specified and the projectId string is empty, then the project making the request is used. Optional.