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

getDeviceLocationProvider

abstract fun getDeviceLocationProvider(request: LocationProviderRequest? = null): 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.

Note that it's up to the implementation to create a new instance or reuse the existing one.

Return

Returns an instance of a device location provider or a error if it fails to instantiate it.

Parameters

request

Settings for this instance of the client. When request is not specified then reasonable default will be applied. Unknown values in request should be omitted by implementation silently.

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.

Note that it's up to the implementation to create a new instance or reuse the existing one.

Return

Returns an instance of a device location provider or a error if it fails to instantiate it.

Parameters

type

DeviceLocationProviderType to be used.

request

Settings for this instance of the client. When request is not specified then reasonable default will be applied. Unknown values in request should be omitted by implementation silently.

allowUserDefined

allow to use user-defined DeviceLocationProviderFactory if any was set by setUserDefinedDeviceLocationProviderFactory. True by default.

abstract fun getDeviceLocationProvider(extendedParameters: ExtendedLocationProviderParameters, request: LocationProviderRequest? = null): 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.

Note that it's up to the implementation to create a new instance or reuse the existing one.

Return

Returns an instance of a device location provider or a error if it fails to instantiate it.

Parameters

extendedParameters

DeviceLocationProvider parameters. See ExtendedLocationProviderParameters documentation for details.

request

Settings for this instance of the client. When request is not specified then reasonable default will be applied. Unknown values in request should be omitted by implementation silently.