com.mapbox.services.api.directions.v5

Class MapboxDirections

java.lang.Object

com.mapbox.services.api.MapboxService<DirectionsResponse>

com.mapbox.services.api.directions.v5.MapboxDirections

public class MapboxDirections
extends MapboxService<DirectionsResponse>

The Directions API allows the calculation of routes between coordinates. The fastest route is returned with geometries, and turn-by-turn instructions. The Mapbox Directions API supports routing for driving cars, riding bicycles and walking.

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MapboxDirections.Builder<T extends MapboxDirections.Builder> Directions v5 builder

Field Summary

Fields

Modifier and Type	Field and Description
protected MapboxDirections.Builder	builder

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MapboxDirections(MapboxDirections.Builder builder)

Method Summary

Modifier and Type	Method and Description
void	cancelCall() Cancel the call
retrofit2.Call<DirectionsResponse>	cloneCall() clone the call
void	enqueueCall(retrofit2.Callback<DirectionsResponse> callback) Execute the call
retrofit2.Response<DirectionsResponse>	executeCall() Execute the call

Methods inherited from class com.mapbox.services.api.MapboxService

getCallFactory, getHeaderUserAgent, getOkHttpClient, isEnableDebug, setCallFactory, setEnableDebug

Methods inherited from class java.lang.Object

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

Field Detail

builder

protected MapboxDirections.Builder builder

Constructor Detail

MapboxDirections

protected MapboxDirections(MapboxDirections.Builder builder)

Method Detail

executeCall

public retrofit2.Response<DirectionsResponse> executeCall()
                                                   throws java.io.IOException

Execute the call

Specified by:

executeCall in class MapboxService<DirectionsResponse>

Returns:

The Directions v5 response

Throws:

java.io.IOException - Signals that an I/O exception of some sort has occurred.

Since:

1.0.0

enqueueCall

public void enqueueCall(retrofit2.Callback<DirectionsResponse> callback)

Execute the call

Specified by:

enqueueCall in class MapboxService<DirectionsResponse>

Parameters:

callback - A Retrofit callback.

Since:

1.0.0

cancelCall

public void cancelCall()

Cancel the call

Specified by:

cancelCall in class MapboxService<DirectionsResponse>

Since:

1.0.0

cloneCall

public retrofit2.Call<DirectionsResponse> cloneCall()

clone the call

Specified by:

cloneCall in class MapboxService<DirectionsResponse>

Returns:

cloned call

Since:

1.0.0