public interface MapMatchingService
Modifier and Type | Method and Description |
---|---|
retrofit2.Call<MapMatchingResponse> |
getCall(java.lang.String userAgent,
java.lang.String user,
java.lang.String profile,
java.lang.String coordinates,
java.lang.String accessToken,
java.lang.String geometries,
java.lang.String radiuses,
java.lang.Boolean steps,
java.lang.String overview,
java.lang.String timestamps,
java.lang.String annotations,
java.lang.String language,
java.lang.Boolean tidy,
java.lang.Boolean roundaboutExits,
java.lang.Boolean bannerInstructions,
java.lang.Boolean voiceInstructions,
java.lang.String voiceUnits,
java.lang.String waypointIndices,
java.lang.String waypointNames,
java.lang.String ignore,
java.lang.String approaches)
Constructs the GET call using the information passed in through the
MapboxMapMatching.Builder . |
retrofit2.Call<MapMatchingResponse> |
postCall(java.lang.String userAgent,
java.lang.String user,
java.lang.String profile,
java.lang.String coordinates,
java.lang.String accessToken,
java.lang.String geometries,
java.lang.String radiuses,
java.lang.Boolean steps,
java.lang.String overview,
java.lang.String timestamps,
java.lang.String annotations,
java.lang.String language,
java.lang.Boolean tidy,
java.lang.Boolean roundaboutExits,
java.lang.Boolean bannerInstructions,
java.lang.Boolean voiceInstructions,
java.lang.String voiceUnits,
java.lang.String waypointIndices,
java.lang.String waypointNames,
java.lang.String ignore,
java.lang.String approaches)
Constructs the POST call using the information passed in through the
MapboxMapMatching.Builder . |
@GET(value="matching/v5/{user}/{profile}/{coordinates}") retrofit2.Call<MapMatchingResponse> 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="access_token") java.lang.String accessToken, @Query(value="geometries") java.lang.String geometries, @Query(value="radiuses") java.lang.String radiuses, @Query(value="steps") java.lang.Boolean steps, @Query(value="overview") java.lang.String overview, @Query(value="timestamps") java.lang.String timestamps, @Query(value="annotations") java.lang.String annotations, @Query(value="language") java.lang.String language, @Query(value="tidy") java.lang.Boolean tidy, @Query(value="roundabout_exits") java.lang.Boolean roundaboutExits, @Query(value="banner_instructions") java.lang.Boolean bannerInstructions, @Query(value="voice_instructions") java.lang.Boolean voiceInstructions, @Query(value="voice_units") java.lang.String voiceUnits, @Query(value="waypoints") java.lang.String waypointIndices, @Query(value="waypoint_names") java.lang.String waypointNames, @Query(value="ignore") java.lang.String ignore, @Query(value="approaches") java.lang.String approaches)
MapboxMapMatching.Builder
.userAgent
- user agentuser
- userprofile
- directions profile ID; either mapbox/driving, mapbox/walking,
or mapbox/cyclingcoordinates
- inaccurate traces from a GPS unit or a phoneaccessToken
- Mapbox access tokengeometries
- format of the returned geometry. Allowed values are: geojson
(as LineString), polyline with precision 5, polyline6. The default
value is polylineradiuses
- a list of integers in meters indicating the assumed precision of
the used tracking device. There must be as many radiuses as there
are coordinates in the request, each separated by ;. Values can be
a number between 0 and 30. Use higher numbers (20-30) for noisy
traces and lower numbers (1-10) for clean traces. The default value
is 5steps
- whether to return steps and turn-by-turn instructions. Can be true
or false. The default is falseoverview
- type of returned overview geometry. Can be full (the most detailed
geometry available), simplified (a simplified version of the full
geometry), or false (no overview geometry). The default is simplifiedtimestamps
- timestamps corresponding to each coordinate provided in the request;
must be numbers in Unix time (seconds since the Unix epoch). There
must be as many timestamps as there are coordinates in the request,
each separated by ;
annotations
- whether or not to return additional metadata for each coordinate
along the match geometry. Can be one or all of 'duration',
'distance', or 'nodes', each separated by ,. See the response
object for more details on what it is included with annotationslanguage
- language of returned turn-by-turn text instructionstidy
- whether or not to transparently remove clusters and re-sample
traces for improved map matching resultsroundaboutExits
- Whether or not to emit instructions at roundabout exits.bannerInstructions
- Whether or not to return banner objects associated with
the `routeSteps`. Should be used in conjunction with `steps`.voiceInstructions
- whether or not to return
marked-up text for voice guidance along the route.voiceUnits
- voice unitswaypointIndices
- 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 instruction.ignore
- ignore certain routing restrictions when map matching.approaches
- which side of the road to approach a waypoint.@FormUrlEncoded @POST(value="matching/v5/{user}/{profile}") retrofit2.Call<MapMatchingResponse> 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="access_token") java.lang.String accessToken, @Field(value="geometries") java.lang.String geometries, @Field(value="radiuses") java.lang.String radiuses, @Field(value="steps") java.lang.Boolean steps, @Field(value="overview") java.lang.String overview, @Field(value="timestamps") java.lang.String timestamps, @Field(value="annotations") java.lang.String annotations, @Field(value="language") java.lang.String language, @Field(value="tidy") java.lang.Boolean tidy, @Field(value="roundabout_exits") java.lang.Boolean roundaboutExits, @Field(value="banner_instructions") java.lang.Boolean bannerInstructions, @Field(value="voice_instructions") java.lang.Boolean voiceInstructions, @Field(value="voice_units") java.lang.String voiceUnits, @Field(value="waypoints") java.lang.String waypointIndices, @Field(value="waypoint_names") java.lang.String waypointNames, @Field(value="ignore") java.lang.String ignore, @Field(value="approaches") java.lang.String approaches)
MapboxMapMatching.Builder
.userAgent
- user agentuser
- userprofile
- directions profile ID; either mapbox/driving, mapbox/walking,
or mapbox/cyclingcoordinates
- inaccurate traces from a GPS unit or a phoneaccessToken
- Mapbox access tokengeometries
- format of the returned geometry. Allowed values are: geojson
(as LineString), polyline with precision 5, polyline6. The default
value is polylineradiuses
- a list of integers in meters indicating the assumed precision of
the used tracking device. There must be as many radiuses as there
are coordinates in the request, each separated by ;. Values can be
a number between 0 and 30. Use higher numbers (20-30) for noisy
traces and lower numbers (1-10) for clean traces. The default value
is 5steps
- whether to return steps and turn-by-turn instructions. Can be true
or false. The default is falseoverview
- type of returned overview geometry. Can be full (the most detailed
geometry available), simplified (a simplified version of the full
geometry), or false (no overview geometry). The default is simplifiedtimestamps
- timestamps corresponding to each coordinate provided in the request;
must be numbers in Unix time (seconds since the Unix epoch). There
must be as many timestamps as there are coordinates in the request,
each separated by ;
annotations
- whether or not to return additional metadata for each coordinate
along the match geometry. Can be one or all of 'duration',
'distance', or 'nodes', each separated by ,. See the response
object for more details on what it is included with annotationslanguage
- language of returned turn-by-turn text instructionstidy
- whether or not to transparently remove clusters and re-sample
traces for improved map matching resultsroundaboutExits
- Whether or not to emit instructions at roundabout exits.bannerInstructions
- Whether or not to return banner objects associated with
the `routeSteps`. Should be used in conjunction with `steps`.voiceInstructions
- whether or not to return
marked-up text for voice guidance along the route.voiceUnits
- voice unitswaypointIndices
- 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 instruction.ignore
- ignore certain routing restrictions when map matching.approaches
- which side of the road to approach a waypoint.