CBBeacon Class Reference

Inherits from NSObject
Declared in CBBeacon.h
CBBeacon.m

Overview

A single beacon within a CBRegion.

The CBBeacon class represents a beacon that was encountered during region monitoring. You do not create instances of this class directly. The beacon manager object reports encountered beacons to its associated delegate object. You can use the information in a beacon object to identify which beacon was encountered.

The identity of a beacon is defined by its proximityUUID, major, and minor properties. These values are coded into the beacon itself. For a more thorough description of the meaning of those values, see CBRegion.

  proximityUUID

Proximity identifier associated with the beacon.

@property (readonly, nonatomic, copy, nonnull) NSUUID *proximityUUID

Declared In

CBBeacon.h

  major

Most significant value associated with the beacon.

@property (readonly, nonatomic) NSInteger major

Declared In

CBBeacon.h

  minor

Least significant value associated with the beacon.

@property (readonly, nonatomic) NSInteger minor

Declared In

CBBeacon.h

  proximity

Proximity of the beacon from the device.

@property (readonly, nonatomic) CBProximity proximity

Declared In

CBBeacon.h

  accuracy

Represents an one sigma horizontal accuracy in meters where the measuring device’s location is referenced at the beaconing device. This value is heavily subject to variations in an RF environment.

@property (readonly, nonatomic) double accuracy

Discussion

A negative accuracy value indicates the proximity is unknown.

Declared In

CBBeacon.h

  rssi

Received signal strength in decibels of the specified beacon.

@property (readonly, nonatomic) NSInteger rssi

Discussion

This value is an average of the RSSI samples collected since this beacon was last reported.

Declared In

CBBeacon.h

– dictionary

Represent all value of this object in a NSDictionary.

- (nonnull NSDictionary *)dictionary

Return Value

All values of this object in dictionary format.

Declared In

CBBeacon.h