Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

CoreLocation.startUpdatingHeading

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

Component Version macOS Windows Linux Server iOS SDK
CoreLocation 9.1 ✅ Yes ❌ No ❌ No ❌ No ✅ Yes
MBS( "CoreLocation.startUpdatingHeading" )

Parameters

none

Result

Returns OK or error.

Description

Starts the generation of updates that report the user’s current heading.
This method returns immediately. Calling this method when the receiver is stopped causes it to obtain an initial heading and notify your delegate. After that, the receiver generates update events when the value in the headingFilter property is exceeded.
Before calling this method, you should always check the headingAvailable property to see whether heading information is supported on the current device. If heading information is not supported, calling this method has no effect and does not result in the delivery of events to your delegate.
Calling this method several times in succession does not automatically result in new events being generated. Calling stopUpdatingHeading() in between, however, does cause a new initial event to be sent the next time you call this method.
If you start this service and your app is suspended, the system stops the delivery of events until your app starts running again (either in the foreground or background). If your app is terminated, the delivery of new heading events stops altogether and must be restarted by your code when the app is relaunched.

Added macOS support with MBS Plugin 11.1 for macOS 10.15 and newer.

See also

Release notes

Blog Entries

This function checks for a license.

Created 17th February 2019, last changed 16th February 2021


CoreLocation.startMonitoringSignificantLocationChanges - CoreLocation.startUpdatingLocation