ArcGIS for Developers

BeaconDiscoveryAgent QML Type

Discover nearby Bluetooth beacons. More...

Import Statement: import ArcGIS.AppFramework.Devices 1.0

Properties

Signals

Methods

Detailed Description

The BeaconDiscoveryAgent component searches for nearby Bluetooth beacons detectable by your app, optionally within a given beacon region.

This component is currently only supported on iOS and Android devices.

Enumerations

State enumeration

The state of the beacon region. Informs the stateChangedForRegion signal.

NameValue
BeaconDiscoveryAgent.Unknown-1
BeaconDiscoveryAgent.Outside0
BeaconDiscoveryAgent.Inside1

Property Documentation

[read-only] error : string

Returns the last error encountered in Bluetooth beacon detection.


[read-only] supported : bool

Returns true if the app and device support bluetooth beacon detection. Otherwise, returns false.


Signal Documentation

beaconsInRegion( BeaconRegion beaconRegion, object beacons)

Signal emitted when the count of beacons detected in a region has changed. This signal instantiates the Beacon component.


enteredRegion( BeaconRegion beaconRegion)

Signal emitted when a Bluetooth beacon from the specified region has been detected.


exitedRegion( BeaconRegion beaconRegion)

Signal emitted when the device can no longer detect Bluetooth beacons from the specified region.


stateChangedForRegion( BeaconRegion beaconRegion, BeaconDiscoveryAgent::State state)

Signal emitted when the state has changed for the given region. Informed by the State enum.


Method Documentation

startMonitoringBeaconsInRegion(beaconRegion)

Starts the process of monitoring beacons in range from the specified region.

The beaconRegion parameter

The beacon region to start monitoring.


startRangingBeaconsInRegion(beaconRegion)

Begins the process of measuring proximity to beacons from the specified region.

The beaconRegion parameter

The beacon region to begin measuring the distance of beacons from.


stopMonitoringBeaconsInRegion(beaconRegion)

Stops the app from monitoring beacons in range from the specified region.

The beaconRegion parameter

The region to stop monitoring.


stopRangingBeaconsInRegion(beaconRegion)

Stops the app from measuring proximity to beacons in range from the specified region.

The beaconRegion parameter

The beacon region to stop ranging beacons from.