Beacons external object

Official Content
This documentation is valid for:

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.

Beaconsexternalobject-Location_png image_201861311343_1_png

Note: See Beacons Scenarios to see why Beacons become important in many localization scenarios.

Properties

RangingAvailable property

Determines whether the device supports ranging. If False, all attempts to range beacons will fail.

BeaconProximityAlertsAvailable property

Determines whether the device supports beacon proximity alerts. If False, all attempts to set proximity alerts will fail.

ServiceEnabled property

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.

AuthorizationStatus property

Returns the current authorization status. It is based on APIAuthorizationStatus domain.

 

Methods

AddBeaconProximityAlert method

Start monitoring the specified beacon region.
Details in AddBeaconProximityAlert method.

Return value  Boolean
Parameters proximityAlert:BeaconProximityAlert
   

AddBeaconProximityAlerts method

Start monitoring the specified beacon regions (multiple beacons).
Details in AddBeaconProximityAlerts method.

Return value  Boolean
Parameters proximityAlerts:Collection( BeaconProximityAlert )
   

 

GetBeaconProximityAlerts method

Retrieve a collection for the beacon regions that are currently being monitored.
Details in GetBeaconProximityAlerts method

Return value  Collection( BeaconProximityAlert )
Parameters None
   

RemoveBeaconProximityAlert method

Removes the beacon region being monitored.
Details in RemoveBeaconProximityAlert method.

Return value  None
Parameters proximityAlertRegionId:VarChar(256)
   

ClearBeaconProximityAlerts method

Removes all the beacon regions being monitored.
Details in ClearBeaconProximityAlerts method.

Return value  None
Parameters None
   

GetBeaconRegionState method

Retrieve the cached state of the specified region.
Details in GetBeaconRegionState method.

Return value  RegionState
Parameters regionId:VarChar(256)
   

StartRangingBeaconRegion method

Starts the delivery of notifications for beacons in the specified region.
Details in StartRangingBeaconRegion method

Return value  Boolean
Parameters beaconRegion:BeaconRegion
   

GetRangedBeaconRegions method

Retrieve a collection for the beacon regions that are currently providing ranging.
Details in GetRangedBeaconRegions method.

Return value  Collection( BeaconRegion )
Parameters None
   

StopRangingBeaconRegion method

Stops the delivery of notifications for the specified beacon region.
Details in StopRangingBeaconRegion method.

Return value  None
Parameters regionId:VarChar(256)
   

GetBeaconsInRange 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)
   

StartAsBeacon method

Advertises the current device as a beacon.
Details in StartAsBeacon method.

Return value  Boolean
Parameters beaconInfo:BeaconInfo
   

StopAsBeacon method

Stops advertising the current device as a beacon.
Details in StopAsBeacon method.

Return value  Boolean
Parameters None
   

Events

EnterBeaconRegion event

Invoked when the user enters a monitored beacon region.
Details in EnterBeaconRegion event.

Input beaconRegion:BeaconRegion
Ouytput  None
   

ExitBeaconRegion event

Invoked when the user exits a monitored beacon region.
Details in ExitBeaconRegion event.

Input beaconRegion:BeaconRegion
Ouytput  None
   

ChangeBeaconsInRange event

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
   

Domains

APIAuthorizationStatus domain

Detailed description in APIAuthorizationStatus domain.

Structured Data Types

BeaconInfo

Detailed description in BeaconInfo Data Type.

BeaconProximityAlert

Detailed description in BeaconProximityAlert Data Type

BeaconRegion

Detailed description in BeaconRegion Data Type

BeaconState

Detailed description in BeaconState Data Type

Scope

Platforms  Smart Devices (iOS, Android)

Availability

This external object is available for iOS since GeneXus X Evolution 3 Upgrade 2.

See Also



Was this page helpful?
What Is This?
Your feedback about this content is important. Let us know what you think.