Inherits from NSObject
Declared in SBKBeaconManager.h

Overview

The SBKBeaconManager class defines the interface for configuring the delivery of beacon-related events to your application. You use an instance of this class to get SBKBeacon objects, and establish the parameters that determine which beacon’s events should be delivered.

You should always use the shared instance. Creating own instance is not allowed.

Properties

delegate

The delegate of the app object.

@property (nonatomic, weak) id<SBKBeaconManagerDelegate> delegate

Discussion

The delegate of the app object.

Declared In

SBKBeaconManager.h

outOfRangeDelay

Delay out of range notifications delivering.

@property (readwrite, nonatomic) NSTimeInterval outOfRangeDelay

Discussion

Delay out of range notifications delivering.

In order to prevent notifications delivering too frequently, beacon will not be marked out of range immediately. Default value is 8 seconds, means a beacon will be marked out of range if it can not be ranged in last 8 seconds.

Declared In

SBKBeaconManager.h

Class Methods

sharedInstance

Returns the shared instance of the SBKBeaconManager class. Users are not allowed to create own instance.

+ (SBKBeaconManager *)sharedInstance

Discussion

Returns the shared instance of the SBKBeaconManager class. Users are not allowed to create own instance.

Declared In

SBKBeaconManager.h

Instance Methods

allBeacons

Get all the beacon instances.

- (NSArray *)allBeacons

Return Value

Beacon instances in array.

Discussion

Get all the beacon instances.

Declared In

SBKBeaconManager.h

beaconWithID:

Get the beacon instance with SBKBeaconID object.

- (SBKBeacon *)beaconWithID:(SBKBeaconID *)beaconID

Parameters

beaconID

Using SBKBeaconID object to identify the beacon you want.

Return Value

Beacon instance.

Discussion

Get the beacon instance with SBKBeaconID object.

This mehtod will always return a beacon instance even if the beacon has not been ranged. The beacon with same ID will only have one instance.

Warning: The SBKBeaconID object must have major and minor properties.

Declared In

SBKBeaconManager.h

beaconsInRange

Get the beacon instances in range now.

- (NSArray *)beaconsInRange

Return Value

Beacon instances in array, sorted by accuracy.

Discussion

Get the beacon instances in range now.

Declared In

SBKBeaconManager.h

rangedBeaconIDs

The set of SBKBeaconID currently being ranged.

- (NSSet *)rangedBeaconIDs

Return Value

The objects in the set are instances of the SBKBeaconID class

Discussion

The set of SBKBeaconID currently being ranged.

Declared In

SBKBeaconManager.h

requestAlwaysAuthorization

@name Initiating Beacon Ranging

- (void)requestAlwaysAuthorization

Discussion

@name Initiating Beacon Ranging

Declared In

SBKBeaconManager.h

startRangingBeaconsWithID:wakeUpApplication:

Starts the delivery of notifications for beacons with specified id.

- (void)startRangingBeaconsWithID:(SBKBeaconID *)beaconID wakeUpApplication:(BOOL)wakeUpApplication

Parameters

beaconID

Using SBKBeaconID object to identify the beacons.

wakeUpApplication

Wake up your application in background when those beacons being ranged.

Discussion

Starts the delivery of notifications for beacons with specified id.

Declared In

SBKBeaconManager.h

stopRangingAllBeacons

Stops the delivery of notifications for all beacons.

- (void)stopRangingAllBeacons

Discussion

Stops the delivery of notifications for all beacons.

Declared In

SBKBeaconManager.h

stopRangingBeaconsWithID:

Stops the delivery of notifications for beacons with specified id.

- (void)stopRangingBeaconsWithID:(SBKBeaconID *)beaconID

Parameters

beaconID

Using SBKBeaconID object to identify the beacons.

Discussion

Stops the delivery of notifications for beacons with specified id.

Declared In

SBKBeaconManager.h