View on GitHub
Position Class Reference
Position
open class Position🛰 Position, Swift and efficient location positioning.
-
Location authorization status
See moreDeclaration
Swift
public enum LocationAuthorizationStatus : Int, CustomStringConvertible -
Location accuracy authorization status
See moreDeclaration
Swift
public enum LocationAccuracyAuthorizationStatus : Int -
Possible error types
See moreDeclaration
Swift
public enum ErrorType : Error, CustomStringConvertible -
Completion handler for one-shot location requests
Declaration
Swift
public typealias OneShotCompletionHandler = (Swift.Result<CLLocation, Error>) -> Void -
Time based filter constant
Declaration
Swift
public static let TimeFilterNone: TimeInterval -
Time based filter constant
Declaration
Swift
public static let TimeFilter5Minutes: TimeInterval -
Time based filter constant
Declaration
Swift
public static let TimeFilter10Minutes: TimeInterval -
A statute mile to be 8 furlongs or 1609.344 meters
Declaration
Swift
public static let MilesToMetersRatio: Double
-
Shared singleton
Declaration
Swift
public static let shared: Position
-
Distance in meters a device must move before updating location.
Declaration
Swift
public var distanceFilter: Double { get set } -
Time that must pass for a device before updating location.
Declaration
Swift
public var timeFilter: TimeInterval { get set } -
When
true, location will reduce power usage from adjusted accuracy when backgrounded.Declaration
Swift
public var adjustLocationUseWhenBackgrounded: Bool { get set } -
When
true, location will reduce power usage from adjusted accuracy based on the current battery level.Declaration
Swift
public var adjustLocationUseFromBatteryLevel: Bool { get set } -
Location tracking desired accuracy when the app is active.
Declaration
Swift
public var trackingDesiredAccuracyWhenActive: Double { get set } -
Location tracking desired accuracy when the app is in the background.
Declaration
Swift
public var trackingDesiredAccuracyWhenInBackground: Double { get set } -
truewhen location services are updatingDeclaration
Swift
public var isUpdatingLocation: Bool { get } -
Last determined location
Declaration
Swift
public var location: CLLocation? { get } -
Last determined heading
Declaration
Swift
public var heading: CLHeading? { get }
-
Undocumented
Declaration
Swift
public init()
-
Adds an authorization observer.
Declaration
Swift
public func addAuthorizationObserver(_ observer: PositionAuthorizationObserver)Parameters
observerObserving instance.
-
Removes an authorization observer.
Declaration
Swift
public func removeAuthorizationObserver(_ observer: PositionAuthorizationObserver)Parameters
observerObserving instance.
-
Adds a position location observer.
Declaration
Swift
public func addObserver(_ observer: PositionObserver)Parameters
observerObserving instance.
-
Removes a position location observer.
Declaration
Swift
public func removeObserver(_ observer: PositionObserver)Parameters
observerObserving instance.
-
Adds a position heading observer.
Declaration
Swift
public func addHeadingObserver(_ observer: PositionHeadingObserver)Parameters
observerObserving instance.
-
Removes a position heading observer.
Declaration
Swift
public func removeHeadingObserver(_ observer: PositionHeadingObserver)Parameters
observerObserving instance.
-
Authorization status for location services.
Declaration
Swift
public var locationServicesStatus: LocationAuthorizationStatus { get } -
Request location authorization for in use always.
Declaration
Swift
public func requestAlwaysLocationAuthorization() -
Request location authorization for in app use only.
Declaration
Swift
public func requestWhenInUseLocationAuthorization() -
Undocumented
Declaration
Swift
public var locationAccuracyAuthorizationStatus: LocationAccuracyAuthorizationStatus { get } -
Request one time accuracy authorization. Be sure to include “FullAccuracyPurpose” to your Info.plist.
Declaration
Swift
@available(iOS 14, *) public func requestOneTimeFullAccuracyAuthorization(_ completionHandler: ((Bool) -> Void)? = nil)
-
Triggers a single location request at a specific desired accuracy regardless of any other location tracking configuration or requests.
Declaration
Swift
public func performOneShotLocationUpdate(withDesiredAccuracy desiredAccuracy: Double, completionHandler: Position.OneShotCompletionHandler? = nil)Parameters
desiredAccuracyMinimum accuracy to meet before for request.
completionHandlerCompletion handler for when the location is determined.
-
Start positioning updates.
Declaration
Swift
public func startUpdating() -
Stop positioning updates.
Declaration
Swift
public func stopUpdating()
-
Start heading updates.
Declaration
Swift
public func startUpdatingHeading() -
Stop heading updates.
Declaration
Swift
public func stopUpdatingHeading()