BLUBeaconManagerDelegate Protocol Reference

Conforms to NSObject
Declared in BLUBeaconManager.h

Overview

The BLUBeaconManagerDelegate protocol defines the methods that a delegate of a BLUBeaconManager object must adopt.

The beacon manager delegate provides events for all types of beacon discovery. CoreLocation and CoreBluetooth monitoring will invoke the same methods. For example if beaconManager:didRangeBeacons:inRegion: is invoked, then beaconManager:beacon:didChangeDistance: will be invoked with the same beacon object.

For more information on iBeacon monitoring see Apple’s Core Location documentation. It is not required to adopt all Core Location delegate methods as the framework provides them in lieu of their absence.

Beacon Monitoring

– beaconManager:centralManagerDidChangeState:

Tells the delegate that the state of the beacon manager’s CBCentralManager has changed.

- (void)beaconManager:(BLUBeaconManager *)manager centralManagerDidChangeState:(CBCentralManagerState)state

Parameters

manager

The beacon manager providing this information.

state

The new state of the central manager.

Discussion

Tells the delegate that the state of the beacon manager’s CBCentralManager has changed.

Declared In

BLUBeaconManager.h

– beaconManager:didFailWithError:

Tells the delegate that the beacon manager encountered an error.

- (void)beaconManager:(BLUBeaconManager *)manager didFailWithError:(nullable NSError *)error

Parameters

manager

The beacon manager providing this information.

error

The cause of the failure.

Discussion

Tells the delegate that the beacon manager encountered an error.

Declared In

BLUBeaconManager.h

– beaconManager:didFindBeacon:

Invoked when the beacon manager finds a beacon for the first time. This will only be invoked once for the lifetime of a beacon

- (void)beaconManager:(BLUBeaconManager *)manager didFindBeacon:(BLUBeacon *)beacon

Parameters

manager

The beacon manager providing this information.

beacon

The BLUBeacon subclass that was found.

Discussion

Invoked when the beacon manager finds a beacon for the first time. This will only be invoked once for the lifetime of a beacon

Declared In

BLUBeaconManager.h

– beaconManager:didLoseBeacon:

Invoked when the beacon manager loses sight of a beacon. This will only be invoked once at the end of the lifetime of a beacon.

- (void)beaconManager:(BLUBeaconManager *)manager didLoseBeacon:(BLUBeacon *)beacon

Parameters

manager

The beacon manager providing this information.

beacon

The BLUBeacon subclass that was found.

Discussion

Invoked when the beacon manager loses sight of a beacon. This will only be invoked once at the end of the lifetime of a beacon.

Declared In

BLUBeaconManager.h

– beaconManager:beacon:didChangeDistance:

Tells the delegate that a monitored beacon has a change in distance.

- (void)beaconManager:(BLUBeaconManager *)manager beacon:(BLUBeacon *)beacon didChangeDistance:(BLUDistance)distance

Parameters

manager

The beacon manager providing this information.

beacon

The BLUBeacon subclass whose distance has changed.

distance

The new distance value.

Discussion

Tells the delegate that a monitored beacon has a change in distance.

Declared In

BLUBeaconManager.h

CoreLocation Based Monitoring

– beaconManager:didChangeAuthorizationStatus:

Tells the delegate that the authorization status for the application changed.

- (void)beaconManager:(BLUBeaconManager *)manager didChangeAuthorizationStatus:(CLAuthorizationStatus)status

Parameters

manager

The beacon manager providing this information.

status

The new authorization status for the application.

Discussion

Tells the delegate that the authorization status for the application changed.

Declared In

BLUBeaconManager.h

– beaconManager:didEnterRegion:

Tells the delegate that the user entered the specified region.

- (void)beaconManager:(BLUBeaconManager *)manager didEnterRegion:(CLBeaconRegion *)region

Parameters

manager

The beacon manager providing this information.

region

The region that was entered

Discussion

Tells the delegate that the user entered the specified region.

Declared In

BLUBeaconManager.h

– beaconManager:didExitRegion:

Tells the delegate that the user left the specified region.

- (void)beaconManager:(BLUBeaconManager *)manager didExitRegion:(CLBeaconRegion *)region

Parameters

manager

The beacon manager providing this information.

region

The region that was exited.

Discussion

Tells the delegate that the user left the specified region.

Declared In

BLUBeaconManager.h

– beaconManager:didDetermineState:forRegion:

Tells the delegate about the state of the specified region.

- (void)beaconManager:(BLUBeaconManager *)manager didDetermineState:(CLRegionState)state forRegion:(CLBeaconRegion *)region

Parameters

manager

The beacon manager providing this information.

state

The state of the specified region. For a list of possible values, see the CLRegionState type.

region

The region whose state was determined.

Discussion

Tells the delegate about the state of the specified region.

Declared In

BLUBeaconManager.h

– beaconManager:didStartMonitoringForRegion:

Tells the delegate that a new region is being monitored.

- (void)beaconManager:(BLUBeaconManager *)manager didStartMonitoringForRegion:(CLBeaconRegion *)region

Parameters

manager

The beacon manager providing this information.

region

The region that is being monitored.

Discussion

Tells the delegate that a new region is being monitored.

Declared In

BLUBeaconManager.h

– beaconManager:didRangeBeacons:inRegion:

Tells the delegate that one or more beacons are in range.

- (void)beaconManager:(BLUBeaconManager *)manager didRangeBeacons:(__kindof NSArray<BLUBeacon*> *)beacons inRegion:(CLBeaconRegion *)region

Parameters

manager

The beacon manager providing this information

beacons

An array of BLUIBeacon objects currently in range.

region

The region containing the parameters that were used to locate the beacons.

Discussion

Tells the delegate that one or more beacons are in range.

Declared In

BLUBeaconManager.h