Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

mapmathing: - added to services docs; - fix api-ref docs #1400

Merged
merged 1 commit into from
Apr 13, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -422,6 +422,10 @@ public Builder waypointIndices(@Nullable @IntRange(from = 0) Integer... waypoint
* Setting this will determine whether to return steps and turn-by-turn instructions. Can be
* set to either true or false to enable or disable respectively. null can also optionally be
* passed in to set the default behavior to match what the API does by default.
*<p>
* If `steps` is set to `true`, the following guidance-related parameters will be available:
* `banner_instructions`, `language`, `roundabout_exits`, `voice_instructions`,
* `voice_units`, `waypoint_names`, and `waypoints`.
*
* @param steps true if you'd like step information
* @return this builder for chaining options together
Expand All @@ -443,11 +447,12 @@ public Builder waypointIndices(@Nullable @IntRange(from = 0) Integer... waypoint
public abstract Builder overview(@Nullable @OverviewCriteria String overview);

/**
* Setting this will determine Whether or not to return banner objects associated with
* the `routeSteps`. Should be used in conjunction with `steps`.
* Can be set to either true or false to enable or
* Setting this will determine whether or not to return banner objects associated with
* the `routeSteps`. Can be set to either true or false to enable or
* disable respectively. null can also optionally be
* passed in to set the default behavior to match what the API does by default.
* <p>
* Must be used in conjunction with `steps=true`.
*
* @param bannerInstructions true if you'd like step information
* @return this builder for chaining options together
Expand All @@ -457,9 +462,11 @@ public Builder waypointIndices(@Nullable @IntRange(from = 0) Integer... waypoint


/**
* Setting this will determine whether to return steps and turn-by-turn instructions. Can be
* set to either true or false to enable or disable respectively. null can also optionally be
* passed in to set the default behavior to match what the API does by default.
* Setting can be set to either true or false to enable or disable SSML marked-up text for
* voice guidance along the route. null can also optionally be passed in to set the default
* behavior to match what the API does by default.
* <p>
* Must be used in conjunction with `steps=true`.
*
* @param voiceInstructions true if you'd like step information
* @return this builder for chaining options together
Expand All @@ -469,7 +476,8 @@ public Builder waypointIndices(@Nullable @IntRange(from = 0) Integer... waypoint

/**
* Specify what unit you'd like voice and banner instructions to use.
*
* <p>
* Must be used in conjunction with `steps=true` and `voice_instructions=true`.
* @param voiceUnits either Imperial (default) or Metric
* @return this builder for chaining options together
* @since 3.0.0
Expand All @@ -479,9 +487,11 @@ public abstract Builder voiceUnits(
);

/**
* Setting this will determine whether to return steps and turn-by-turn instructions. Can be
* set to either true or false to enable or disable respectively. null can also optionally be
* passed in to set the default behavior to match what the API does by default.
* Setting can be set to either true or false to enable or disable respectively.
* null can also optionally be passed in to set the default behavior to match what the API
* does by default.
* <p>
* Must be used in conjunction with `steps=true`.
*
* @param roundaboutExits true if you'd like step information
* @return this builder for chaining options together
Expand Down Expand Up @@ -568,6 +578,8 @@ public Builder coordinate(@NonNull Point coordinate) {
* Set the instruction language for the map matching request, the default is english. Only a
* select number of languages are currently supported, reference the table provided in the see
* link below.
* <p>
* Must be used in conjunction with `steps=true`.
*
* @param language a Locale value representing the language you'd like the instructions to be
* written in when returned
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
/**
* Contains classes for accessing the Mapbox MapMatching API.
*/
package com.mapbox.api.matching.v5;
2 changes: 1 addition & 1 deletion services/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sourceSets {
'../services-optimization/src/main/java', '../services-staticmap/src/main/java',
'../services-speech/src/main/java', '../services-tilequery/src/main/java',
'../services-route-tiles/src/main/java', '../services-directions-refresh/src/main/java',
'../services-isochrone/src/main/java']
'../services-isochrone/src/main/java', '../services-matching/src/main/java']
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

include mapmatching to services api-ref docs

cc @Guardiola31337

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@RingerJK @Guardiola31337 When will we see the new map matching docs on https://docs.mapbox.com/android/java/api-reference/?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They're already available under mapbox-java-services e.g. MapMatchingService 🚀

}

dependencies {
Expand Down