Beacons are devices that support Bluetooth low energy and allow bi-directional communications with them. So, with beacons, you can take advantage of this new way of communication and solve new scenarios of Geofencing with accuracy and enable to solve several in-door localization problems.
Note: See
Beacons Scenarios to see why Beacons become important in many localization scenarios.
Determines whether the device supports ranging. If False, all attempts to range beacons will fail.
Determines whether the device supports beacon proximity alerts. If False, all attempts to set proximity alerts will fail.
Determines whether the user has location services enabled. If False, and you proceed to call other Beacons, the user will be prompted with the warning or fail depending on the current authorization status.
Returns the current authorization status. It is based on APIAuthorizationStatus domain.
Start monitoring the specified beacon region.
Details in AddBeaconProximityAlert method.
| Return value |
Boolean |
| Parameters |
proximityAlert:BeaconProximityAlert |
| |
|
Start monitoring the specified beacon regions (multiple beacons).
Details in AddBeaconProximityAlerts method.
| Return value |
Boolean |
| Parameters |
proximityAlerts:Collection( BeaconProximityAlert ) |
| |
|
Retrieve a collection for the beacon regions that are currently being monitored.
Details in GetBeaconProximityAlerts method
| Return value |
Collection( BeaconProximityAlert ) |
| Parameters |
None |
| |
|
Removes the beacon region being monitored.
Details in RemoveBeaconProximityAlert method.
| Return value |
None |
| Parameters |
proximityAlertRegionId:VarChar(256) |
| |
|
Removes all the beacon regions being monitored.
Details in ClearBeaconProximityAlerts method.
| Return value |
None |
| Parameters |
None |
| |
|
Retrieve the cached state of the specified region.
Details in GetBeaconRegionState method.
Starts the delivery of notifications for beacons in the specified region.
Details in StartRangingBeaconRegion method
| Return value |
Boolean |
| Parameters |
beaconRegion:BeaconRegion |
| |
|
Retrieve a collection for the beacon regions that are currently providing ranging.
Details in GetRangedBeaconRegions method.
| Return value |
Collection( BeaconRegion ) |
| Parameters |
None |
| |
|
Stops the delivery of notifications for the specified beacon region.
Details in StopRangingBeaconRegion method.
Retrieve a collection for the beacons (sorted by proximity) currently in range for the given region.
Details in GetBeaconsInRange method.
| Return value |
Collection( BeaconState ) |
| Parameters |
regionId:VarChar(256) |
| |
|
Advertises the current device as a beacon.
Details in StartAsBeacon method.
| Return value |
Boolean |
| Parameters |
beaconInfo:BeaconInfo |
| |
|
Stops advertising the current device as a beacon.
Details in StopAsBeacon method.
| Return value |
Boolean |
| Parameters |
None |
| |
|
Invoked when the user enters a monitored beacon region.
Details in EnterBeaconRegion event.
| Input |
beaconRegion:BeaconRegion |
| Ouytput |
None |
| |
|
Invoked when the user exits a monitored beacon region.
Details in ExitBeaconRegion event.
| Input |
beaconRegion:BeaconRegion |
| Ouytput |
None |
| |
|
Invoked when a new set of beacons' states are available in the specified region.
Details in ChangeBeaconsInRange event.
| Input |
beaconRegion:BeaconRegion, beacons:Collection( BeaconState ) |
| Ouytput |
None |
| |
|
Detailed description in APIAuthorizationStatus domain.
Detailed description in BeaconInfo Data Type.
Detailed description in BeaconProximityAlert Data Type
Detailed description in BeaconRegion Data Type
Detailed description in BeaconState Data Type
| Platforms |
Smart Devices (iOS, Android) |
This external object is available for iOS since GeneXus X Evolution 3 Upgrade 2 and for Android since GeneXus 16 Upgrade 11.