com.nbmap.api.directionsrefresh.v1

Interface DirectionsRefreshService

public interface DirectionsRefreshService

Interface that defines the directions refresh service. This corresponds to v1 of the directions API, specifically driving directions.

Since:

4.4.0

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<com.nbmap.api.directionsrefresh.v1.models.DirectionsRefreshResponse>	getCall(java.lang.String userAgent, java.lang.String requestId, int routeIndex, int legIndex, java.lang.String accessToken) Constructs the html call using the information passed in through the NbmapDirectionsRefresh.Builder.

Method Detail

getCall

@GET(value="directions-refresh/v1/nbmap/driving-traffic/{request_id}/{route_index}/{leg_index}")
retrofit2.Call<com.nbmap.api.directionsrefresh.v1.models.DirectionsRefreshResponse> getCall(@Header(value="User-Agent")
                                                                                                                                                                                             java.lang.String userAgent,
                                                                                                                                                                                             @Path(value="request_id")
                                                                                                                                                                                             java.lang.String requestId,
                                                                                                                                                                                             @Path(value="route_index")
                                                                                                                                                                                             int routeIndex,
                                                                                                                                                                                             @Path(value="leg_index")
                                                                                                                                                                                             int legIndex,
                                                                                                                                                                                             @Query(value="key")
                                                                                                                                                                                             java.lang.String accessToken)

Constructs the html call using the information passed in through the NbmapDirectionsRefresh.Builder.

Parameters:

userAgent - the user agent

requestId - a uuid specifying the request containing the route being refreshed

routeIndex - the index of the specified route

legIndex - the index of the leg to start the refresh response (inclusive)

accessToken - Nbmap access token

Returns:

the DirectionsRefreshResponse in a Call wrapper

Since:

4.4.0