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.Get
Description
Returns detailed information about the specified beacon. 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. Requests may supply an Eddystone-EID beacon name in the form: `beacons/4!beaconId` where the `beaconId` is the base16 ephemeral ID broadcast by the beacon. The returned `Beacon` object will contain the beacon's stable Eddystone-UID. Clients not authorized to resolve the beacon's ephemeral Eddystone-EID broadcast will receive an error.
See: Google Proximity Beacon API Reference for proximitybeacon.beacons.get
.
- type BeaconsGetResource = "v1beta1" :> (Capture "beaconName" Text :> (QueryParam "$.xgafv" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "bearer_token" Text :> (QueryParam "projectId" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] Beacon))))))))))
- beaconsGet :: Text -> BeaconsGet
- data BeaconsGet
- bgXgafv :: Lens' BeaconsGet (Maybe Text)
- bgUploadProtocol :: Lens' BeaconsGet (Maybe Text)
- bgPp :: Lens' BeaconsGet Bool
- bgAccessToken :: Lens' BeaconsGet (Maybe Text)
- bgBeaconName :: Lens' BeaconsGet Text
- bgUploadType :: Lens' BeaconsGet (Maybe Text)
- bgBearerToken :: Lens' BeaconsGet (Maybe Text)
- bgProjectId :: Lens' BeaconsGet (Maybe Text)
- bgCallback :: Lens' BeaconsGet (Maybe Text)
REST Resource
type BeaconsGetResource = "v1beta1" :> (Capture "beaconName" Text :> (QueryParam "$.xgafv" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "bearer_token" Text :> (QueryParam "projectId" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] Beacon)))))))))) #
A resource alias for proximitybeacon.beacons.get
method which the
BeaconsGet
request conforms to.
Creating a Request
Arguments
:: Text | |
-> BeaconsGet |
Creates a value of BeaconsGet
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data BeaconsGet #
Returns detailed information about the specified beacon. 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. Requests may supply an Eddystone-EID beacon name in the form: `beacons/4!beaconId` where the `beaconId` is the base16 ephemeral ID broadcast by the beacon. The returned `Beacon` object will contain the beacon's stable Eddystone-UID. Clients not authorized to resolve the beacon's ephemeral Eddystone-EID broadcast will receive an error.
See: beaconsGet
smart constructor.
Instances
Eq BeaconsGet # | |
Data BeaconsGet # | |
Show BeaconsGet # | |
Generic BeaconsGet # | |
GoogleRequest BeaconsGet # | |
type Rep BeaconsGet # | |
type Scopes BeaconsGet # | |
type Rs BeaconsGet # | |
Request Lenses
bgUploadProtocol :: Lens' BeaconsGet (Maybe Text) #
Upload protocol for media (e.g. "raw", "multipart").
bgPp :: Lens' BeaconsGet Bool #
Pretty-print response.
bgAccessToken :: Lens' BeaconsGet (Maybe Text) #
OAuth access token.
bgBeaconName :: Lens' BeaconsGet Text #
Resource name of this beacon. 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.
bgUploadType :: Lens' BeaconsGet (Maybe Text) #
Legacy upload protocol for media (e.g. "media", "multipart").
bgBearerToken :: Lens' BeaconsGet (Maybe Text) #
OAuth bearer token.
bgProjectId :: Lens' BeaconsGet (Maybe Text) #
The project id of the beacon to request. 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.
bgCallback :: Lens' BeaconsGet (Maybe Text) #
JSONP