com.tomtom.online.sdk.location

Interface LocationSource

All Known Implementing Classes:

AbstractLocationSource, BasicLocationSource, FusedLocationSource

public interface LocationSource

Interface that provides location data, typically to a TomtomMap object. A TomtomMap has a built-in location provider, however, it can be replaced with custom one that implements this interface.

Method Summary

Modifier and Type	Method and Description
void	activate() Activates the provider.
void	addLocationUpdateListener(LocationUpdateListener locationUpdateListener) Adds location update listener.
void	deactivate() Deactivates this provider.
java.util.List<LocationUpdateListener>	getAllLocationUpdateListeners() Obtains the list of all added location update listeners.
android.location.Location	getLastKnownLocation() Last valid location of the user.
void	onLocationChanged(android.location.Location location) Is called when new location is found by the corresponding location source provider.
void	removeAllLocationUpdateListeners() Removes all location update listeners.
void	removeLocationUpdateListener(LocationUpdateListener locationUpdateListener) Removes location update listener.

Method Detail

getLastKnownLocation

@Nullable
android.location.Location getLastKnownLocation()

Last valid location of the user. The value can be null.

activate

void activate()

Activates the provider. The provider will notify the listener periodically, until the user calls deactivate().

deactivate

void deactivate()

Deactivates this provider. The provider does not send any location notifications.

addLocationUpdateListener

void addLocationUpdateListener(LocationUpdateListener locationUpdateListener)

Adds location update listener.

Parameters:

locationUpdateListener - the listener which will be notified when new location was discovered by the location source.

removeLocationUpdateListener

void removeLocationUpdateListener(LocationUpdateListener locationUpdateListener)

Removes location update listener.

Parameters:

locationUpdateListener - the listener which will be removed from the notification list of location updates.

removeAllLocationUpdateListeners

void removeAllLocationUpdateListeners()

Removes all location update listeners.

getAllLocationUpdateListeners

java.util.List<LocationUpdateListener> getAllLocationUpdateListeners()

Obtains the list of all added location update listeners.

Returns:

the list with all added location update listeners for this location source.

onLocationChanged

void onLocationChanged(android.location.Location location)

Is called when new location is found by the corresponding location source provider.

Parameters:

location - new location found by the location provider.