CLLocationManager Class Reference

Delegates and Authorization

delegate
The delegate object to receive update events. Apple Documentation
Declaration
Swift

open weak var delegate: (any CLLocationManagerDelegate)?
authorizationStatus
The current authorization status for the app. Apple Documentation
Declaration
Swift

open var authorizationStatus: CLAuthorizationStatus
accuracyAuthorization
The level of location accuracy the app has permission to use. Apple Documentation
Declaration
Swift

open private(set) var accuracyAuthorization: CLAccuracyAuthorization { get }
isAuthorizedForWidgetUpdates
Indicates whether a widget is eligible to receive location updates. Apple Documentation
Declaration
Swift

open private(set) var isAuthorizedForWidgetUpdates: Bool { get }

Configuration Properties

activityType
The type of activity the app expects the user to perform during location updates. Apple Documentation
Declaration
Swift

open var activityType: CLActivityType
distanceFilter
The minimum distance (measured in meters) a device must move before an update event is generated.

Note
Set to kCLDistanceFilterNone to disable distance filtering and receive all location updates. Values less than or equal to 0 disable the filter. Default is 10.0 meters. Apple Documentation
Declaration
Swift

open var distanceFilter: CLLocationDistance { get set }
desiredAccuracy
The accuracy of the location data that your app wants to receive. Apple Documentation
Declaration
Swift

open var desiredAccuracy: CLLocationAccuracy
pausesLocationUpdatesAutomatically
A Boolean value that indicates whether the location manager may pause location updates. Apple Documentation
Declaration
Swift

open var pausesLocationUpdatesAutomatically: Bool { get set }
allowsBackgroundLocationUpdates
A Boolean value that indicates whether the app receives location updates when running in the background. Apple Documentation
Declaration
Swift

open var allowsBackgroundLocationUpdates: Bool { get set }

Location and Heading Properties

location
The most recently retrieved user location. Apple Documentation
Declaration
Swift

open private(set) var location: CLLocation? { get }
headingFilter
The minimum angular change (measured in degrees) required to generate new heading events. Apple Documentation
Declaration
Swift

open var headingFilter: CLLocationDegrees
headingOrientation
The device orientation to use when computing heading values. Apple Documentation
Declaration
Swift

open var headingOrientation: CLDeviceOrientation
heading
The most recently reported heading. Apple Documentation
Declaration
Swift

open private(set) var heading: CLHeading? { get }

Monitoring and Ranging

maximumRegionMonitoringDistance
The largest boundary distance that can be assigned to a region. Apple Documentation
Declaration
Swift

open var maximumRegionMonitoringDistance: CLLocationDistance
monitoredRegions
The set of shared regions monitored by all location-manager objects. Apple Documentation
Declaration
Swift

open private(set) var monitoredRegions: Set<CLRegion> { get }
rangedBeaconConstraints
The set of beacon constraints currently being tracked using ranging. Apple Documentation
Declaration
Swift

open private(set) var rangedBeaconConstraints: Set<CLBeaconIdentityConstraint> { get }

Service Integration

init()
Undocumented
Declaration
Swift

public override init()

Authorization Methods

requestWhenInUseAuthorization()
Undocumented
Declaration
Swift

open func requestWhenInUseAuthorization()
requestAlwaysAuthorization()
Undocumented
Declaration
Swift

open func requestAlwaysAuthorization()


                    
                    
                    requestTemporaryFullAccuracyAuthorization(withPurposeKey:completion:)

Undocumented

Declaration

Swift

open func requestTemporaryFullAccuracyAuthorization(withPurposeKey purposeKey: String, completion: ((Error?) -> Void)? = nil)

Location Management

startUpdatingLocation()
Starts the generation of updates that report the user’s current location. Apple Documentation
- Calls requestLocation(with:) at provider-defined intervals (poolInterval).
Declaration
Swift

open func startUpdatingLocation()
stopUpdatingLocation()
Stops all location updates Apple Documentation
Declaration
Swift

open func stopUpdatingLocation()
requestLocation()
Requests the one-time delivery of the user’s current location. Apple Documentation
Declaration
Swift

open func requestLocation()

Heading Management

startUpdatingHeading()
Starts the generation of updates that report the user’s current heading.

Note
Heading updates require magnetometer hardware which is not available on Linux. This method is a no-op on Linux platforms and will not generate heading updates. Use headingAvailable() to check if heading services are available. Apple Documentation
Declaration
Swift

open func startUpdatingHeading()
stopUpdatingHeading()
Stops the generation of heading updates.

Note
This method is a no-op on Linux platforms since heading updates are not supported. Apple Documentation
Declaration
Swift

open func stopUpdatingHeading()

Region Monitoring


                    
                    
                    startMonitoring(for:)

Starts monitoring the specified region for entry and exit events.

Note

The region’s notifyOnEntry and notifyOnExit properties determine which events are reported. Apple Documentation

Declaration

Swift

open func startMonitoring(for region: CLRegion)

Parameters


                                region

The region to monitor. Only CLCircularRegion is supported.


                    
                    
                    stopMonitoring(for:)

Stops monitoring the specified region.

Declaration

Swift

open func stopMonitoring(for region: CLRegion)

Parameters


                                region

The region to stop monitoring. Apple Documentation


                    
                    
                    requestState(for:)

Requests the current state of the specified region.

Note

This method triggers the locationManager(_:didDetermineState:for:) delegate method. Apple Documentation

Declaration

Swift

open func requestState(for region: CLRegion)

Parameters


                                region

The region whose state you want to determine.

Service Availability

locationServicesEnabled()
Returns a Boolean value indicating whether location services are enabled on the device.
Declaration
Swift

open class func locationServicesEnabled() -> Bool
headingAvailable()
Returns a Boolean value indicating whether the location manager is able to generate heading-related events.
Declaration
Swift

open class func headingAvailable() -> Bool
Return Value

Always returns false on Linux platforms as magnetometer hardware is not available. Apple Documentation
significantLocationChangeMonitoringAvailable()
Returns a Boolean value indicating whether the significant-change location service is available on the device.
Declaration
Swift

open class func significantLocationChangeMonitoringAvailable() -> Bool
Return Value

Always returns false on Linux platforms as this service requires OS-level support not available on Linux. Apple Documentation


                    
                    
                    isMonitoringAvailable(for:)

Returns a Boolean value indicating whether the device supports region monitoring using the specified class.

Declaration

Swift

open class func isMonitoringAvailable(for regionClass: AnyClass) -> Bool

Parameters


                                regionClass

The class of region to check support for.

Return Value

Returns true for CLCircularRegion, false for other region types as only circular regions are supported in OpenCoreLocation. Apple Documentation

isRangingAvailable()
Returns a Boolean value indicating whether the device supports ranging of beacons that use the iBeacon protocol.
Declaration
Swift

open class func isRangingAvailable() -> Bool
Return Value

Always returns false on Linux platforms as beacon ranging requires Bluetooth LE hardware integration. Apple Documentation