Warning

This feature is available in the Full MapKit SDK version

YMKMasstransitRouter

@interface YMKMasstransitRouter : NSObject

Provides methods for submitting mass transit routing requests.

Summary

Instance methods

- (nonnull YMKMasstransitSession *)
    requestRoutesWithPoints:(nonnull NSArray<YMKRequestPoint *> *)points
             transitOptions:(nonnull YMKTransitOptions *)transitOptions
                 avoidSteep:(BOOL)avoidSteep
               routeHandler:
                   (nonnull YMKMasstransitSessionRouteHandler)routeHandler;

Submits a request to find mass transit routes

- (nonnull YMKMasstransitSummarySession *)
    requestRoutesSummaryWithPoints:(nonnull NSArray<YMKRequestPoint *> *)points
                    transitOptions:(nonnull YMKTransitOptions *)transitOptions
                        avoidSteep:(BOOL)avoidSteep
                    summaryHandler:
                        (nonnull YMKMasstransitSummarySessionSummaryHandler)
                            summaryHandler;

Submits a request to fetch a brief summary of a mass transit route

- (nonnull YMKMasstransitSession *)
    resolveUriWithUri:(nonnull NSString *)uri
          timeOptions:(nonnull YMKTimeOptions *)timeOptions
         routeHandler:(nonnull YMKMasstransitSessionRouteHandler)routeHandler;

Submits a request to retrieve detailed information on a mass transit route by URI

- (nonnull YMKMasstransitRouteSerializer *)routeSerializer;
Returns a route serializer instance

Instance methods

requestRoutesWithPoints:transitOptions:avoidSteep:routeHandler:

- (nonnull YMKMasstransitSession *)
    requestRoutesWithPoints:(nonnull NSArray<YMKRequestPoint *> *)points
             transitOptions:(nonnull YMKTransitOptions *)transitOptions
                 avoidSteep:(BOOL)avoidSteep
               routeHandler:
                   (nonnull YMKMasstransitSessionRouteHandler)routeHandler;

Submits a request to find mass transit routes.

Parameters

points

Route points (See YMKRequestPoint for details). Currently only two points are supported (start and finish)

transitOptions

Additional parameters for building routes.

avoidSteep

If true, router will try avoid steep (in height meaning) routes.

routeListener

Listener to retrieve a list of MasstransitRoute objects.


requestRoutesSummaryWithPoints:transitOptions:avoidSteep:summaryHandler:

- (nonnull YMKMasstransitSummarySession *)
    requestRoutesSummaryWithPoints:(nonnull NSArray<YMKRequestPoint *> *)points
                    transitOptions:(nonnull YMKTransitOptions *)transitOptions
                        avoidSteep:(BOOL)avoidSteep
                    summaryHandler:
                        (nonnull YMKMasstransitSummarySessionSummaryHandler)
                            summaryHandler;

Submits a request to fetch a brief summary of a mass transit route.


resolveUriWithUri:timeOptions:routeHandler:

- (nonnull YMKMasstransitSession *)
    resolveUriWithUri:(nonnull NSString *)uri
          timeOptions:(nonnull YMKTimeOptions *)timeOptions
         routeHandler:(nonnull YMKMasstransitSessionRouteHandler)routeHandler;

Submits a request to retrieve detailed information on a mass transit route by URI.

Parameters

uri

The URI of the mass transit route. Starts with "ymapsbm1://route/transit".

timeOptions

Desired departure/arrival time settings. Empty YMKTimeOptions for requests that are not time-dependent.

routeListener

Listener to retrieve a list of MasstransitRoute objects.


routeSerializer

- (nonnull YMKMasstransitRouteSerializer *)routeSerializer;

Returns a route serializer instance.