location/org.maplibre.compose.location/LocationProvider

LocationProvider

interface LocationProvider : AutoCloseable(source)

Supplies foreground location updates and permission status.

Implement this interface for custom location sources. Sources without permission handling can use the default permission and requestPermission implementations.

Inheritors

Properties

Link copied to clipboard
open val backendAvailability: LocationBackendAvailability

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

Link copied to clipboard
open val backendId: String?

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

Link copied to clipboard
open val permission: StateFlow<LocationPermission>

Current foreground location permission.

Functions

Link copied to clipboard
open override fun close()

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

Link copied to clipboard
open fun requestPermission()

Starts a foreground permission request and returns immediately.

Link copied to clipboard
abstract fun updates(request: LocationRequest = LocationRequest()): Flow<LocationEvent>

Returns a cold stream of foreground location updates.

Generated by Dokka
© 2026 Copyright