public interface DirectionsService
| Modifier and Type | Method and Description |
|---|---|
retrofit2.Call<com.nbmap.api.directions.v5.models.DirectionsResponse> |
getCall(java.lang.String userAgent,
java.lang.String user,
java.lang.String profile,
java.lang.String coordinates,
java.lang.String accessToken,
java.lang.Boolean alternatives,
java.lang.String geometries,
java.lang.String overview,
java.lang.String radiuses,
java.lang.Boolean steps,
java.lang.String bearings,
java.lang.Boolean continueStraight,
java.lang.String annotations,
java.lang.String language,
java.lang.Boolean roundaboutExits,
java.lang.Boolean voiceInstructions,
java.lang.Boolean bannerInstructions,
java.lang.String voiceUnits,
java.lang.String exclude,
java.lang.String approaches,
java.lang.String waypointIndices,
java.lang.String waypointNames,
java.lang.String waypointTargets,
java.lang.Boolean enableRefresh,
java.lang.Double walkingSpeed,
java.lang.Double walkwayBias,
java.lang.Double alleyBias,
java.lang.String snappingClosures)
Constructs the html get call using the information passed in through the
NbmapDirections.Builder. |
retrofit2.Call<com.nbmap.api.directions.v5.models.DirectionsResponse> |
postCall(java.lang.String userAgent,
java.lang.String user,
java.lang.String profile,
java.lang.String coordinates,
java.lang.String accessToken,
java.lang.Boolean alternatives,
java.lang.String geometries,
java.lang.String overview,
java.lang.String radiuses,
java.lang.Boolean steps,
java.lang.String bearings,
java.lang.Boolean continueStraight,
java.lang.String annotations,
java.lang.String language,
java.lang.Boolean roundaboutExits,
java.lang.Boolean voiceInstructions,
java.lang.Boolean bannerInstructions,
java.lang.String voiceUnits,
java.lang.String exclude,
java.lang.String approaches,
java.lang.String waypointIndices,
java.lang.String waypointNames,
java.lang.String waypointTargets,
java.lang.Boolean enableRefresh,
java.lang.Double walkingSpeed,
java.lang.Double walkwayBias,
java.lang.Double alleyBias,
java.lang.String snappingClosures)
Constructs the post html call using the information passed in through the
NbmapDirections.Builder. |
@GET(value="directions/v5/{user}/{profile}/{coordinates}")
retrofit2.Call<com.nbmap.api.directions.v5.models.DirectionsResponse> getCall(@Header(value="User-Agent")
java.lang.String userAgent,
@Path(value="user")
java.lang.String user,
@Path(value="profile")
java.lang.String profile,
@Path(value="coordinates")
java.lang.String coordinates,
@Query(value="key")
java.lang.String accessToken,
@Query(value="alternatives")
java.lang.Boolean alternatives,
@Query(value="geometries")
java.lang.String geometries,
@Query(value="overview")
java.lang.String overview,
@Query(value="radiuses")
java.lang.String radiuses,
@Query(value="steps")
java.lang.Boolean steps,
@Query(value="bearings")
java.lang.String bearings,
@Query(value="continue_straight")
java.lang.Boolean continueStraight,
@Query(value="annotations")
java.lang.String annotations,
@Query(value="language")
java.lang.String language,
@Query(value="roundabout_exits")
java.lang.Boolean roundaboutExits,
@Query(value="voice_instructions")
java.lang.Boolean voiceInstructions,
@Query(value="banner_instructions")
java.lang.Boolean bannerInstructions,
@Query(value="voice_units")
java.lang.String voiceUnits,
@Query(value="exclude")
java.lang.String exclude,
@Query(value="approaches")
java.lang.String approaches,
@Query(value="waypoints")
java.lang.String waypointIndices,
@Query(value="waypoint_names")
java.lang.String waypointNames,
@Query(value="waypoint_targets")
java.lang.String waypointTargets,
@Query(value="enable_refresh")
java.lang.Boolean enableRefresh,
@Query(value="walking_speed")
java.lang.Double walkingSpeed,
@Query(value="walkway_bias")
java.lang.Double walkwayBias,
@Query(value="alley_bias")
java.lang.Double alleyBias,
@Query(value="snapping_include_closures")
java.lang.String snappingClosures)
NbmapDirections.Builder.userAgent - the user agentuser - the userprofile - the profile directions should usecoordinates - the coordinates the route should followaccessToken - Nbmap access tokenalternatives - define whether you want to receive more then one routegeometries - route geometryoverview - route full, simplified, etc.radiuses - start at the most efficient point within the radiussteps - define if you'd like the route stepsbearings - used to filter the road segment the waypoint will be placed on by
direction and dictates the angle of approachcontinueStraight - define whether the route should continue straight even if the
route will be slowerannotations - an annotations object that contains additional details about each
line segment along the route geometry. Each entry in an
annotations field corresponds to a coordinate along the route
geometrylanguage - language of returned turn-by-turn text instructionsroundaboutExits - Add extra step when roundabouts occur with additional information
for the uservoiceInstructions - request that the response contain voice instruction information,
useful for navigationbannerInstructions - request that the response contain banner instruction information,
useful for navigationvoiceUnits - voice unitsexclude - exclude tolls, motorways or more along your routeapproaches - which side of the road to approach a waypointwaypointIndices - which input coordinates should be treated as waypoints/separate legs
Note: coordinate indices not added here act as silent waypointswaypointNames - custom names for waypoints used for the arrival instructionwaypointTargets - list of coordinate pairs for drop-off locationsenableRefresh - whether the routes should be refreshablewalkingSpeed - walking speedwalkwayBias - a factor that modifies the cost when encountering roads or paths
that do not allow vehicles and are set aside for pedestrian usealleyBias - a factor that modifies the cost when alleys are encounteredsnappingClosures - a list of booleans affecting snapping of waypoint locations to road
segmentsDirectionsResponse in a Call wrapper@FormUrlEncoded
@POST(value="directions/v5/{user}/{profile}")
retrofit2.Call<com.nbmap.api.directions.v5.models.DirectionsResponse> postCall(@Header(value="User-Agent")
java.lang.String userAgent,
@Path(value="user")
java.lang.String user,
@Path(value="profile")
java.lang.String profile,
@Field(value="coordinates")
java.lang.String coordinates,
@Query(value="key")
java.lang.String accessToken,
@Field(value="alternatives")
java.lang.Boolean alternatives,
@Field(value="geometries")
java.lang.String geometries,
@Field(value="overview")
java.lang.String overview,
@Field(value="radiuses")
java.lang.String radiuses,
@Field(value="steps")
java.lang.Boolean steps,
@Field(value="bearings")
java.lang.String bearings,
@Field(value="continue_straight")
java.lang.Boolean continueStraight,
@Field(value="annotations")
java.lang.String annotations,
@Field(value="language")
java.lang.String language,
@Field(value="roundabout_exits")
java.lang.Boolean roundaboutExits,
@Field(value="voice_instructions")
java.lang.Boolean voiceInstructions,
@Field(value="banner_instructions")
java.lang.Boolean bannerInstructions,
@Field(value="voice_units")
java.lang.String voiceUnits,
@Field(value="exclude")
java.lang.String exclude,
@Field(value="approaches")
java.lang.String approaches,
@Field(value="waypoints")
java.lang.String waypointIndices,
@Field(value="waypoint_names")
java.lang.String waypointNames,
@Field(value="waypoint_targets")
java.lang.String waypointTargets,
@Field(value="enable_refresh")
java.lang.Boolean enableRefresh,
@Field(value="walking_speed")
java.lang.Double walkingSpeed,
@Field(value="walkway_bias")
java.lang.Double walkwayBias,
@Field(value="alley_bias")
java.lang.Double alleyBias,
@Field(value="snapping_include_closures")
java.lang.String snappingClosures)
NbmapDirections.Builder.userAgent - the user agentuser - the userprofile - the profile directions should usecoordinates - the coordinates the route should followaccessToken - Nbmap access tokenalternatives - define whether you want to receive more then one routegeometries - route geometryoverview - route full, simplified, etc.radiuses - start at the most efficient point within the radiussteps - define if you'd like the route stepsbearings - used to filter the road segment the waypoint will be placed on by
direction and dictates the angle of approachcontinueStraight - define whether the route should continue straight even if the
route will be slowerannotations - an annotations object that contains additional details about each
line segment along the route geometry. Each entry in an
annotations field corresponds to a coordinate along the route
geometrylanguage - language of returned turn-by-turn text instructionsroundaboutExits - Add extra step when roundabouts occur with additional information
for the uservoiceInstructions - request that the response contain voice instruction information,
useful for navigationbannerInstructions - request that the response contain banner instruction information,
useful for navigationvoiceUnits - voice unitsexclude - exclude tolls, motorways or more along your routeapproaches - which side of the road to approach a waypointwaypointIndices - which input coordinates should be treated as waypoints/separate legs
Note: coordinate indices not added here act as silent waypointswaypointNames - custom names for waypoints used for the arrival instructionwaypointTargets - list of coordinate pairs for drop-off locationsenableRefresh - whether the routes should be refreshablewalkingSpeed - walking speedwalkwayBias - a factor that modifies the cost when encountering roads or paths
that do not allow vehicles and are set aside for pedestrian usealleyBias - a factor that modifies the cost when alleys are encounteredsnappingClosures - a list of booleans affecting snapping of waypoint locations to road
segmentsDirectionsResponse in a Call wrapper