com.kony.BeaconManager

authorizationStatus

This method helps you know the authorization status of the location services for the application.

Syntax

authorizationStatus();

Input Parameters

None.

Example


var authorizationStatus1 = aBeaconManager.authorizationStatus();

Return Values

Returns one of the following strings.

Constant	Description
BeaconManagerAuthorizationStatusNotDetermined	The user has not made a choice regarding whether this application can use location services.
BeaconManagerAuthorizationStatusRestricted	This application is not authorized to use location services. The user cannot change this application’s status, possibly due to active restrictions such as parental controls being in place
BeaconManagerAuthorizationStatusDenied	The user explicitly denied the use of location services for this application or location services are currently disabled in Settings.
BeaconManagerAuthorizationStatusAuthorized	This application is authorized to use location services.

Remarks

The authorization status of a given application is managed by the system and determined by several factors. Applications must be explicitly authorized to use location services by the user, and location services must currently be enabled for the system. A request for user authorization is displayed automatically when your application first attempts to use location services.

Availability

iOS

getMonitoredRegions

This API gets the Beacon Regions that are currently being monitored. You cannot add regions to this property directly. Instead, you must register regions by calling the startMonitoringForRegion method.

Syntax

getMonitoredRegions();

Input Parameters

None.

Example


var monitoredRegions = aBeaconManager.getMonitoredRegions();

Return Values

Returns an array containing all of the BeaconRegion objects that are being monitored by the BeaconManager.

Availability

iOS

getRangedRegions

Gets the the BeaconRegion objects that are currently being ranged.

Syntax

getRangedRegions();

Input Parameters

None

Example


var rangedRegions1 = aBeaconManager.getRangedRegions();

Return Values

Returns an array containing all of the BeaconRegion objects that are being ranged by the BeaconManager.

Availability

iOS

isMonitoringAvailableForBeaconRegions

Determine whether monitoring is available for the beacon regions.

Syntax

isMonitoringAvailableForBeaconRegions();

Input Parameters

None.

Example


var isMonitoringAvailableForBeaconRegions1 = aBeaconManager.isMonitoringAvailableForBeaconRegions();

Return Values

Returns True if monitoring is available for the beacon regions, or false if it is not.

Availability

iOS

isRangingAvailableForBeaconRegions

Determine whether ranging is available for the beacon regions.

Syntax

isRangingAvailableForBeaconRegions();

Input Parameters

None.

Example


var isRangingAvailableForBeaconRegions1 = aBeaconManager.isRangingAvailableForBeaconRegions();

Return Values

Returns True if ranging is available for the beacon regions, or false if it is not.

Availability

iOS

requestStateForRegion

Determine the state of the current device relative to the beacon region.

Syntax

requestStateForRegion(beaconRegion);

Input Parameters

Parameter	Description
beaconRegion	The beacon region whose state is queried.

Example


aBeaconManager.requestStateForRegion(beaconRegion);

Return Values

None.

Remarks

This method performs the request asynchronously and delivers the results through the monitoringCallback function that your app sets by calling setMonitoringStartedForRegionCallback.

Availability

iOS

setAuthorizationStatusChangedCallback

Sets the callback function that retrieves the authorization status changes.

Syntax

setAuthorizationStatusChangedCallback(statusChangedCallbackFunction);

Input Parameters

Parameter	Description
statusChangedCallback	A callback function that retrieves changes in the authorization status. For details, see the Remarks section below.

Example


aBeaconManager.setAuthorizationStatusChangedCallback(authorizationStatusChanged);

Return Values

None

Remarks

This method sets a callback function that is invoked whenever the authorization status changes. It enables your app to retrieve status change updates asynchronously whenever they occur. The callback must have the following signature.

function authorizationStatusChanged(Status);

where the callback's Status parameter is a string that contains one of the following values.

Constant	Description
BeaconManagerAuthorizationStatusAuthorized	This application is authorized to use location services.
BeaconManagerAuthorizationStatusDenied	The user explicitly denied the use of location services for this application or location services are currently disabled in Settings.
BeaconManagerAuthorizationStatusNotDetermined	The user has not made a choice regarding whether this application can use location services.
BeaconManagerAuthorizationStatusRestricted	This application is not authorized to use location services. The user cannot change this application’s status, possibly due to active restrictions such as parental controls being in place.

Availability

iOS

setMonitoringStartedForRegionCallback

Sets the monitoring started for region callback.

Syntax

setMonitoringStartedForRegionCallback(regionMonitoringCallback);

Input Parameters

Parameter	Description
regionMonitoringCallback	A callback function that is invoked when a monitoring starts in an new beacon region. For details, see Remarks below.

Example


aBeaconManager.setMonitoringStartedForRegionCallback(monitoringStartedForRegionCallback);

Return Values

None

Remarks

This method sets a callback that informs the app that a new region is being monitored. The callback must have the following signature.

function monitoringStartedForRegionCallback(beaconRegion);

where the callback's beaconRegion parameter is a BeaconRegion object that contains the beacon region in which monitoring has started.

Availability

iOS

startMonitoringBeaconRegion

Start monitoring for the specified Beacon Region.

Syntax

startMonitoringBeaconRegion(beaconRegion);

Input Parameters

Parameter	Description
beaconRegion	A BeaconRegion object that contains the beacon region to monitor.

Example


aBeaconManager.startMonitoringBeaconRegion(beaconRegion);

Return Values

None

Remarks

Your app must call this method once for each region it needs to monitor. If an existing region with the same identifier is already being monitored by the application, the old region is replaced by the new one. Region events are delivered through the monitoringCallback function that your app sets by calling setMonitoringStartedForRegionCallback..

Availability

iOS

startRangingBeaconsInRegion

Starts ranging beacons in a specified beacon region.

Syntax

startRangingBeaconsInRegion(beaconRegion);

Input Parameters

Parameter	Description
beaconRegion	A BeaconRegion object to use for ranging.

Example


aBeaconManager.startRangingBeaconsInRegion(beaconRegion);

Return Values

None.

Remarks

Your app calls this function once the region monitored state is "BeaconRegionStateInside".

Availability

iOS

stopMonitoringBeaconsRegion

Stops monitoring a specified beacon region.

Syntax

stopMonitoringBeaconRegion(beaconRegion);

Input Parameters

Parameter	Description
beaconRegion	The BeaconRegion to stop monitoring.

Example


aBeaconManager.stopMonitoringBeaconsRegion(beaconRegion);

Return Values

None

Availability

iOS

stopRangingBeaconsInRegion

Stop ranging beacons in a specified Beacon Region.

Syntax

stopRangingBeaconsInRegion();

Input Parameters

Parameter	Description
beaconRegion	The BeaconRegion to stop ranging.

Example


aBeaconManager.stopRangingBeaconsInRegion(beaconRegion);

Return Values

None.

Remarks

If the specified region object is not currently being monitored, this method has no effect. When you call this method, the beacon attributes should be the same object that you registered.

Availability

iOS

com.kony.BeaconManager

Methods