KTKBeaconRegion Class Reference

Inherits from	NSObject
Conforms to	NSCopying NSSecureCoding
Declared in	KTKBeaconRegion.h

Region Properties

`proximityUUID`

The proximity ID of the beacons being targeted. (read-only)

@property (nonatomic, strong, readonly) NSUUID *proximityUUID

Discussion

The proximity ID of the beacons being targeted. (read-only)

Declared In

KTKBeaconRegion.h

`major`

The value identifying a group of beacons. (read-only)

@property (nonatomic, strong, readonly) NSNumber *major

Discussion

The value identifying a group of beacons. (read-only)

Declared In

KTKBeaconRegion.h

`minor`

The value identifying a specific beacon within a group. (read-only)

@property (nonatomic, strong, readonly) NSNumber *minor

Discussion

The value identifying a specific beacon within a group. (read-only)

Declared In

KTKBeaconRegion.h

`identifier`

A unique identifier to associate with the region object. You use this identifier to differentiate regions within your application. (read-only)

@property (nonatomic, copy, readonly) NSString *identifier

Discussion

A unique identifier to associate with the region object. You use this identifier to differentiate regions within your application. (read-only)

Declared In

KTKBeaconRegion.h

`notifyEntryStateOnDisplay`

A Boolean indicating whether beacon notifications are sent when the device’s display is on.

@property (nonatomic, assign) BOOL notifyEntryStateOnDisplay

Discussion

A Boolean indicating whether beacon notifications are sent when the device’s display is on.

Declared In

KTKBeaconRegion.h

`notifyOnEntry`

A Boolean indicating that notifications are generated upon entry into the region.

@property (nonatomic, assign) BOOL notifyOnEntry

Discussion

A Boolean indicating that notifications are generated upon entry into the region.

Declared In

KTKBeaconRegion.h

`notifyOnExit`

A Boolean indicating that notifications are generated upon exit from the region.

@property (nonatomic, assign) BOOL notifyOnExit

Discussion

A Boolean indicating that notifications are generated upon exit from the region.

Declared In

KTKBeaconRegion.h

Initialization Methods

`– initWithProximityUUID:identifier:`

Initializes and returns a region object that targets a beacon with the specified proximity ID.

- (instancetype)initWithProximityUUID:(NSUUID *)proximityUUID identifier:(NSString *)identifier

Parameters

`proximityUUID`	The proximity ID of the beacons being targeted. This value must not be nil.
`identifier`	A unique identifier to associate with the returned region object. You use this identifier to differentiate regions within your application. This value must not be nil.

Return Value

An initialized beacon region object.

Discussion

Initializes and returns a region object that targets a beacon with the specified proximity ID.

Declared In

KTKBeaconRegion.h

`– initWithProximityUUID:major:identifier:`

Initializes and returns a region object that targets a beacon with the specified proximity ID and major value.

- (instancetype)initWithProximityUUID:(NSUUID *)proximityUUID major:(CLBeaconMajorValue)major identifier:(NSString *)identifier

Parameters

`proximityUUID`	The proximity ID of the beacons being targeted. This value must not be nil.
`major`	The major value that you use to identify one or more beacons.
`identifier`	A unique identifier to associate with the returned region object. You use this identifier to differentiate regions within your application. This value must not be nil.

Return Value

An initialized beacon region object.

Discussion

Initializes and returns a region object that targets a beacon with the specified proximity ID and major value.

Declared In

KTKBeaconRegion.h

`– initWithProximityUUID:major:minor:identifier:`

Initializes and returns a region object that targets a beacon with the specified proximity ID, major value, and minor value.

- (instancetype)initWithProximityUUID:(NSUUID *)proximityUUID major:(CLBeaconMajorValue)major minor:(CLBeaconMinorValue)minor identifier:(NSString *)identifier

Parameters

`proximityUUID`	The proximity ID of the beacons being targeted. This value must not be nil.
`major`	The major value that you use to identify one or more beacons.
`minor`	The minor value that you use to identify a specific beacon.
`identifier`	A unique identifier to associate with the returned region object. You use this identifier to differentiate regions within your application. This value must not be nil.

Return Value

An initialized beacon region object.

Discussion

Initializes and returns a region object that targets a beacon with the specified proximity ID, major value, and minor value.

Declared In

KTKBeaconRegion.h