LocationManagerCompat

@RequiresPermission(anyOf = )
java-static fun getCurrentLocation(
    locationManager: LocationManager,
    provider: String,
    cancellationSignal: CancellationSignal?,
    executor: Executor,
    consumer: Consumer<Location!>
): Unit

Asynchronously returns a single current location fix from the given provider. This may activate sensors in order to compute a new location. The given callback will be invoked once and only once, either with a valid location or with a null location if the provider was unable to generate a valid location.

A client may supply an optional CancellationSignal. If this is used to cancel the operation, no callback should be expected after the cancellation.

This method may return locations from the very recent past (on the order of several seconds), but will never return older locations (for example, several minutes old or older). Clients may rely upon the guarantee that if this method returns a location, it will represent the best estimation of the location of the device in the present moment.

Clients calling this method from the background may notice that the method fails to determine a valid location fix more often than while in the foreground. Background applications may be throttled in their location accesses to some degree.

@RequiresPermission(anyOf = )
java-static fun getCurrentLocation(
    locationManager: LocationManager,
    provider: String,
    cancellationSignal: CancellationSignal?,
    executor: Executor,
    consumer: Consumer<Location!>
): Unit

Asynchronously returns a single current location fix from the given provider. This may activate sensors in order to compute a new location. The given callback will be invoked once and only once, either with a valid location or with a null location if the provider was unable to generate a valid location.

A client may supply an optional CancellationSignal. If this is used to cancel the operation, no callback should be expected after the cancellation.

This method may return locations from the very recent past (on the order of several seconds), but will never return older locations (for example, several minutes old or older). Clients may rely upon the guarantee that if this method returns a location, it will represent the best estimation of the location of the device in the present moment.

Clients calling this method from the background may notice that the method fails to determine a valid location fix more often than while in the foreground. Background applications may be throttled in their location accesses to some degree.

java-static fun getGnssHardwareModelName(locationManager: LocationManager): String?

Returns the model name (including vendor and hardware/software version) of the GNSS hardware driver, or null if this information is not available.

No device-specific serial number or ID is returned from this API.

java-static fun getGnssYearOfHardware(locationManager: LocationManager): Int

Returns the model year of the GNSS hardware and software build, or 0 if the model year is before 2016.

java-static fun hasProvider(locationManager: LocationManager, provider: String): Boolean

Returns true if the given location provider exists on this device, irrespective of whether it is currently enabled or not. If called on Android Q and below for the FUSED_PROVIDER, this method may return incorrect results if the client does not hold at least the ACCESS_COARSE_LOCATION permission.

java-static fun isLocationEnabled(locationManager: LocationManager): Boolean

Returns the current enabled/disabled state of location.

@RequiresApi(value = VERSION_CODES.N)
@RequiresPermission(value = "android.permission.ACCESS_FINE_LOCATION")
java-static fun registerGnssMeasurementsCallback(
    locationManager: LocationManager,
    callback: GnssMeasurementsEvent.Callback,
    handler: Handler
): Boolean

Registers a GNSS measurement callback. See registerGnssMeasurementsCallback.

The primary purpose for this compatibility method is to help avoid crashes when delivering GNSS measurements to client on Android R. This bug was fixed in Android R QPR1, but since it's possible not all Android R devices have upgraded to QPR1, this compatibility method is provided to ensure GNSS measurements can be delivered successfully on all platforms.

@RequiresApi(value = VERSION_CODES.N)
@RequiresPermission(value = "android.permission.ACCESS_FINE_LOCATION")
java-static fun registerGnssMeasurementsCallback(
    locationManager: LocationManager,
    executor: Executor,
    callback: GnssMeasurementsEvent.Callback
): Boolean

Registers a GNSS measurement callback. See registerGnssMeasurementsCallback.

In addition to allowing the use of Executors on older platforms, this compatibility method also helps avoid crashes when delivering GNSS measurements to clients on Android R. This bug was fixed in Android R QPR1, but since it's possible not all Android R devices have upgraded to QPR1, this compatibility method is provided to ensure GNSS measurements can be delivered successfully on all platforms.

@RequiresPermission(value = "android.permission.ACCESS_FINE_LOCATION")
java-static fun registerGnssStatusCallback(
    locationManager: LocationManager,
    callback: GnssStatusCompat.Callback,
    handler: Handler
): Boolean

Registers a platform agnostic GnssStatusCompat.Callback. See addGpsStatusListener and registerGnssStatusCallback.

@RequiresPermission(value = "android.permission.ACCESS_FINE_LOCATION")
java-static fun registerGnssStatusCallback(
    locationManager: LocationManager,
    executor: Executor,
    callback: GnssStatusCompat.Callback
): Boolean

Registers a platform agnostic GnssStatusCompat.Callback. See addGpsStatusListener and registerGnssStatusCallback.

Internally, this API will always utilize GnssStatus APIs and instances on Android N and above, and will always utilize GpsStatus APIs and instances below Android N. Callbacks will always occur on the given executor.

If invoked on Android M or below, this will result in GpsStatus registration being run on either the current Looper or main Looper. If the thread this function is invoked on is different from that Looper, the caller must ensure that the Looper thread cannot be blocked by the thread this function is invoked on. The easiest way to avoid this is to ensure this function is invoked on a Looper thread.

@RequiresPermission(anyOf = )
java-static fun removeUpdates(
    locationManager: LocationManager,
    listener: LocationListenerCompat
): Unit

Removes all location updates for the specified LocationListener.

See removeUpdates for more information.

@RequiresPermission(anyOf = )
java-static fun requestLocationUpdates(
    locationManager: LocationManager,
    provider: String,
    locationRequest: LocationRequestCompat,
    executor: Executor,
    listener: LocationListenerCompat
): Unit

Register for location updates from the specified provider, using a LocationRequestCompat, and a callback on the specified Executor.

See requestLocationUpdates for more information.

@RequiresPermission(anyOf = )
java-static fun requestLocationUpdates(
    locationManager: LocationManager,
    provider: String,
    locationRequest: LocationRequestCompat,
    listener: LocationListenerCompat,
    looper: Looper
): Unit

Register for location updates from the specified provider, using a LocationRequestCompat, and a callback on the specified Looper.

See requestLocationUpdates for more information.

@RequiresApi(value = VERSION_CODES.N)
java-static fun unregisterGnssMeasurementsCallback(
    locationManager: LocationManager,
    callback: GnssMeasurementsEvent.Callback
): Unit

Unregisters a GNSS measurement callback. See unregisterGnssMeasurementsCallback.

java-static fun unregisterGnssStatusCallback(
    locationManager: LocationManager,
    callback: GnssStatusCompat.Callback
): Unit

Unregisters a platform agnostic GnssStatusCompat.Callback. See removeGpsStatusListener and unregisterGnssStatusCallback.