IMagneticHeadingProvider | iOS SDK | 2GIS Documentation
iOS SDK
Maps
Search
Navigation
On-Premise
Urbi Pro
CityLens
Account

IMagneticHeadingProvider

Protocol that provides the direction of the device relative to the direction to magnetic north. All methods of this interface must be called from the IPositioningServicesFactory.positiningQueueue queue.

Methods
func setCallbacks(
	headingCallback: HeadingCallback?,
	availabilityCallback: AvailabilityCallback?
)

Sets the callback functions to update the current direction and change the availability of the direction source. Calling this method again overwrites previous callback functions. If both parameters are nil, direction update tracking must be disabled.

Parameters
headingCallback
HeadingCallback?

Callback function to update the current direction. See the CLLocationManagerDelegate.locationManager(didUpdateHeading:) method.

availabilityCallback
AvailabilityCallback?

Changes the availability of the direction source. Even if direction change tracking is not available, the implementation can send a new direction, but it will be considered invalid. See the CLLocationManagerDelegate.locationManager(didFailWithError) method.