KTKBeaconManager Class Reference

Inherits from NSObject
Declared in KTKBeaconManager.h

Other Properties

  delegate

The delegate object to receive update events.

@property (nonatomic, weak, readwrite) id<KTKBeaconManagerDelegate> _Nullable delegate

Discussion

The delegate object to receive update events.

See Also

Declared In

KTKBeaconManager.h

Initialization Methods

– initWithDelegate:

Initializes and returns a beacon manager object with the specified delegate.

- (instancetype)initWithDelegate:(id<KTKBeaconManagerDelegate> _Nullable)delegate

Parameters

delegate

The delegate object to receive update events.

Return Value

An initialized beacon manager object.

Discussion

Initializes and returns a beacon manager object with the specified delegate.

See Also

Declared In

KTKBeaconManager.h

Core Location Authorization

– requestLocationAlwaysAuthorization

Requests permission to use location services whenever the app is running.

- (void)requestLocationAlwaysAuthorization

Discussion

Requests permission to use location services whenever the app is running.

Declared In

KTKBeaconManager.h

– requestLocationWhenInUseAuthorization

Requests permission to use location services while the app is in the foreground.

- (void)requestLocationWhenInUseAuthorization

Discussion

Requests permission to use location services while the app is in the foreground.

Declared In

KTKBeaconManager.h

+ locationAuthorizationStatus

Returns the app’s authorization status for using location services.

+ (CLAuthorizationStatus)locationAuthorizationStatus

Return Value

A value indicating whether the app is authorized to use location services.

Discussion

Returns the app’s authorization status for using location services.

Declared In

KTKBeaconManager.h

Monitoring Beacon Regions

+ isMonitoringAvailable

Returns a Boolean indicating whether the device supports monitoring for region.

+ (BOOL)isMonitoringAvailable

Return Value

YES if the device is capable of monitoring regions or NO if it is not.

Discussion

Returns a Boolean indicating whether the device supports monitoring for region.

Declared In

KTKBeaconManager.h

  monitoredRegions

The set of regions currently being monitored. (read-only)

@property (nonatomic, copy, readonly, nonnull) NSSet<__kindofKTKBeaconRegion*> *monitoredRegions

Discussion

The set of regions currently being monitored. (read-only)

See Also

Declared In

KTKBeaconManager.h

– startMonitoringForRegion:

Starts monitoring the specified region.

- (void)startMonitoringForRegion:(__kindof KTKBeaconRegion *)region

Parameters

region

The region object that defines the boundary to monitor. This parameter must not be nil.

Discussion

Starts monitoring the specified region.

For more details read Apple Documentation for startMonitoringForRegion: http://apple.co/1KbW5cY

See Also

Declared In

KTKBeaconManager.h

– stopMonitoringForRegion:

Stops monitoring the specified region.

- (void)stopMonitoringForRegion:(__kindof KTKBeaconRegion *)region

Parameters

region

The region object currently being monitored. This parameter must not be nil.

Discussion

Stops monitoring the specified region.

If the specified region object is not currently being monitored, this method has no effect. For more details read Apple Documentation for stopMonitoringForRegion: http://apple.co/1ODGt3L

See Also

Declared In

KTKBeaconManager.h

– stopMonitoringForAllRegions

Stops monitoring for all regions.

- (void)stopMonitoringForAllRegions

Discussion

Stops monitoring for all regions.

If any regions are monitored directly by an instance of CLLocationManager they will also be stopped as monitoredRegions property is shared between instances of CLLocationManager.

See Also

Declared In

KTKBeaconManager.h

– requestStateForRegion:

Retrieves the state of a region asynchronously.

- (void)requestStateForRegion:(__kindof KTKBeaconRegion *)region

Parameters

region

The region whose state you want to know.

Discussion

Retrieves the state of a region asynchronously.

See Also

Declared In

KTKBeaconManager.h

Ranging Beacons

  rangedRegions

The set of regions currently being tracked using ranging. (read-only)

@property (nonatomic, copy, readonly, nonnull) NSSet<__kindofKTKBeaconRegion*> *rangedRegions

Discussion

The set of regions currently being tracked using ranging. (read-only)

See Also

Declared In

KTKBeaconManager.h

+ isRangingAvailable

Returns a Boolean indicating whether the device supports ranging of beacons.

+ (BOOL)isRangingAvailable

Return Value

YES if the device supports ranging or NO if it does not

Discussion

Returns a Boolean indicating whether the device supports ranging of beacons.

Declared In

KTKBeaconManager.h

– startRangingBeaconsInRegion:

Starts the delivery of notifications for beacons in the specified region.

- (void)startRangingBeaconsInRegion:(__kindof KTKBeaconRegion *)region

Parameters

region

The region object that defines the identifying information for the targeted beacons. This parameter must not be nil.

Discussion

Starts the delivery of notifications for beacons in the specified region.

See Also

Declared In

KTKBeaconManager.h

– stopRangingBeaconsInRegion:

Stops the delivery of notifications for the specified beacon region.

- (void)stopRangingBeaconsInRegion:(__kindof KTKBeaconRegion *)region

Parameters

region

The region that identifies the beacons. This parameter must not be nil.

Discussion

Stops the delivery of notifications for the specified beacon region.

See Also

Declared In

KTKBeaconManager.h

– stopRangingBeaconsInAllRegions

Stops the delivery of notifications for all the beacon regions.

- (void)stopRangingBeaconsInAllRegions

Discussion

Stops the delivery of notifications for all the beacon regions.

See Also

Declared In

KTKBeaconManager.h