Class

CLRegion

A base class representing an area that can be monitored.

Declaration

@interface 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 startMonitoringForRegion: method. The location manager generates appropriate events whenever the user crosses the boundaries of the region.

Topics

Accessing a Region’s Attributes

identifier

The identifier for the region object.

Configuring Notification Delivery

notifyOnEntry

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

notifyOnExit

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

Constants

CLRegionState

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

Deprecated

- initCircularRegionWithCenter:radius:identifier:

Initializes and returns a region object defining a circular area.

Deprecated
- containsCoordinate:

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

Deprecated
center

The center point of the region.

Deprecated
radius

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.

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