# Modules.BLE.BeaconRegion

A region used to detect the presence of iBeacon devices.

Availability

1.1.0

Extends

# Overview

A BeaconRegion object defines a region that you use to detect Bluetooth beacons conforming to the iBeacon specification.

# Properties

# identifier

Availability

1.1.0

identifier :String

This is a value that you specify and can use to identify this region inside your application.

# major

Availability

1.1.0

major :Number

The value identifying a group of beacons.

# minor

Availability

1.1.0

minor :Number

The value identifying a specific beacon within a group.

# notifyEntryStateOnDisplay

Availability

1.1.0

notifyEntryStateOnDisplay :Number

The relative distance to the beacon. A Boolean indicating whether beacon notifications are sent when the device’s display is on. When set to true, the region manager sends beacon notifications when the user turns on the display and the device is already inside the region. These notifications are sent even if your app is not running. In that situation, the system launches your app into the background so that it can handle the notifications. In both situations, the app will receive a BLE.determinedStateForRegion:event event.

# uuid

Availability

1.1.0

uuid :String

The unique ID of the beacons being targeted.