The implementation currently in use. This should be one of the following depending on the platform in use and the functionality supported by this extension:

• Android
• iOS
• default
• unknown

Whether the current device supports the extensions functionality

The native version string of the native extension.

The singleton instance of the Beacon class.

The version of this extension.

This should be of the format, MAJOR.MINOR.BUILD

Constructor You should not call this directly, but instead use the singleton access

Retrieves the current authorisation status.

Disposes the extension and releases any allocated resources. Once this function has been called, a call to init is neccesary again before any of the extensions functionality will work.

Returns true if the current authorisation status is either IN_USE or ALWAYS.

Retrieves the current authorisation status of this application.

There are several possible values as defined in the AuthorisationStatus class.

See also

Initialises the extension class for use with the provided key.

Parameters

Checks the current state of the bluetooth adapter. This can be used to check if the user has disabled bluetooth on the device.

Note: On application startup this may return false even though the adapter is turned on. You should delay calls to this function until the application is up and running.

Whether the device can act as a beacon and broadcast appropriately.

This will return false, if the device doesn't have the required OS version or it doesn't have the appropriate Bluetooth LE hardware.

Additionally it will return false if bluetooth is not enabled on the device, you should check the bluetooth enabled flag before attempting to access this flag.

Checks if there is already a monitor in process for the specified region

Parameters

Performs a simple operation to force the display of the permission dialog.

Note on iOS this will only be shown if the authorisation status is currently NOT_DETERMINED

This allows you to control when the permission dialog is presented.

Parameters

Starts the current device broadcasting as a beacon.

The application must be running in the foreground for broadcasting to work.

Parameters

This function starts monitoring a a region with the specified uuid. Calling this function the application will start monitoring for entry and exit notifications from the specified region, including the notify entry state on display flag.

Once a region is entered the application will automatically start ranging for beacons. As ranging only works in the foreground your application will receive events only when running in the foreground.

" In general ranging only works in the foreground, but monitoring updates can happen in the background. There are two ways to configure background monitoring, and even when done properly updates can take a long time to come. Because these delays, some people mistakenly believe that monitoring in the background doesn't work. "

When the application is in the foreground, a region change detection can take ~ 1 second.

If you wish to monitor multiple regions simulataneously you must make sure that the identifier parameter is unique for each region as well as the uuid! If you do not you will only receive updates for the last region you started monitoring. The iOS SDK uses the identifier to determine if the region is unique, and replaces any existing region monitoring if it is the same.

Parameters

Stops the device broadcasting as a beacon.

Stops monitoring a region for updates.

Parameters

Dispatched when the user changes the authorisation status. The status will indicate the new authorisation status.

Dispatched when an update occurs about the available beacons. The beacons will contain the list of available beacons.

Dispatched when the bluetooth adapter changes state to disabled.

Dispatched when the bluetooth adapter changes state to enabled.

Dispatched if there was an error when starting broadcasting

Dispatched when the broadcasting starts successfully.

Dispatched when broadcasting stops.

Dispatched when the device enters a monitored region. The event will contain a valid region describing the region that has been entered/discovered.

Once this event is dispatched you can expect to get updates about the beacons in the region in periodic intervals

Dispatched when it appears the device has exitted the region. You should stop receiving beacon update events.

Dispatched when a region is started monitoring for entry and exit. This usually occurs almost immediately after a call startMonitoringRegionWithUUID

The following example demonstrates the base usage of the beacon monitoring, showing the event listeners and monitoring requirements.

     try
     {
      if (Beacon.isSupported)
         {
             Beacon.init( "YOUR_DEVELOPER_KEY" );
             
             Beacon.service.addEventListener( BeaconEvent.REGION_MONITORING_START, beacon_monitoringStartHandler, false, 0, true );
             Beacon.service.addEventListener( BeaconEvent.REGION_ENTER, beacon_regionEnterHandler, false, 0, true );
             Beacon.service.addEventListener( BeaconEvent.REGION_EXIT, beacon_regionExitHandler, false, 0, true );
             Beacon.service.addEventListener( BeaconEvent.BEACON_UPDATE, beacon_beaconUpdateHandler, false, 0, true );
     
             Beacon.service.startMonitoringRegionWithUUID( UUID, "testing" );
         }
     }
     catch (e:Error)
     {
     }
     
     
     ...
     
     
     //
     //    EXTENSION HANDLERS
     //
     
     private function beacon_monitoringStartHandler( event:BeaconEvent ):void
     {
         trace( "monitoring started" );
     }
     
     
     private function beacon_regionEnterHandler( event:BeaconEvent ):void
     {
         trace( "Entered region: " + event.region.uuid );
     }
     
     
     private function beacon_regionExitHandler( event:BeaconEvent ):void
     {
         trace( "Exit region: " + event.region.uuid );
     }
     
     
     private function beacon_beaconUpdateHandler( event:BeaconEvent ):void
     {
         trace( "Beacon update for region: "+event.region.uuid );
         for each (var beacon:BeaconObject in event.beacons)
         {
             trace( "Beacon: "+beacon.major+"."+beacon.minor +"::"+beacon.proximity +"["+beacon.accuracy +"]");
         }
     }