A base class representing an area that can be monitored.


class CLRegion : NSObject


This is an abstract base class. Instantiate one of the provided subclasses that define specific types of regions. After you create a region, register it with a CLLocationManager object with the startMonitoring(for:) method. The location manager generates appropriate events whenever the user crosses the boundaries of the region.


Accessing a Region’s Attributes

var identifier: String

The identifier for the region object.

Configuring Notification Delivery

var notifyOnEntry: Bool

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

var notifyOnExit: Bool

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


enum CLRegionState

Constants that reflect the relationship of the current location to the region boundaries.


init(circularRegionWithCenter: CLLocationCoordinate2D, radius: CLLocationDistance, identifier: String)

Initializes and returns a region object defining a circular area.

func contains(CLLocationCoordinate2D) -> Bool

Returns a Boolean value indicating whether the region contains the specified coordinate.

var center: CLLocationCoordinate2D

The center point of the region.

var radius: CLLocationDistance

The radius (measured in meters) that defines the region’s outer boundary.



Inherits From

See Also

Region Monitoring

Monitoring the User's Proximity to Geographic Regions

Use region monitoring to determine when the user enters or leaves a geographic region.

class CLCircularRegion

A circular geographic region, specified as a center point and radius.

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