ISBeaconDelegate Protocol Reference

Conforms to NSObject
Declared in ISBeaconProvider.h

Overview

Protocol used to handle Beacon events.

– onEnterBeaconRegion: required method

Method called when the user enters in a monitored beaconRegion.

- (void)onEnterBeaconRegion:(ISBeaconRegion *)beaconRegion

Parameters

beaconRegion

The beacon region the user enters in.

Declared In

ISBeaconProvider.h

– onExitBeaconRegion: required method

Method called when the user exits a monitored beaconRegion.

- (void)onExitBeaconRegion:(ISBeaconRegion *)beaconRegion

Parameters

beaconRegion

The ISBeaconRegion the user exits.

Declared In

ISBeaconProvider.h

– onEnterBeacon:forRegion:

Method called when the beacon proximity is reached for an entered beaconRegion.

- (void)onEnterBeacon:(ISBeacon *)beacon forRegion:(ISBeaconRegion *)beaconRegion

Parameters

beacon

The beacon with reached proximity.
beaconRegion

The beaconRegion associated to the beacon with reached proximity.

Declared In

ISBeaconProvider.h

– onExitBeacon:forRegion:

Method called when the beacon proximity is not reached anymore for an entered beaconRegion.

- (void)onExitBeacon:(ISBeacon *)beacon forRegion:(ISBeaconRegion *)beaconRegion

Parameters

beacon

The beacon with proximity CLProximityFar or CLProximityUnknown.
beaconRegion

The beaconRegion associated to the beacon with the no more reached proximity.

Declared In

ISBeaconProvider.h

– shouldPresentLocalNotificationOnBeaconRegionEntry:

Method used to let the ISBeaconProvider managing the UILocalNotification presentation on a beaconRegion entry.

- (BOOL)shouldPresentLocalNotificationOnBeaconRegionEntry:(ISBeaconRegion *)beaconRegion

Parameters

beaconRegion

The beacon region the user enters in.

Return Value

If the ISBeaconProvider should manage the UILocalNotification presentation. YES, by default.

Declared In

ISBeaconProvider.h

– rangedBeacons:andReachedProximityBeacons:inRegion:andUnknownCLBeacons:withError:

Method used to get all ranged beacons in an entered beaconRegion and all beacons which have reached the region proximity.

- (void)rangedBeacons:(NSArray *)beacons andReachedProximityBeacons:(NSArray *)reachedProximityBeacons inRegion:(ISBeaconRegion *)beaconRegion andUnknownCLBeacons:(NSArray *)unknownCLBeacons withError:(NSError *)error

Parameters

beacons

All ranged beacons, nil if an error occured.
reachedProximityBeacons

beacons which have reached the region proximity, nil if an error occured.
beaconRegion

The ranged beaconRegion.
unknownCLBeacons

All CLBeacon which are not configured on the back office but found in the region.
error

If ranging for the region has failed.

Declared In

ISBeaconProvider.h

– onForceStopRanging

Method used to intercept when the beacon provider stops all ranging according to configuration.

- (void)onForceStopRanging

Declared In

ISBeaconProvider.h