com.mapbox.api.directionsrefresh.v1.DirectionsRefreshService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mapbox-sdk-services Show documentation

Mapbox Java SDK

There is a newer version: 5.9.0-alpha.1

package com.mapbox.api.directionsrefresh.v1;

import com.mapbox.api.directionsrefresh.v1.models.DirectionsRefreshResponse;

import retrofit2.Call;
import retrofit2.http.GET;
import retrofit2.http.Header;
import retrofit2.http.Path;
import retrofit2.http.Query;

/**
 * Interface that defines the directions refresh service. This corresponds to v1 of the
 * directions API, specifically driving directions.
 *
 * @since 4.4.0
 */
public interface DirectionsRefreshService {

  /**
   * Constructs the html call using the information passed in through the
   * {@link MapboxDirectionsRefresh.Builder}.
   *
   * @param userAgent   the user agent
   * @param requestId   a uuid specifying the request containing the route being refreshed
   * @param routeIndex  the index of the specified route
   * @param legIndex    the index of the leg to start the refresh response (inclusive)
   * @param accessToken Mapbox access token
   * @return the {@link DirectionsRefreshResponse} in a Call wrapper
   * @since 4.4.0
   */
  @GET("directions-refresh/v1/mapbox/driving-traffic/{request_id}/{route_index}/{leg_index}")
  Call getCall(
    @Header("User-Agent") String userAgent,
    @Path("request_id") String requestId,
    @Path("route_index") int routeIndex,
    @Path("leg_index") int legIndex,
    @Query("access_token") String accessToken
  );
}