com.inrix.sdk

Class LocationsManager

java.lang.Object

com.inrix.sdk.LocationsManager

public class LocationsManager
extends Object

Manages asynchronous operations that involve locations that are saved by the user.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LocationsManager.DeleteLocationOptions Contains options to delete locations.
static class	LocationsManager.GetLearnedLocationsOptions Contains options to retrieve LearnedLocations.
static class	LocationsManager.GetLocationsOptions Contains options to get locations.
static interface	LocationsManager.IDeleteSavedLocationResponseListener Response listener for deleting locations.
static interface	LocationsManager.IGetLearnedLocationsListener Response listener for LocationsManager.getLearnedLocations(GetLearnedLocationsOptions, IGetLearnedLocationsListener).
static interface	LocationsManager.IGetSavedLocationsResponseListener Response listener for retrieving locations.
static interface	LocationsManager.ISaveLocationResponseListener Response listener for saving locations.
static interface	LocationsManager.IUpdateLearnedLocationsListener Response listener for LocationsManager.updateLearnedLocations(UpdateLearnedLocationsOptions, IUpdateLearnedLocationsListener).
static interface	LocationsManager.IUpdateSavedLocationsOrderListener Response listener for the locations order.
static class	LocationsManager.LocationsManagerException An exception that is thrown when there is an error with an LocationsManager operation.
static class	LocationsManager.SaveLocationOptions Contains options to save locations.
static class	LocationsManager.UpdateLearnedLocationsOptions Contains options to update LearnedLocations.
static class	LocationsManager.UpdateLocationsOrderOptions Contains options that specify how to update the order of locations in a list.

Method Summary

Methods

Modifier and Type	Method and Description
ICancellable	deleteLocation(LocationsManager.DeleteLocationOptions options, LocationsManager.IDeleteSavedLocationResponseListener listener) Deletes a SavedLocation.
LocationsManagerConfig	getConfiguration() Gets the LocationsManager configuration.
ICancellable	getLearnedLocations(LocationsManager.GetLearnedLocationsOptions options, LocationsManager.IGetLearnedLocationsListener listener) Gets the user's LearnedLocations.
ICancellable	getSavedLocations(LocationsManager.GetLocationsOptions reserved, LocationsManager.IGetSavedLocationsResponseListener listener) Request the locations saved by current user.
ICancellable	saveLocation(LocationsManager.SaveLocationOptions options, LocationsManager.ISaveLocationResponseListener listener) Saves a SavedLocation.
boolean	showPlaces(float zoom) Gets the value indicating whether to show saved places on the specified zoom level.
ICancellable	updateLearnedLocations(LocationsManager.UpdateLearnedLocationsOptions options, LocationsManager.IUpdateLearnedLocationsListener listener) Update the user's LearnedLocations.
ICancellable	updateOrder(LocationsManager.UpdateLocationsOrderOptions options, LocationsManager.IUpdateSavedLocationsOrderListener listener) Updates the order of SavedLocation in the list of the SavedLocation.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

showPlaces

public boolean showPlaces(float zoom)

Gets the value indicating whether to show saved places on the specified zoom level.

Parameters:

zoom - Target zoom level.

Returns:

A value indicating whether to show saved places on the specified zoom level.

getConfiguration

public LocationsManagerConfig getConfiguration()

Gets the LocationsManager configuration.

Returns:

An instance of LocationsManagerConfig.

getSavedLocations

public ICancellable getSavedLocations(LocationsManager.GetLocationsOptions reserved,
                             LocationsManager.IGetSavedLocationsResponseListener listener)

Request the locations saved by current user.

Parameters:

reserved - Request options. Must be null. Reserved for a future use.

listener - The listener that will receive the response.

Returns:

An instance of ICancellable so that the request can be cancelled.

Throws:

LocationsManager.LocationsManagerException - when listener is null

saveLocation

public ICancellable saveLocation(LocationsManager.SaveLocationOptions options,
                        LocationsManager.ISaveLocationResponseListener listener)

Saves a SavedLocation. This method should be used to both create and update SavedLocation.

Parameters:

options - The options that contain the SavedLocation information.

listener - The listener that will receive the response containing the new SavedLocation.

Returns:

An instance of ICancellable so that the request can be cancelled.

Throws:

LocationsManager.LocationsManagerException - when either options or listener is null.

deleteLocation

public ICancellable deleteLocation(LocationsManager.DeleteLocationOptions options,
                          LocationsManager.IDeleteSavedLocationResponseListener listener)

Deletes a SavedLocation.

Note: concurrent deletes (even if they are for different SavedLocation objects may fail.

Parameters:

options - The options that contain the information on the location to delete.

listener - The listener that will receive the response.

Returns:

An instance of ICancellable so that the request can be cancelled.

Throws:

LocationsManager.LocationsManagerException - when either options or listener is null.

updateOrder

public ICancellable updateOrder(LocationsManager.UpdateLocationsOrderOptions options,
                       LocationsManager.IUpdateSavedLocationsOrderListener listener)

Updates the order of SavedLocation in the list of the SavedLocation.

Parameters:

options - The options that contain the information how to order the SavedLocation.

listener - The listener that will receive the response.

Returns:

An instance of ICancellable so that the request can be cancelled.

Throws:

LocationsManager.LocationsManagerException - when either options or listener is null.

getLearnedLocations

public ICancellable getLearnedLocations(LocationsManager.GetLearnedLocationsOptions options,
                               LocationsManager.IGetLearnedLocationsListener listener)

Gets the user's LearnedLocations.

Parameters:

options - Request options.

listener - Response listener instance.

Returns:

An instance of ICancellable to cancel the request in progress.

updateLearnedLocations

public ICancellable updateLearnedLocations(LocationsManager.UpdateLearnedLocationsOptions options,
                                  LocationsManager.IUpdateLearnedLocationsListener listener)

Update the user's LearnedLocations.

Parameters:

options - Request options.

listener - Response listener instance.

Returns:

An instance of ICancellable to cancel the request in progress.