com.mapquest.navigation.dataclient

Interface RouteService

All Known Subinterfaces:

RerouteService

public interface RouteService

Network client for requesting route options between locations.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RouteService.Builder

Method Summary

Modifier and Type	Method and Description
void	cancelRouteRequests()
void	getRouteSummary(Coordinate startCoordinate, Destination destination, RouteSummaryResponseListener listener) Asynchronously requests a route summary.
boolean	hasPendingRequests()
void	requestRoutes(Coordinate startCoordinate, java.util.List<Destination> destinations, RouteOptions routeOptions, RoutesResponseListener listener) Asynchronously requests up to the given number of route options between the given Destinations, avoiding or disallowing the given route features.
void	requestRoutesForCoordinates(Coordinate startLocation, java.util.List<Coordinate> destinationCoordinates, RouteOptions routeOptions, RoutesResponseListener listener) Asynchronously requests up to the given number of route options between the given coordinates, avoiding or disallowing the given route features.

Method Detail

requestRoutes

void requestRoutes(Coordinate startCoordinate,
                   java.util.List<Destination> destinations,
                   RouteOptions routeOptions,
                   RoutesResponseListener listener)

Asynchronously requests up to the given number of route options between the given Destinations, avoiding or disallowing the given route features.

Destinations hold both a coordinate and an MQID for better routing behavior.

If the first location is a Location instance, its speed and bearing will be included in the request in order to help avoid returning route options that would require the user to turn without sufficient warning or begin in the opposite direction of travel.

Parameters:

startCoordinate - The start location for the route.

destinations - List of one or more destination locations to navigate to.

listener - Listener that is notified when a response is received.

routeOptions - Route options used when requesting a route.

requestRoutesForCoordinates

void requestRoutesForCoordinates(Coordinate startLocation,
                                 java.util.List<Coordinate> destinationCoordinates,
                                 RouteOptions routeOptions,
                                 RoutesResponseListener listener)

Asynchronously requests up to the given number of route options between the given coordinates, avoiding or disallowing the given route features.

If the first location is a Location instance, its speed and bearing will be included in the request in order to help avoid returning route options that would require the user to turn without sufficient warning or begin in the opposite direction of travel.

Parameters:

startCoordinate - The start location for the route.

destinations - List of one or more coordinate locations to navigate to.

listener - Listener that is notified when a response is received.

routeOptions - Route options used when requesting a route.

getRouteSummary

void getRouteSummary(Coordinate startCoordinate,
                     Destination destination,
                     RouteSummaryResponseListener listener)

Asynchronously requests a route summary. This method is optimized to provide the ETA, distance and traffic.

Parameters:

startCoordinate - The start location for the route.

destination - A specific Destination

listener - Listener that is notified when a response is received.

hasPendingRequests

boolean hasPendingRequests()

cancelRouteRequests

void cancelRouteRequests()