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

CoreLocation.setPurpose

Sets the application-provided string that describes the reason for using location services.

Component Version macOS Windows Linux Server iOS SDK
CoreLocation 2.7 ✅ Yes ❌ No ❌ No ❌ No ✅ Yes
MBS( "CoreLocation.setPurpose"; text )   More

Parameters

Parameter Description Example
text Your purpose message. "For tracking your location."

Result

Returns "OK" or error.

Description

Sets the application-provided string that describes the reason for using location services.
If the value of this property is non-nil, the system includes the string in the dialog that asks the user whether it is all right for your application to use location services. The string gives you a chance to explain the reason for why your application is using location services.
You must set the value of this property prior to calling the CoreLocation.startUpdatingLocation method. Because the string is ultimately displayed to the user, you should always load it from a localized strings file.
Available in macOS 10.7 and later.

See also

This function checks for a license.

Created 18th August 2014, last changed 10th August 2020


CoreLocation.setDistanceFilter - CoreLocation.significantLocationChangeMonitoringAvailable