Class

CLBeacon

Information about an observed iBeacon and its relative distance to the user’s device.

Declaration

class CLBeacon : NSObject

Overview

The CLBeacon class represents a beacon that was observed during beacon ranging. You do not create instances of this class directly. The location manager (CLLocationManager) object reports observed beacons to its associated delegate object.

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

Topics

Identifying a Beacon

var uuid: UUID

The UUID that the observed beacon transmitted.

Beta
var major: NSNumber

The major value that the observed beacon transmitted.

var minor: NSNumber

The minor value that the observed beacon transmitted.

var proximityUUID: UUID

The proximity ID of the beacon.

Deprecated

Determining Distance to the Beacon

var proximity: CLProximity

The relative distance to the beacon.

enum CLProximity

Constants that reflect the relative distance to a beacon.

var accuracy: CLLocationAccuracy

The accuracy of the proximity value, measured in meters from the beacon.

var rssi: Int

The received signal strength of the beacon, measured in decibels.

var timestamp: Date

A timestamp representing when the beacon was observed.

Beta

Relationships

Inherits From

See Also

iBeacon

Ranging for Beacons

Detect that the device is in a beacon region, then use ranging to find the beacons within the region.

Determining the Proximity to an iBeacon Device

Learn how to detect beacons and determine the relative distance to them.

Turning an iOS Device into an iBeacon Device

Learn how to broadcast iBeacon signals from an iOS device.

class CLBeaconRegion

A region used to detect the presence of iBeacon devices.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software