Class BeaconsResource.GetRequest
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.
Inheritance
Inherited Members
Namespace: Google.Apis.Proximitybeacon.v1beta1
Assembly: Google.Apis.Proximitybeacon.v1beta1.dll
Syntax
public class GetRequest : ProximitybeaconBaseServiceRequest<Beacon>, IClientServiceRequest<Beacon>, IClientServiceRequest
Constructors
GetRequest(IClientService, String)
Constructs a new Get request.
Declaration
public GetRequest(IClientService service, string beaconName)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service | |
System.String | beaconName |
Properties
BeaconName
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.
Declaration
[RequestParameter("beaconName", RequestParameterType.Path)]
public virtual string BeaconName { get; }
Property Value
Type | Description |
---|---|
System.String |
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
Type | Description |
---|---|
System.String |
Overrides
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
Type | Description |
---|---|
System.String |
Overrides
ProjectId
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.
Declaration
[RequestParameter("projectId", RequestParameterType.Query)]
public virtual string ProjectId { get; set; }
Property Value
Type | Description |
---|---|
System.String |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
Type | Description |
---|---|
System.String |
Overrides
Methods
InitParameters()
Initializes Get parameter list.
Declaration
protected override void InitParameters()