Class

CLRegion

A base class representing an area that can be monitored.

Declaration

class CLRegion : NSObject

Overview

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.

Topics

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.

Constants

enum CLRegionState

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

Deprecated

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

Initializes and returns a region object defining a circular area.

Deprecated
func contains(CLLocationCoordinate2D) -> Bool

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

Deprecated
var center: CLLocationCoordinate2D

The center point of the region.

Deprecated
var radius: CLLocationDistance

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

Deprecated

Relationships

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.