compass-geolocation/dev.jordond.compass.geolocation

Package-level declarations

Types

Provides geolocation operations:

sealed interface GeolocatorResult

Represents the result of a geolocation operation.

class LocationRequest(val priority: Priority = Priority.Balanced, val interval: Long = 5000, val maximumAge: Long = 0)

Represents a request for location updates.

interface Locator

Wrapper for platform specific geolocation services.

A no-op Locator that is used when the platform does not support geolocation.

Defines a Locator that requires a permission to check location.

sealed interface TrackingStatus

Represents the current status of a Geolocator tracking operation.

Gets the current location or null if the location is not available.

fun Geolocator(locator: Locator, dispatcher: CoroutineDispatcher = Dispatchers.Default): Geolocator

Create a new Geolocator using the provided locator and dispatcher.

Check if the current Geolocator has the permissions required for geolocation.