Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)
Android APIs
Added in API level 1
public interface

LocationListener

android.location.LocationListener

Class Overview

Used for receiving notifications from the LocationManager when the location has changed. These methods are called if the LocationListener has been registered with the location manager service using the requestLocationUpdates(String, long, float, LocationListener) method.

Developer Guides

For more information about identifying user location, read the Obtaining User Location developer guide.

Summary

Public Methods
abstract void onLocationChanged ( Location location)
Called when the location has changed.
abstract void onProviderDisabled ( String provider)
Called when the provider is disabled by the user.
abstract void onProviderEnabled ( String provider)
Called when the provider is enabled by the user.
abstract void onStatusChanged ( String provider, int status, Bundle extras)
Called when the provider status changes.

Public Methods

public abstract void onLocationChanged ( Location location)

Added in API level 1

Called when the location has changed.

There are no restrictions on the use of the supplied Location object.

Parameters
location The new location, as a Location object.

public abstract void onProviderDisabled ( String provider)

Added in API level 1

Called when the provider is disabled by the user. If requestLocationUpdates is called on an already disabled provider, this method is called immediately.

Parameters
provider the name of the location provider associated with this update.

public abstract void onProviderEnabled ( String provider)

Added in API level 1

Called when the provider is enabled by the user.

Parameters
provider the name of the location provider associated with this update.

public abstract void onStatusChanged ( String provider, int status, Bundle extras)

Added in API level 1

Called when the provider status changes. This method is called when a provider is unable to fetch a location or if the provider has recently become available after a period of unavailability.

Parameters
provider the name of the location provider associated with this update.
status OUT_OF_SERVICE if the provider is out of service, and this is not expected to change in the near future; TEMPORARILY_UNAVAILABLE if the provider is temporarily unavailable but is expected to be available shortly; and AVAILABLE if the provider is currently available.
extras an optional Bundle which will contain provider specific status variables.

A number of common key/value pairs for the extras Bundle are listed below. Providers that use any of the keys on this list must provide the corresponding value as described below.

  • satellites - the number of satellites used to derive the fix