IBeacon

Improve this doc

This plugin provides functions for working with iBeacons.

The plugin's API closely mimics the one exposed through the CLLocationManager introduced in iOS 7.

Repo: https://github.com/petermetz/cordova-plugin-ibeacon

Installation

1. Install the Cordova and Ionic Native plugins:
   

   $ ionic cordova plugin add cordova-plugin-ibeacon
   $ npm install --save @ionic-native/ibeacon@4
   

2. Add this plugin to your app's module

Supported platforms

• Android
• iOS

Usage

import { IBeacon } from '@ionic-native/ibeacon';

constructor(private ibeacon: IBeacon) { }

...


// Request permission to use location on iOS
this.ibeacon.requestAlwaysAuthorization();
// create a new delegate and register it with the native layer
let delegate = this.ibeacon.Delegate();

// Subscribe to some of the delegate's event handlers
delegate.didRangeBeaconsInRegion()
  .subscribe(
    data => console.log('didRangeBeaconsInRegion: ', data),
    error => console.error()
  );
delegate.didStartMonitoringForRegion()
  .subscribe(
    data => console.log('didStartMonitoringForRegion: ', data),
    error => console.error()
  );
delegate.didEnterRegion()
  .subscribe(
    data => {
      console.log('didEnterRegion: ', data);
    }
  );

let beaconRegion = this.ibeacon.BeaconRegion('deskBeacon','F7826DA6-ASDF-ASDF-8024-BC5B71E0893E');

this.ibeacon.startMonitoringForRegion(beaconRegion)
  .then(
    () => console.log('Native layer received the request to monitoring'),
    error => console.error('Native layer failed to begin monitoring: ', error)
  );

Instance Members

Delegate()

Instances of this class are delegates between the LocationManager and the code that consumes the messages generated on in the native layer.

BeaconRegion(identifier, uuid, major, minor, notifyEntryStateOnDisplay)

Creates a new BeaconRegion

getDelegate()

setDelegate(delegate)

onDomDelegateReady()

Signals the native layer that the client side is ready to consume messages. Readiness here means that it has a {IBeaconDelegate} set by the consumer javascript code.

The {LocationManager.setDelegate()} will implicitly call this method as well, therefore the only case when you have to call this manually is if you don’t wish to specify a {IBeaconDelegate} of yours.

The purpose of this signaling mechanism is to make the events work when the app is being woken up by the Operating System to give it a chance to handle region monitoring events for example.

If you don’t set a {IBeaconDelegate} and don’t call this method manually, an error message get emitted in the native runtime and the DOM as well after a certain period of time.

isBluetoothEnabled()

Determines if bluetooth is switched on, according to the native layer.

enableBluetooth()

Enables Bluetooth using the native Layer. (ANDROID ONLY)

disableBluetooth()

Disables Bluetooth using the native Layer. (ANDROID ONLY)

startMonitoringForRegion(region)

Start monitoring the specified region.

If a region of the same type with the same identifier is already being monitored for this application, it will be removed from monitoring. For circular regions, the region monitoring service will prioritize regions by their size, favoring smaller regions over larger regions.

This is done asynchronously and may not be immediately reflected in monitoredRegions.

stopMonitoringForRegion(region)

Stop monitoring the specified region. It is valid to call stopMonitoringForRegion: for a region that was registered for monitoring with a different location manager object, during this or previous launches of your application.

This is done asynchronously and may not be immediately reflected in monitoredRegions.

requestStateForRegion(region)

Request state the for specified region. When result is ready didDetermineStateForRegion is triggered. This can be any region, also those which is not currently monitored.

This is done asynchronously and may not be immediately reflected in monitoredRegions.

startRangingBeaconsInRegion(region)

Start ranging the specified beacon region.

If a region of the same type with the same identifier is already being monitored for this application, it will be removed from monitoring.

This is done asynchronously and may not be immediately reflected in rangedRegions.

stopRangingBeaconsInRegion(region)

Stop ranging the specified region. It is valid to call stopMonitoringForRegion: for a region that was registered for ranging with a different location manager object, during this or previous launches of your application.

This is done asynchronously and may not be immediately reflected in rangedRegions.

getAuthorizationStatus()

Queries the native layer to determine the current authorization in effect.

requestWhenInUseAuthorization()

For iOS 8 and above only. The permission model has changed by Apple in iOS 8, making it necessary for apps to explicitly request permissions via methods like these: requestWhenInUseAuthorization requestAlwaysAuthorization

If you are using this plugin on Android devices only, you will never have to use this, nor {@code requestAlwaysAuthorization}

requestAlwaysAuthorization()

See the documentation of {@code requestWhenInUseAuthorization} for further details.

getMonitoredRegions()

getRangedRegions()

isRangingAvailable()

Determines if ranging is available or not, according to the native layer.

isMonitoringAvailableForClass(region)

Determines if region type is supported or not, according to the native layer.

startAdvertising(region, measuredPower:)

Start advertising the specified region.

If a region a different identifier is already being advertised for this application, it will be replaced with the new identifier.

This call will accept a valid beacon even when no BlueTooth is available, and will start when BlueTooth is powered on. See {IBeaconDelegate.}

stopAdvertising()

Stop advertising as a beacon.

This is done asynchronously and may not be immediately reflected in isAdvertising.

isAdvertisingAvailable()

Determines if advertising is available or not, according to the native layer.

isAdvertising()

Determines if advertising is currently active, according to the native layer.

disableDebugLogs()

Disables debug logging in the native layer. Use this method if you want to prevent this plugin from writing to the device logs.

enableDebugNotifications()

Enables the posting of debug notifications in the native layer. Use this method if you want to allow the plugin the posting local notifications. This can be very helpful when debugging how to apps behave when launched into the background.

disableDebugNotifications()

Disables the posting of debug notifications in the native layer. Use this method if you want to prevent the plugin from posting local notifications.

enableDebugLogs()

Enables debug logging in the native layer. Use this method if you want a debug the inner workings of this plugin.

appendToDeviceLog(message)

Appends the provided [message] to the device logs. Note: If debug logging is turned off, this won’t do anything.

Beacon

BeaconRegion

CircularRegion

IBeaconPluginResult

IBeaconDelegate