Copyright | (c) 2015 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 |
Deactivates a beacon. Once deactivated, the API will not return information nor attachment data for the beacon when queried via `beaconinfo.getforobserved`. Calling this method on an already inactive beacon will do nothing (but will return a successful response code).
See: Google Proximity Beacon API Reference for proximitybeacon.beacons.deactivate
.
- type BeaconsDeactivateResource = "v1beta1" :> (CaptureMode "beaconName" "deactivate" Text :> (QueryParam "$.xgafv" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "bearer_token" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Post `[JSON]` Empty)))))))))
- beaconsDeactivate :: Text -> BeaconsDeactivate
- data BeaconsDeactivate
- bdXgafv :: Lens' BeaconsDeactivate (Maybe Text)
- bdUploadProtocol :: Lens' BeaconsDeactivate (Maybe Text)
- bdPp :: Lens' BeaconsDeactivate Bool
- bdAccessToken :: Lens' BeaconsDeactivate (Maybe Text)
- bdBeaconName :: Lens' BeaconsDeactivate Text
- bdUploadType :: Lens' BeaconsDeactivate (Maybe Text)
- bdBearerToken :: Lens' BeaconsDeactivate (Maybe Text)
- bdCallback :: Lens' BeaconsDeactivate (Maybe Text)
REST Resource
type BeaconsDeactivateResource = "v1beta1" :> (CaptureMode "beaconName" "deactivate" Text :> (QueryParam "$.xgafv" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "bearer_token" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Post `[JSON]` Empty))))))))) Source
A resource alias for proximitybeacon.beacons.deactivate
method which the
BeaconsDeactivate
request conforms to.
Creating a Request
Creates a value of BeaconsDeactivate
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data BeaconsDeactivate Source
Deactivates a beacon. Once deactivated, the API will not return information nor attachment data for the beacon when queried via `beaconinfo.getforobserved`. Calling this method on an already inactive beacon will do nothing (but will return a successful response code).
See: beaconsDeactivate
smart constructor.
Request Lenses
bdUploadProtocol :: Lens' BeaconsDeactivate (Maybe Text) Source
Upload protocol for media (e.g. "raw", "multipart").
bdPp :: Lens' BeaconsDeactivate Bool Source
Pretty-print response.
bdAccessToken :: Lens' BeaconsDeactivate (Maybe Text) Source
OAuth access token.
bdBeaconName :: Lens' BeaconsDeactivate Text Source
The beacon name of this beacon.
bdUploadType :: Lens' BeaconsDeactivate (Maybe Text) Source
Legacy upload protocol for media (e.g. "media", "multipart").
bdBearerToken :: Lens' BeaconsDeactivate (Maybe Text) Source
OAuth bearer token.
bdCallback :: Lens' BeaconsDeactivate (Maybe Text) Source
JSONP