Skip to content

RouteTransitOptions

Source code in docs_src/capo_geo_routes/types/route_transit_options.py
class RouteTransitOptions(TypedDict, closed=True):
    accessibility_attributes: NotRequired[
        "capo_geo_routes.types.route_accessibility_attribute_list.RouteAccessibilityAttributeList"
    ]
    """<p>Accessibility attributes to consider when calculating the route.</p>"""
    allowed_modes: NotRequired[
        "capo_geo_routes.types.route_transit_mode_list.RouteTransitModeList"
    ]
    """<p>Allowed transit transport modes when calculating the route. By default, all transport modes are allowed. Cannot be used together with <code>ExcludedModes</code>.</p>"""
    excluded_modes: NotRequired[
        "capo_geo_routes.types.route_transit_mode_list.RouteTransitModeList"
    ]
    """<p>Excluded transit transport modes when calculating the route. By default, all transport modes are allowed. Cannot be used together with <code>AllowedModes</code>.</p>"""
    max_transfers: NotRequired["int"]
    """<p>Maximum number of transfers allowed when calculating the route.</p>"""
    pedestrian: NotRequired[
        "capo_geo_routes.types.route_transit_pedestrian_options.RouteTransitPedestrianOptions"
    ]
    """<p>Options for the pedestrian leg of the transit route.</p>"""

accessibility_attributes instance-attribute

accessibility_attributes: NotRequired[RouteAccessibilityAttributeList]

Accessibility attributes to consider when calculating the route.

allowed_modes instance-attribute

allowed_modes: NotRequired[RouteTransitModeList]

Allowed transit transport modes when calculating the route. By default, all transport modes are allowed. Cannot be used together with ExcludedModes.

excluded_modes instance-attribute

excluded_modes: NotRequired[RouteTransitModeList]

Excluded transit transport modes when calculating the route. By default, all transport modes are allowed. Cannot be used together with AllowedModes.

max_transfers instance-attribute

max_transfers: NotRequired[int]

Maximum number of transfers allowed when calculating the route.

pedestrian instance-attribute

pedestrian: NotRequired[RouteTransitPedestrianOptions]

Options for the pedestrian leg of the transit route.