CLLocationManager (cmioslayer 3.4.0 API)

java.lang.Object
- crossmobile.ios.foundation.NSObject
- - crossmobile.ios.corelocation.CLLocationManager

```
public class CLLocationManager
extends NSObject
```
CLLocationManager class is responsible for delivering events related to location, region and heading to the application.

Constructor Summary

Constructors
Constructor and Description

CLLocationManager()

Constructors
Constructor and Description
`CLLocationManager()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`CLLocationManagerDelegate`	`delegate()` Returns the delegate for handling location data.
`double`	`desiredAccuracy()` Returns the accuracy of the location.
`void`	`dismissHeadingCalibrationDisplay()` Stops displaying heading calibration view.
`double`	`distanceFilter()` Returns the minimum horizontal distance that the device must move before it causes a location update.
`CLHeading`	`heading()` Returns the current heading of the device (recently recorded).
`static boolean`	`headingAvailable()` Returns a Boolean that shows whether heading events are available.
`double`	`headingFilter()` Returns the minimum heading change that causes heading update.
`int`	`headingOrientation()` Returns the orientation used for heading computations.
`CLLocation`	`location()` Returns the current location of the device (recently recorded).
`static boolean`	`locationServicesEnabled()` Returns a Boolean that shows whether location services are enabled.
`double`	`maximumRegionMonitoringDistance()` Returns the maximum distance concerning the bounds of a region.
`Set<CLRegion>`	`monitoredRegions()` Returns the set of shared CLRegions being monitored by the location manager objects of this application.
`String`	`purpose()` Deprecated.
`static boolean`	`regionMonitoringAvailable()` Deprecated.
`static boolean`	`regionMonitoringEnabled()` Returns a Boolean that shows whether region monitoring is currently activated.
`void`	`setDelegate(CLLocationManagerDelegate delegate)` Sets the delegate for handling location data.
`void`	`setDesiredAccuracy(double desiredAccuracy)` Sets the accuracy of the location.
`void`	`setDistanceFilter(double distanceFilter)` Sets the minimum horizontal distance that the device must move before it causes a location update.
`void`	`setHeadingFilter(double headingFilter)` Sets the minimum heading change that causes heading update.
`void`	`setHeadingOrientation(int headingOrientation)` Sets the orientation used for heading computations.
`void`	`setPurpose(String purpose)` Sets a string value that defines the purpose of location service use for the particular application.
`static boolean`	`significantLocationChangeMonitoringAvailable()` Returns a Boolean that shows whether tracking of significant location changes is available.
`void`	`startMonitoringForRegion(CLRegion region, double accuracy)` Deprecated.
`void`	`startMonitoringSignificantLocationChanges()` Allows generating location events triggered by significant location changes.
`void`	`startUpdatingHeading()` Enables heading updates.
`void`	`startUpdatingLocation()` Allows location updates.
`void`	`stopMonitoringForRegion(CLRegion region)` Stops monitoring the specified region.
`void`	`stopMonitoringSignificantLocationChanges()` Prevents generating location events triggered by significant location changes.
`void`	`stopUpdatingHeading()` Disables heading updates.
`void`	`stopUpdatingLocation()` Prevents location updates.

Methods inherited from class crossmobile.ios.foundation.NSObject
addObserver, observeValueForKeyPath, performSelector, performSelectorOnMainThread, release, removeObserver, removeObserver, retain, setValueForKey, setValueForUndefinedKey, valueForKey, valueForUndefinedKey

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CLLocationManager
```
public CLLocationManager()
```
- Method Detail
  - locationServicesEnabled
```
public static boolean locationServicesEnabled()
```
    Returns a Boolean that shows whether location services are enabled.
    
    Returns:
    
    TRUE then location services are available.
  - significantLocationChangeMonitoringAvailable
```
public static boolean significantLocationChangeMonitoringAvailable()
```
    Returns a Boolean that shows whether tracking of significant location changes is available.
    
    Returns:
    
    TRUE then significant location changes tracking is available.
  - startUpdatingLocation
```
public void startUpdatingLocation()
```
    Allows location updates.
  - stopUpdatingLocation
```
public void stopUpdatingLocation()
```
    Prevents location updates.
  - startMonitoringSignificantLocationChanges
```
public void startMonitoringSignificantLocationChanges()
```
    Allows generating location events triggered by significant location changes.
  - stopMonitoringSignificantLocationChanges
```
public void stopMonitoringSignificantLocationChanges()
```
    Prevents generating location events triggered by significant location changes.
  - headingAvailable
```
public static boolean headingAvailable()
```
    Returns a Boolean that shows whether heading events are available.
    
    Returns:
    
    TRUE then heading events are available.
  - regionMonitoringAvailable
```
@Deprecated
public static boolean regionMonitoringAvailable()
```
    Deprecated.
    
    Returns a Boolean that shows whether region monitoring is available on this device.
    
    Returns:
    
    TRUE then the region monitoring is available on this device.
  - regionMonitoringEnabled
```
public static boolean regionMonitoringEnabled()
```
    Returns a Boolean that shows whether region monitoring is currently activated.
    
    Returns:
    
    TRUE then the region monitoring is currently activated.
  - startUpdatingHeading
```
public void startUpdatingHeading()
```
    Enables heading updates.
  - stopUpdatingHeading
```
public void stopUpdatingHeading()
```
    Disables heading updates.
  - dismissHeadingCalibrationDisplay
```
public void dismissHeadingCalibrationDisplay()
```
    Stops displaying heading calibration view.
  - startMonitoringForRegion
```
@Deprecated
public void startMonitoringForRegion(CLRegion region,
                                                 double accuracy)
```
    Deprecated.
    
    Starts monitoring the specified region.
    
    Parameters:
    
    region - The region that is about to be monitored.
    
    accuracy - The accuracy of monitoring.
  - stopMonitoringForRegion
```
public void stopMonitoringForRegion(CLRegion region)
```
    Stops monitoring the specified region.
    
    Parameters:
    
    region - The region that is currently being monitored.
  - delegate
```
public CLLocationManagerDelegate delegate()
```
    Returns the delegate for handling location data.
    
    Returns:
    
    The delegate for handling location data
  - setDelegate
```
public void setDelegate(CLLocationManagerDelegate delegate)
```
    Sets the delegate for handling location data.
    
    Parameters:
    
    delegate - The delegate for handling location data
  - desiredAccuracy
```
public double desiredAccuracy()
```
    Returns the accuracy of the location.
    
    Returns:
    
    The accuracy of the location.
  - setDesiredAccuracy
```
public void setDesiredAccuracy(double desiredAccuracy)
```
    Sets the accuracy of the location.
    
    Parameters:
    
    desiredAccuracy - The accuracy of the location.
  - distanceFilter
```
public double distanceFilter()
```
    Returns the minimum horizontal distance that the device must move before it causes a location update.
    
    Returns:
    
    The minimum horizontal distance that the device must move before it causes a location update.
  - setDistanceFilter
```
public void setDistanceFilter(double distanceFilter)
```
    Sets the minimum horizontal distance that the device must move before it causes a location update.
    
    Parameters:
    
    distanceFilter - The minimum horizontal distance that the device must move before it causes a location update.
  - headingFilter
```
public double headingFilter()
```
    Returns the minimum heading change that causes heading update.
    
    Returns:
    
    The minimum heading change that causes heading update.
  - setHeadingFilter
```
public void setHeadingFilter(double headingFilter)
```
    Sets the minimum heading change that causes heading update.
    
    Parameters:
    
    headingFilter - The minimum heading change that causes heading update.
  - headingOrientation
```
public int headingOrientation()
```
    Returns the orientation used for heading computations.
    
    Returns:
    
    The orientation used for heading computations.
  - setHeadingOrientation
```
public void setHeadingOrientation(int headingOrientation)
```
    Sets the orientation used for heading computations.
    
    Parameters:
    
    headingOrientation - The orientation used for heading computations.
  - monitoredRegions
```
public Set<CLRegion> monitoredRegions()
```
    Returns the set of shared CLRegions being monitored by the location manager objects of this application.
    
    Returns:
    
    The set of shared CLRegions being monitored by the location manager objects of this application.
  - maximumRegionMonitoringDistance
```
public double maximumRegionMonitoringDistance()
```
    Returns the maximum distance concerning the bounds of a region.
    
    Returns:
    
    The maximum distance concerning the bounds of a region.
  - heading
```
public CLHeading heading()
```
    Returns the current heading of the device (recently recorded).
    
    Returns:
    
    The current heading of the device (recently recorded).
  - location
```
public CLLocation location()
```
    Returns the current location of the device (recently recorded).
    
    Returns:
    
    The current location of the device (recently recorded).
  - purpose
```
@Deprecated
public String purpose()
```
    Deprecated.
    
    Returns a string value that determines the purpose of location service use for the particular application.
    
    Returns:
    
    The purpose of location service for the application.
  - setPurpose
```
public void setPurpose(String purpose)
```
    Sets a string value that defines the purpose of location service use for the particular application.
    
    Parameters:
    
    purpose - The purpose of location service for the application.

Class CLLocationManager

Constructor Summary

Method Summary

Methods inherited from class crossmobile.ios.foundation.NSObject

Methods inherited from class java.lang.Object

Constructor Detail

CLLocationManager

Method Detail

locationServicesEnabled

significantLocationChangeMonitoringAvailable

startUpdatingLocation

stopUpdatingLocation

startMonitoringSignificantLocationChanges

stopMonitoringSignificantLocationChanges

headingAvailable

regionMonitoringAvailable

regionMonitoringEnabled

startUpdatingHeading

stopUpdatingHeading

dismissHeadingCalibrationDisplay

startMonitoringForRegion

stopMonitoringForRegion

delegate

setDelegate

desiredAccuracy

setDesiredAccuracy

distanceFilter

setDistanceFilter

headingFilter

setHeadingFilter

headingOrientation

setHeadingOrientation

monitoredRegions

maximumRegionMonitoringDistance

heading

location

purpose

setPurpose