location/org.maplibre.compose.location/AndroidLocationProvider

AndroidLocationProvider

class AndroidLocationProvider : LocationProvider(source)

Foreground location from Android's location service.

Uses fused location on Android 12 and later, and an available provider matching the requested accuracy on earlier versions. LocationAccuracy.Lowest receives passive updates.

Disabled location services report LocationUnavailableReason.ServicesDisabled. Missing permission reports LocationUnavailableReason.PermissionDenied. Invalid provider registration reports LocationUnavailableReason.UnexpectedFailure.

See AndroidLocationPermissionRequester for permission request requirements.

Create the provider, request permission, and close it on the main thread.

Parameters

context

Context used to access location services.

requester

Handles permission and requestPermission.

Constructors

AndroidLocationProvider

@MainThread

constructor(context: Context)

Creates a provider with its own AndroidLocationPermissionRequester.

Properties

backendAvailability

open val backendAvailability: LocationBackendAvailability

Whether this provider has a usable platform implementation, stable for its lifetime.

backendId

open override val backendId: String

A stable implementation name for diagnostics, when the provider declares one.

permission

open override val permission: StateFlow<LocationPermission>

Current foreground location permission.

Functions

@MainThread

open override fun close()

Releases resources owned by this provider. Repeated calls have no effect.

requestPermission

@MainThread

open override fun requestPermission()

Starts a foreground permission request and returns immediately.

updates

@RequiresPermission(anyOf = ["android.permission.ACCESS_FINE_LOCATION", "android.permission.ACCESS_COARSE_LOCATION"])

open override fun updates(request: LocationRequest = LocationRequest()): Flow<LocationEvent>

Returns a cold stream of foreground location updates.