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 |
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
- 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))))))))))
- beaconsAttachmentsList :: Text -> BeaconsAttachmentsList
- data BeaconsAttachmentsList
- balXgafv :: Lens' BeaconsAttachmentsList (Maybe Xgafv)
- balUploadProtocol :: Lens' BeaconsAttachmentsList (Maybe Text)
- balAccessToken :: Lens' BeaconsAttachmentsList (Maybe Text)
- balBeaconName :: Lens' BeaconsAttachmentsList Text
- balUploadType :: Lens' BeaconsAttachmentsList (Maybe Text)
- balNamespacedType :: Lens' BeaconsAttachmentsList (Maybe Text)
- balProjectId :: Lens' BeaconsAttachmentsList (Maybe Text)
- balCallback :: Lens' BeaconsAttachmentsList (Maybe Text)
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
Request Lenses
balUploadProtocol :: Lens' BeaconsAttachmentsList (Maybe Text) Source #
Upload protocol for media (e.g. "raw", "multipart").
balAccessToken :: Lens' BeaconsAttachmentsList (Maybe Text) Source #
OAuth access token.
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.
balCallback :: Lens' BeaconsAttachmentsList (Maybe Text) Source #
JSONP