LocationManager (Codename One API)

java.lang.Object
- com.codename1.location.LocationManager

```
public abstract class LocationManager
extends Object
```
The LocationManager is the main entry to retrieveLocation or to bind a LocationListener, important: in order to use location on iOS you will need to define the build argument ios.locationUsageDescription. This build argument should be used to describe to Apple & the users why you need to use the location functionality.

Trivial one time usage of location data can look like this sample:

You can also track location in the foreground using API calls like this:

The sample below demonstrates the usage of the background geofencing API:

Field Summary

Fields
Modifier and Type Field and Description

static int AVAILABLE

static int OUT_OF_SERVICE

static int TEMPORARILY_UNAVAILABLE

Fields
Modifier and Type	Field and Description
`static int`	`AVAILABLE`
`static int`	`OUT_OF_SERVICE`
`static int`	`TEMPORARILY_UNAVAILABLE`

Constructor Summary

Constructors
Constructor and Description

LocationManager()

Constructors
Constructor and Description
`LocationManager()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addGeoFencing(Class GeofenceListenerClass, Geofence gf)` Adds a geo fence listener to gets an event once the device is in/out of the Geofence range.
`protected void`	`bindBackgroundListener()` Bind the Background LocationListener to get events
`protected abstract void`	`bindListener()` Bind the LocationListener to get events
`protected void`	`clearBackgroundListener()` Stop deliver events for the Background LocationListener
`protected abstract void`	`clearListener()` Stop deliver events for the LocationListener
`protected Class`	`getBackgroundLocationListener()` Gets the LocationListener class that handles background location updates.
`abstract Location`	`getCurrentLocation()` Gets the current Location of the device, in most cases this uses the GPS.
`Location`	`getCurrentLocationSync()` Returns the current location synchronously, this is useful if you just want to know the location NOW and don't care about tracking location.
`Location`	`getCurrentLocationSync(long timeout)` Returns the current location synchronously, this is useful if you just want to know the location NOW and don't care about tracking location.
`abstract Location`	`getLastKnownLocation()` Gets the last known Location of the device.
`protected LocationListener`	`getListener()`
`protected LocationListener`	`getLocationListener()` Allows the implementation to notify the location listener of changes to location
`static LocationManager`	`getLocationManager()` Gets the LocationManager instance
`protected LocationRequest`	`getRequest()` Gets the LocationRequest
`int`	`getStatus()` Gets the Manager status: AVAILABLE, OUT_OF_SERVICE or TEMPORARILY_UNAVAILABLE
`boolean`	`isBackgroundLocationSupported()` Returns true if the platform is able to track background location.
`boolean`	`isGeofenceSupported()` Returns true if the platform supports Geofence
`boolean`	`isGPSDetectionSupported()` Returns true if the platform is able to detect if the GPS is on or off.
`boolean`	`isGPSEnabled()` Returns GPS on/off state if isGPSDetectionSupported() returns true
`void`	`removeGeoFencing(String id)` Stop tracking a Geofence if isGeofenceSupported() returns false this method does nothing
`void`	`setBackgroundLocationListener(Class locationListener)` Use this method to track background location updates when the application is not running anymore.
`void`	`setLocationListener(LocationListener l)` Sets a LocationListener on the device, use this method if you need to be updated on the device Locations rather then calling getCurrentLocation.
`void`	`setLocationListener(LocationListener l, LocationRequest req)` Sets a LocationListener on the device, use this method if you need to be updated on the device Locations rather then calling getCurrentLocation.
`protected void`	`setStatus(int status)` Allows the implementation to set the status of the location

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

- Field Detail
  - AVAILABLE
```
public static final int AVAILABLE
```
    See Also:
    
    Constant Field Values
  - OUT_OF_SERVICE
```
public static final int OUT_OF_SERVICE
```
    See Also:
    
    Constant Field Values
  - TEMPORARILY_UNAVAILABLE
```
public static final int TEMPORARILY_UNAVAILABLE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LocationManager
```
public LocationManager()
```
- Method Detail
  - getLocationManager
```
public static LocationManager getLocationManager()
```
    Gets the LocationManager instance
    
    Returns:
  - getStatus
```
public int getStatus()
```
    Gets the Manager status: AVAILABLE, OUT_OF_SERVICE or TEMPORARILY_UNAVAILABLE
    
    Returns:
    
    the status of the LoactionManager
  - setStatus
```
protected void setStatus(int status)
```
    Allows the implementation to set the status of the location
    
    Parameters:
    
    status - the new status
  - getCurrentLocation
```
public abstract Location getCurrentLocation()
                                     throws IOException
```
    Gets the current Location of the device, in most cases this uses the GPS. Notice! This method will only return a valid value after the location listener callback returns
    
    Returns:
    
    a Location Object
    
    Throws:
    
    IOException - if Location cannot be retrieve from the device
  - getListener
```
protected final LocationListener getListener()
```
  - getCurrentLocationSync
```
public Location getCurrentLocationSync()
```
    Returns the current location synchronously, this is useful if you just want to know the location NOW and don't care about tracking location. Notice that this method will block until a result is returned so you might want to use something like InfiniteProgress while this is running
    
    Returns:
    
    the current location or null in case of an error
  - getCurrentLocationSync
```
public Location getCurrentLocationSync(long timeout)
```
    Returns the current location synchronously, this is useful if you just want to know the location NOW and don't care about tracking location. Notice that this method will block until a result is returned so you might want to use something like InfiniteProgress while this is running
    
    Parameters:
    
    timeout - timeout in milliseconds or -1 to never timeout
    
    Returns:
    
    the current location or null in case of an error
  - getLastKnownLocation
```
public abstract Location getLastKnownLocation()
```
    Gets the last known Location of the device.
    
    Returns:
    
    a Location Object
  - setLocationListener
```
public void setLocationListener(LocationListener l)
```
    Sets a LocationListener on the device, use this method if you need to be updated on the device Locations rather then calling getCurrentLocation.
    
    Parameters:
    
    l - a LocationListener or null to stop the current listener from getting updates
  - setLocationListener
```
public void setLocationListener(LocationListener l,
                                LocationRequest req)
```
    Sets a LocationListener on the device, use this method if you need to be updated on the device Locations rather then calling getCurrentLocation.
    
    Parameters:
    
    l - a LocationListener or null to stop the current listener from getting updates
    
    req - provide the settings in which we are interested to get updates to the Listener.
  - setBackgroundLocationListener
```
public void setBackgroundLocationListener(Class locationListener)
```
    Use this method to track background location updates when the application is not running anymore. Do not perform long operations here, iOS wake-up time is very short(around 10 seconds). Notice this listener can sends events also when the app is in the foreground, therefore it is recommended to check the app state before deciding how to process this event. Use Display.isMinimized() to know if the app is currently running.
    
    Parameters:
    
    locationListener - a class that implements the LocationListener interface this class must have an empty constructor since the underlying implementation will try to create an instance and invoke the locationUpdated method
  - addGeoFencing
```
public void addGeoFencing(Class GeofenceListenerClass,
                          Geofence gf)
```
    Adds a geo fence listener to gets an event once the device is in/out of the Geofence range. The GeoFence events can arrive in the background therefore it is recommended to check the app state before deciding how to process this event. Use Display.isMinimized() to know if the app is currently running. if isGeofenceSupported() returns false this method does nothing
    NOTE: For iOS you must include the ios.background_modes build hint with a value that includes "location" for geofencing to work.
    
    Parameters:
    
    GeofenceListenerClass - a Class that implements the GeofenceListener interface this class must have an empty constructor
    
    gf - a Geofence to track
  - removeGeoFencing
```
public void removeGeoFencing(String id)
```
    Stop tracking a Geofence if isGeofenceSupported() returns false this method does nothing
    NOTE: For iOS you must include the ios.background_modes build hint with a value that includes "location" for geofencing to work.
    
    Parameters:
    
    id - a Geofence id to stop tracking
  - getLocationListener
```
protected LocationListener getLocationListener()
```
    Allows the implementation to notify the location listener of changes to location
    
    Returns:
    
    location listener instance
  - getRequest
```
protected LocationRequest getRequest()
```
    Gets the LocationRequest
  - getBackgroundLocationListener
```
protected Class getBackgroundLocationListener()
```
    Gets the LocationListener class that handles background location updates.
    NOTE: For iOS you must include the ios.background_modes build hint with a value that includes "location" for background locations to work.
  - bindListener
```
protected abstract void bindListener()
```
    Bind the LocationListener to get events
  - clearListener
```
protected abstract void clearListener()
```
    Stop deliver events for the LocationListener
  - bindBackgroundListener
```
protected void bindBackgroundListener()
```
    Bind the Background LocationListener to get events
  - clearBackgroundListener
```
protected void clearBackgroundListener()
```
    Stop deliver events for the Background LocationListener
  - isGPSDetectionSupported
```
public boolean isGPSDetectionSupported()
```
    Returns true if the platform is able to detect if the GPS is on or off. see also isGPSEnabled()
    
    Returns:
    
    true if platform is able to detect GPS on/off
  - isBackgroundLocationSupported
```
public boolean isBackgroundLocationSupported()
```
    Returns true if the platform is able to track background location.
    NOTE: For iOS you must include the ios.background_modes build hint with a value that includes "location" for background locations to work.
    
    Returns:
    
    true if platform supports background location
  - isGeofenceSupported
```
public boolean isGeofenceSupported()
```
    Returns true if the platform supports Geofence
    NOTE: For iOS you must include the ios.background_modes build hint with a value that includes "location" for geofencing to work.
    
    Returns:
    
    true if platform supports Geofence
  - isGPSEnabled
```
public boolean isGPSEnabled()
```
    Returns GPS on/off state if isGPSDetectionSupported() returns true
    
    Returns:
    
    true if GPS is on

Class LocationManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

AVAILABLE

OUT_OF_SERVICE

TEMPORARILY_UNAVAILABLE

Constructor Detail

LocationManager

Method Detail

getLocationManager

getStatus

setStatus

getCurrentLocation

getListener

getCurrentLocationSync

getCurrentLocationSync

getLastKnownLocation

setLocationListener

setLocationListener

setBackgroundLocationListener

addGeoFencing

removeGeoFencing

getLocationListener

getRequest

getBackgroundLocationListener

bindListener

clearListener

bindBackgroundListener

clearBackgroundListener

isGPSDetectionSupported

isBackgroundLocationSupported

isGeofenceSupported

isGPSEnabled