Azure.Maps.Routing.Models Namespace

Classes

BatchResult

This object is returned from a successful Batch service call. Extend with 'batchItems' property.

EffectiveSetting

Effective parameter or data used when calling this Route API.

GetDirectionsOperation

An Operation<T> for tracking the status of a RequestRouteDirectionsBatch request. Its Value upon successful completion will be the route directions batch result.

GetRouteMatrixOperation

An Operation<T> for tracking the status of a GetRouteMatrix(WaitUntil, RouteMatrixOptions, CancellationToken) request. Its Value upon successful completion will be the route matrix result.

MapsRoutingModelFactory

Model factory for models.

RouteData

The Route.

RouteDirections

This object is returned from a successful Route Directions call.

RouteDirectionsBatchItemResponse

The result of the query. RouteDirections if the query completed successfully, ErrorResponse otherwise.

RouteDirectionsBatchResult

This object is returned from a successful Route Directions Batch service call.

RouteGuidance

Contains guidance related elements. This field is present only when guidance was requested and is available.

RouteInstruction

A set of attributes describing a maneuver, e.g. 'Turn right', 'Keep left', 'Take the ferry', 'Take the motorway', 'Arrive'.

RouteInstructionGroup

Groups a sequence of instruction elements which are related to each other. The sequence range is constrained with firstInstructionIndex and lastInstructionIndex. When human-readable text messages are requested for guidance (instructionType=text or tagged), then the instructionGroup has a summary message returned when available.

RouteLeg

A description of a part of a route, comprised of a list of points. Each additional waypoint provided in the request will result in an additional leg in the returned route.

RouteLegSummary

Summary object for route section.

RouteMatrix

Matrix result object.

RouteMatrixResult

This object is returned from a successful Route Matrix call. For ex, if 2 origins and 3 destinations are provided, there are going to 2 arrays with 3 elements in each. Each element's content depends on the options provided in the query.

RouteMatrixSummary

Summary object.

RouteOptimizedWaypoint

Optimized way point object.

RouteRange

Reachable Range.

RouteRangeResult

This object is returned from a successful Route Reachable Range call.

RouteReport

Reports the effective settings used in the current call.

RouteSection

Route sections contain additional information about parts of a route. Each section contains at least the elements startPointIndex, endPointIndex, and sectionType.

RouteSectionTec

Details of the traffic event, using definitions in the TPEG2-TEC standard. Can contain effectCode and causes elements.

RouteSectionTecCause

The cause of the traffic event. Can contain mainCauseCode and subCauseCode elements. Can be used to define iconography and descriptions.

RouteSummary

Summary object.

Structs

DelayMagnitude

The magnitude of delay caused by the incident. These values correspond to the values of the response field ty of the Get Traffic Incident Detail API.

DrivingSide

Indicates left-hand vs. right-hand side driving at the point of the maneuver.

GuidanceInstructionType

Type of the instruction, e.g., turn or change of road form.

GuidanceManeuver

A code identifying the maneuver.

JunctionType

The type of the junction where the maneuver takes place. For larger roundabouts, two separate instructions are generated for entering and leaving the roundabout.

ResponseSectionType

Section types of the reported route response.

ResponseTravelMode

Travel mode for the calculated route. The value will be set to other if the requested mode of transport is not possible in this section.

TrafficIncidentCategory

Type of the incident. Can currently be JAM, ROAD_WORK, ROAD_CLOSURE, or OTHER. See "tec" for detailed information.