compass-geolocation/dev.jordond.compass.geolocation/Locator

Locator

interface Locator

Wrapper for platform specific geolocation services.

Inheritors

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
abstract val locationUpdates: Flow<Location>

A Flow of Location updates.

Functions

Link copied to clipboard
abstract suspend fun current(priority: Priority = Priority.Balanced): Location

Get the current location.

Link copied to clipboard
abstract fun isAvailable(): Boolean

Check if the platform supports geolocation.

Link copied to clipboard
abstract fun stopTracking()

Stop tracking the location.

Link copied to clipboard
abstract suspend fun track(request: LocationRequest = LocationRequest()): Flow<Location>

Start tracking the location.