Inherits from NSObject
Declared in LimeBeaconManager.h
LimeBeaconManager.m

Overview

A manager class responsible for maintaining list of currently visible beacons and for providing callbacks about the beacons visibility change.

Tasks

Properties

beacons

List of currently visible Lime beacons.

@property (nonatomic, strong) NSArray *beacons

Discussion

List of currently visible Lime beacons.

Declared In

LimeBeaconManager.h

Instance Methods

didUpdateBeaconRegion:state:

A callback that is sent by the LimeLocationManager in case region state changes.

- (void)didUpdateBeaconRegion:(CLRegion *)region state:(CLRegionState)state

Parameters

region

Beacon region that was updated.

state

State of the updated region.

Discussion

A callback that is sent by the LimeLocationManager in case region state changes.

Declared In

LimeBeaconManager.h

didUpdateBeacons:inRegion:

A callback that is sent by the LimeLocationManager in case beacons are found during beacon ranging.

- (void)didUpdateBeacons:(NSArray *)beacons inRegion:(CLBeaconRegion *)region

Parameters

beacons

Beacons that were found in given region.

region

Beacon region that is associated with the beacons found.

Discussion

A callback that is sent by the LimeLocationManager in case beacons are found during beacon ranging.

Declared In

LimeBeaconManager.h

initWithLocationManager:

Init a new geofence manager instance passing the single location manager.

- (instancetype)initWithLocationManager:(LimeLocationManager *)locationManager

Parameters

locationManager

Location manager that is responsible for location related callbacks.

Return Value

A new instance of a geofence manager.

Discussion

Init a new geofence manager instance passing the single location manager.

Declared In

LimeBeaconManager.h

startListeningForBeacons:beaconVisibilityStatusChange:

Starts listening for beacons with given proximity UUIDs and passes any changes of currently visible beacons via the callback block.

- (void)startListeningForBeacons:(NSArray *)uuids beaconVisibilityStatusChange:(BeaconVisibilityStatusChange)beaconVisibilityStatusChange

Parameters

uuids

List of proximity UUID strings used for beacon monitoring.

beaconVisibilityStatusChange

A callback that receives found, stale or lost beacon instances (LimeBeacon class).

Discussion

Starts listening for beacons with given proximity UUIDs and passes any changes of currently visible beacons via the callback block.

Declared In

LimeBeaconManager.h

startRangingForBeacons

Actively starts ranging for beacons, despite the fact beacon region was not crossed. This method is handy when you need to start looking for the beacon in situation mobile device already is in the beacon region. This method can be invoked before the list of proximity UUIDs is downloaded from the Lime CMS - ranging will start as soon as the UUIDs are available.

- (void)startRangingForBeacons

Discussion

Actively starts ranging for beacons, despite the fact beacon region was not crossed. This method is handy when you need to start looking for the beacon in situation mobile device already is in the beacon region. This method can be invoked before the list of proximity UUIDs is downloaded from the Lime CMS - ranging will start as soon as the UUIDs are available.

Declared In

LimeBeaconManager.h

stopListeningForBeacons

This method stops listening for beacons.

- (void)stopListeningForBeacons

Discussion

This method stops listening for beacons.

Declared In

LimeBeaconManager.h

stopRangingForBeacons

Stops actively ranging for beacons.

- (void)stopRangingForBeacons

Discussion

Stops actively ranging for beacons.

Declared In

LimeBeaconManager.h