Class MasstransitOptions

com.yandex.mapkit.transport.masstransit

java.lang.Object ⇽ MasstransitOptions

public class MasstransitOptions

User-defined options for a MasstransitRouter request.

Constructors

MasstransitOptions(@NonNull List< String > avoidTypes, @NonNull List< String > acceptTypes, @NonNull TimeOptions timeOptions)
MasstransitOptions()

Use constructor with parameters in your code.

Methods

List< String > getAcceptTypes()

Transport types that will be allowed even if they are avoided.

List< String > getAvoidTypes()

Transport types that the router will avoid.

TimeOptions getTimeOptions()

Desired departure/arrival time settings.

void serialize(Archive archive)
MasstransitOptions setAcceptTypes(@NonNull List< String > acceptTypes)

See getAcceptTypes().

MasstransitOptions setAvoidTypes(@NonNull List< String > avoidTypes)

See getAvoidTypes().

MasstransitOptions setTimeOptions(@NonNull TimeOptions timeOptions)

See getTimeOptions().

Constructor Detail

MasstransitOptions

public MasstransitOptions (@NonNull List< String > avoidTypes, @NonNull List< String > acceptTypes, @NonNull TimeOptions timeOptions)

MasstransitOptions

public MasstransitOptions ()

Use constructor with parameters in your code.

This one is for bindings only!

Method Detail

getAcceptTypes

public List< String > getAcceptTypes ()

Transport types that will be allowed even if they are avoided.

The client must explicitly add all known non-avoided vehicle types to this parameter when sending a request to the mass transit router. This is necessary to prevent problems with avoiding subtypes of any avoided type if the user did not set them as avoided. The server supports at least the following vehicle type identifiers: bus, trolleybus, tramway, minibus, suburban, underground, ferry, cable, funicular. You must put every vehicle type identifier known to you either in avoidTypes or in acceptTypes list, so that router can provide routes with the most accurate filtering options for your application. Avoid making assumptions like vehicle type A is a subtype of vehicle type B.

getAvoidTypes

public List< String > getAvoidTypes ()

Transport types that the router will avoid.

getTimeOptions

public TimeOptions getTimeOptions ()

Desired departure/arrival time settings.

Empty TimeOptions for requests that are not time-dependent.

serialize

public void serialize (Archive archive)

setAcceptTypes

public MasstransitOptions setAcceptTypes (@NonNull List< String > acceptTypes)

See getAcceptTypes().

setAvoidTypes

public MasstransitOptions setAvoidTypes (@NonNull List< String > avoidTypes)

See getAvoidTypes().

setTimeOptions

public MasstransitOptions setTimeOptions (@NonNull TimeOptions timeOptions)

See getTimeOptions().