Inherits from NSObject
Conforms to NSCopying
Declared in SBKBeaconID.h

Overview

SBKBeaconID instance is an obejct to specify a beacon’s identity. The proximityUUID property will never be nil, major and minor are optional.

Tasks

Initializing the Beacon ID

Comparing Beacon IDs

Accessing the Attributes

Bridge to Core Bluetooth

Bridge to String

Properties

major

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

@property (readonly, nonatomic) NSNumber *major

Discussion

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

Declared In

SBKBeaconID.h

minor

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

@property (readonly, nonatomic) NSNumber *minor

Discussion

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

Declared In

SBKBeaconID.h

proximityUUID

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

@property (readonly, nonatomic) NSUUID *proximityUUID

Discussion

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

Declared In

SBKBeaconID.h

Class Methods

beaconIDFromCLBeaconRegion:

Convert a CLBeaconRegion object to a SBKBeaconID object.

+ (instancetype)beaconIDFromCLBeaconRegion:(CLBeaconRegion *)region

Parameters

region

A CLBeaconRegion object.

Return Value

A SBKBeaconID object.

Discussion

Convert a CLBeaconRegion object to a SBKBeaconID object.

Declared In

SBKBeaconID.h

beaconIDWithProximityUUID:

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

+ (instancetype)beaconIDWithProximityUUID:(NSUUID *)proximityUUID

Parameters

proximityUUID

The unique ID of the beacons being targeted. This value must not be nil.

Return Value

An initialized SBKBeaconID object.

Discussion

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

Declared In

SBKBeaconID.h

beaconIDWithProximityUUID:major:

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

+ (instancetype)beaconIDWithProximityUUID:(NSUUID *)proximityUUID major:(CLBeaconMajorValue)major

Parameters

proximityUUID

The unique 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.

Return Value

An initialized SBKBeaconID object.

Discussion

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

Declared In

SBKBeaconID.h

beaconIDWithProximityUUID:major:minor:

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

+ (instancetype)beaconIDWithProximityUUID:(NSUUID *)proximityUUID major:(CLBeaconMajorValue)major minor:(CLBeaconMinorValue)minor

Parameters

proximityUUID

The unique 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.

Return Value

An initialized SBKBeaconID object.

Discussion

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

Declared In

SBKBeaconID.h

beaconIDWithString:

Initializes and returns a SBKBeaconID object provided in a string representation.

+ (instancetype)beaconIDWithString:(NSString *)string

Parameters

string

A string that is in one of the formats returned by the stringRepresentation method.

Return Value

An initialized SBKBeaconID object.

Discussion

Initializes and returns a SBKBeaconID object provided in a string representation.

Declared In

SBKBeaconID.h

Instance Methods

CLBeaconRegion

Convert a SBKBeaconID object to a CLBeaconRegion object.

- (CLBeaconRegion *)CLBeaconRegion

Return Value

A CLBeaconRegion object.

Discussion

Convert a SBKBeaconID object to a CLBeaconRegion object.

Declared In

SBKBeaconID.h

isEqualToBeaconID:

Returns a Boolean value that indicates whether the receiver and a given beacon id are equal.

- (BOOL)isEqualToBeaconID:(SBKBeaconID *)aBeaconID

Parameters

aBeaconID

The beacon id with which to compare the receiver.

Return Value

YES if the receiver and aBeaconID are equal, otherwise NO.

Discussion

Returns a Boolean value that indicates whether the receiver and a given beacon id are equal.

Declared In

SBKBeaconID.h

stringRepresentation

Returns a string representation of the receiver.

- (NSString *)stringRepresentation

Return Value

The string representation of the receiver.

Discussion

Returns a string representation of the receiver.

Declared In

SBKBeaconID.h