YMKMasstransitRouteMetadata

Warning

This feature is available in the Full MapKit SDK version

@interface YMKMasstransitRouteMetadata : NSObject <YMKBaseMetadata>

Contains information associated with a route constructed by the mass transit router.

Summary

Class methods

+ (nonnull YMKMasstransitRouteMetadata *)routeMetadataWithWeight:(nonnull YMKMasstransitWeight *)weight settings:(nullable YMKMasstransitRouteSettings *)settings estimation:(nullable YMKMasstransitTravelEstimation *)estimation wayPoints:(nonnull NSArray<YMKMasstransitWayPoint *> *)wayPoints routeId:(nullable NSString *)routeId flags:(nullable YMKMasstransitFlags *)flags comfortTags:(nonnull NSArray<NSNumber *> *)comfortTags stairsSummary:(nonnull YMKMasstransitStairsSummary *)stairsSummary paymentOptions:(nonnull NSArray<YMKMasstransitRoutePaymentOption *> *)paymentOptions routeExplanation:(nullable NSString *)routeExplanation;

Properties

@property (nonatomic, readonly, nonnull) YMKMasstransitWeight *weight;
Contains the route time, distance of the walking part, and the number of transfers

@property (nonatomic, readonly, nullable) YMKMasstransitRouteSettings *settings;
Route settings that were used by the mass transit router

@property (nonatomic, readonly, nullable) YMKMasstransitTravelEstimation *estimation;
Arrival and departure time estimations for time-dependent routes

@property (nonatomic, readonly, nonnull) NSArray<YMKMasstransitWayPoint *> *wayPoints;
List of route waypoints

@property (nonatomic, readonly, nullable) NSString *routeId;
Unique route id

@property (nonatomic, readonly, nullable) YMKMasstransitFlags *flags;
Flags which contains route properties

Optional field, can be nil

@property (nonatomic, readonly, nonnull) NSArray<NSNumber *> *comfortTags;

@property (nonatomic, readonly, nonnull) YMKMasstransitStairsSummary *stairsSummary;

@property (nonatomic, readonly, nonnull) NSArray<YMKMasstransitRoutePaymentOption *> *paymentOptions;
List of payment options with prices for the whole route

@property (nonatomic, readonly, nullable) NSString *routeExplanation;
Optional field, can be nil