com.mapbox.api.directions.v5.models

Class VoiceInstructions.Builder

java.lang.Object

com.mapbox.api.directions.v5.models.VoiceInstructions.Builder

Enclosing class:

VoiceInstructions

public abstract static class VoiceInstructions.Builder
extends java.lang.Object

This builder can be used to set the values describing the VoiceInstructions.

Since:

3.0.0

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract VoiceInstructions.Builder	announcement(java.lang.String announcement) Provides the instruction string which was build on the server-side and can sometimes concatenate instructions together if maneuver instructions are too close to each other.
abstract VoiceInstructions	build() This uses the provided parameters set using the VoiceInstructions.Builder and creates a new instance of VoiceInstructions.
abstract VoiceInstructions.Builder	distanceAlongGeometry(java.lang.Double distanceAlongGeometry) Returns the missing piece in which is needed to announce instructions at accurate times.
abstract VoiceInstructions.Builder	ssmlAnnouncement(java.lang.String ssmlAnnouncement) Get the same instruction string you'd get from VoiceInstructions.announcement() but this one includes Speech Synthesis Markup Language which helps voice synthesiser read information more humanely.
T	unrecognizedJsonProperties(java.util.Map<java.lang.String,com.google.gson.JsonElement> unrecognizedProperties) Use this method to add parameters which are not present in the model yet but are supported on the Directions API side in the response.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

distanceAlongGeometry

public abstract VoiceInstructions.Builder distanceAlongGeometry(java.lang.Double distanceAlongGeometry)

Returns the missing piece in which is needed to announce instructions at accurate times. If the user is less distance away from the maneuver than what this distanceAlongGeometry() than, the announcement should be called.

Parameters:

distanceAlongGeometry - double value representing the distance to next maneuver in unit meters

Returns:

this builder for chaining options together

Since:

3.0.0

announcement

public abstract VoiceInstructions.Builder announcement(java.lang.String announcement)

Provides the instruction string which was build on the server-side and can sometimes concatenate instructions together if maneuver instructions are too close to each other.

Parameters:

announcement - a string with the readable instructions ready to be read or displayed to a user

Returns:

this builder for chaining options together

Since:

3.0.0

ssmlAnnouncement

public abstract VoiceInstructions.Builder ssmlAnnouncement(java.lang.String ssmlAnnouncement)

Get the same instruction string you'd get from VoiceInstructions.announcement() but this one includes Speech Synthesis Markup Language which helps voice synthesiser read information more humanely.

Parameters:

ssmlAnnouncement - a string with the SSML instructions

Returns:

this builder for chaining options together

Since:

3.0.0

build

public abstract VoiceInstructions build()

This uses the provided parameters set using the VoiceInstructions.Builder and creates a new instance of VoiceInstructions.

Returns:

a new instance of Voice Instructions

Since:

3.0.0

unrecognizedJsonProperties

@NonNull
public T unrecognizedJsonProperties(@Nullable
                                             java.util.Map<java.lang.String,com.google.gson.JsonElement> unrecognizedProperties)

Use this method to add parameters which are not present in the model yet but are supported on the Directions API side in the response. Use it for experimental parameters.

Parameters:

unrecognizedProperties - parameters to add to request