mapbox-maps-android/com.mapbox.common.location/LocationService

LocationService

interface LocationService

The entry point of the platform location services.

Functions

Link copied to clipboard
abstract fun getAccuracyAuthorization(): AccuracyAuthorization

Gets a current accuracy authorization of the app

Link copied to clipboard
abstract fun getDeviceLocationProvider(request: LocationProviderRequest? = null): Expected<LocationError, DeviceLocationProvider>
abstract fun getDeviceLocationProvider(extendedParameters: ExtendedLocationProviderParameters, request: LocationProviderRequest? = null): Expected<LocationError, DeviceLocationProvider>
abstract fun getDeviceLocationProvider(type: DeviceLocationProviderType, request: LocationProviderRequest? = null, allowUserDefined: Boolean = true): Expected<LocationError, DeviceLocationProvider>

Gets an instance of DeviceLocationProvider. In case user defined factory was set by setUserDefinedDeviceLocationProviderFactory it will be asked to provide an instance.

Link copied to clipboard
abstract fun getPermissionStatus(): PermissionStatus

Gets a current status of location permission of the app.

Link copied to clipboard
abstract fun isAvailable(): Boolean

Check if the platform location service is available

Link copied to clipboard
abstract fun registerObserver(observer: LocationServiceObserver)

Registers an observer. LocationService can have more than one observer.

abstract fun setUserDefinedDeviceLocationProviderFactory(factory: DeviceLocationProviderFactory?)

Set factory to build user defined DeviceLocationProvider. When set, this factory will intercept all getDeviceLocationProvider calls to provide an instance of a DeviceLocationProvider.

Link copied to clipboard
abstract fun unregisterObserver(observer: LocationServiceObserver)

Removes observer. If the observer is not registered, this is no-op.