Class BeaconsResource
The "beacons" collection of methods.
Inheritance
Inherited Members
Namespace: Google.Apis.Proximitybeacon.v1beta1
Assembly: Google.Apis.Proximitybeacon.v1beta1.dll
Syntax
public class BeaconsResource
Constructors
BeaconsResource(IClientService)
Constructs a new resource.
Declaration
public BeaconsResource(IClientService service)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service |
Properties
Attachments
Gets the Attachments resource.
Declaration
public virtual BeaconsResource.AttachmentsResource Attachments { get; }
Property Value
Type | Description |
---|---|
BeaconsResource.AttachmentsResource |
Diagnostics
Gets the Diagnostics resource.
Declaration
public virtual BeaconsResource.DiagnosticsResource Diagnostics { get; }
Property Value
Type | Description |
---|---|
BeaconsResource.DiagnosticsResource |
Methods
Activate(String)
Activates a beacon. A beacon that is active will return information and attachment data when
queried via beaconinfo.getforobserved
. Calling this method on an already active beacon will do nothing
(but will return a successful response code).
Authenticate using an OAuth access token from a signed-in user with Is owner or Can edit permissions in the Google Developers Console project.
Declaration
public virtual BeaconsResource.ActivateRequest Activate(string beaconName)
Parameters
Type | Name | Description |
---|---|---|
System.String | beaconName | Beacon that should be activated. 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 |
Returns
Type | Description |
---|---|
BeaconsResource.ActivateRequest |
Deactivate(String)
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).
Authenticate using an OAuth access token from a signed-in user with Is owner or Can edit permissions in the Google Developers Console project.
Declaration
public virtual BeaconsResource.DeactivateRequest Deactivate(string beaconName)
Parameters
Type | Name | Description |
---|---|---|
System.String | beaconName | Beacon that should be deactivated. 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 |
Returns
Type | Description |
---|---|
BeaconsResource.DeactivateRequest |
Decommission(String)
Decommissions the specified beacon in the service. This beacon will no longer be returned from
beaconinfo.getforobserved
. This operation is permanent -- you will not be able to re-register a beacon
with this ID again.
Authenticate using an OAuth access token from a signed-in user with Is owner or Can edit permissions in the Google Developers Console project.
Declaration
public virtual BeaconsResource.DecommissionRequest Decommission(string beaconName)
Parameters
Type | Name | Description |
---|---|---|
System.String | beaconName | Beacon that should be decommissioned. 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 |
Returns
Type | Description |
---|---|
BeaconsResource.DecommissionRequest |
Delete(String)
Deletes the specified beacon including all diagnostics data for the beacon as well as any attachments on the beacon (including those belonging to other projects). This operation cannot be undone.
Authenticate using an OAuth access token from a signed-in user with Is owner or Can edit permissions in the Google Developers Console project.
Declaration
public virtual BeaconsResource.DeleteRequest Delete(string beaconName)
Parameters
Type | Name | Description |
---|---|---|
System.String | beaconName | Beacon that should be deleted. 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 |
Returns
Type | Description |
---|---|
BeaconsResource.DeleteRequest |
Get(String)
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.
Declaration
public virtual BeaconsResource.GetRequest Get(string beaconName)
Parameters
Type | Name | Description |
---|---|---|
System.String | 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 |
Returns
Type | Description |
---|---|
BeaconsResource.GetRequest |
List()
Searches the beacon registry for beacons that match the given search criteria. Only those beacons that the client has permission to list will be returned.
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.
Declaration
public virtual BeaconsResource.ListRequest List()
Returns
Type | Description |
---|---|
BeaconsResource.ListRequest |
Register(Beacon)
Registers a previously unregistered beacon given its advertisedId
. These IDs are unique within
the system. An ID can be registered only once.
Authenticate using an OAuth access token from a signed-in user with Is owner or Can edit permissions in the Google Developers Console project.
Declaration
public virtual BeaconsResource.RegisterRequest Register(Beacon body)
Parameters
Type | Name | Description |
---|---|---|
Beacon | body | The body of the request. |
Returns
Type | Description |
---|---|
BeaconsResource.RegisterRequest |
Update(Beacon, String)
Updates the information about the specified beacon. Any field that you do not populate in the submitted beacon will be permanently erased, so you should follow the "read, modify, write" pattern to avoid inadvertently destroying data.
Changes to the beacon status via this method will be silently ignored. To update beacon status, use the separate methods on this API for activation, deactivation, and decommissioning. Authenticate using an OAuth access token from a signed-in user with Is owner or Can edit permissions in the Google Developers Console project.
Declaration
public virtual BeaconsResource.UpdateRequest Update(Beacon body, string beaconName)
Parameters
Type | Name | Description |
---|---|---|
Beacon | body | The body of the request. |
System.String | 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 This field must be left empty when registering. After reading a beacon, clients can use the name for future operations. |
Returns
Type | Description |
---|---|
BeaconsResource.UpdateRequest |