MobilityGetTransitRoutePreviewOptionalParams interface

Paket:

azure-maps-rest

Optionale Parameter.

Extends

RequestOptionsBase

Eigenschaften

agency	Gibt an, ob Routen von bestimmten Agenturen nach Möglichkeit bevorzugt werden sollen; als durch Kommas getrennte Liste. Wenn eine gültige Reise nicht bei der bevorzugten Agentur gefunden wird, oder nur eine mit sehr langen Reisen oder mit einer großen Anzahl von Transfers, werden Reiserouten mit anderen Agenturen zurückgegeben.
agencyType	Gibt den Agenturbezeichner an, um Routen von bevorzugten Agenturen anzufordern. Standardmäßig ist agencyType=agencyId. Mögliche Werte: "agencyId", "agencyKey", "agencyName"
bikeType	Fahrradtyp des Fahrrads. Gibt an, welcher Typ von Fahrrädern verwendet wird. Wenn nicht angegeben, sind alle zulässig. Mögliche Werte sind: "privateBike", "dockedBike"
destinationType	Der Typ des Ziels. Mögliche Werte: "position", "stopId", "stopKey"
language	Sprache, in der Suchergebnisse zurückgegeben werden. Nur NGT wird unterstützt. Weitere Informationen finden Sie unter Unterstützte Sprachen .
modeType	Die Art der Fahrt für die angeforderte Route; als kommagetrennte Liste. Wenn nicht angegeben, sind alle Modi zulässig. Möglicherweise sind nicht alle Modi in allen Metrobereichen verfügbar. Wenn eine gültige Reise nicht gefunden wird, wird ein leeres Ergebnis zurückgegeben.
originType	Der Typ des Ursprungs. Standardmäßig originType=position, angegeben als kommagetrennte Zeichenfolge, die aus Breitengrad und längengrad besteht, z. B. "47.641268,-122.125679". Mögliche Werte: "position", "stopId", "stopKey"
routeType	Der Typ der angeforderten Route. Wenn nicht angegeben, wird "optimal" verwendet. Mögliche Werte: "optimal", "leastWalk", "leastTransfers"
time	Die Abflug- oder Ankunftszeit in der Ortszeit im ISO-Format (2019-04-05T14:24:18-04:00). Wenn timeType nicht angegeben ist, wird davon ausgegangen, dass es "Abflug" ist, und die Zeit ist die aktuelle lokale Zeit am Ursprungspunkt.
timeType	Gibt an, ob die Uhrzeit die Abflug- oder Ankunftszeit bedeutet. Falls nicht definiert, lautet der Standardwert "abflug". Mögliche Werte: "arrival", "departure", "last"
transitType	Gilt nur für modeType = publicTransit. Zulassen, dass nur eine bestimmte Gruppe von Typen des öffentlichen Verkehrs (als durch Kommas getrennte Liste) für die Route zurückgegeben wird. Beachten Sie, dass der angeforderte transitType möglicherweise nicht für die gesamte Route verfügbar ist. Wenn nicht angegeben, sind alle Modi zulässig.

Geerbte Eigenschaften

abortSignal	Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.
customHeaders	{object} [customHeaders] Benutzerdefinierte benutzerdefinierte Anforderungsheader, die angewendet werden, bevor die Anforderung gesendet wird.
onDownloadProgress	Rückruf, der beim Downloadfortschritt ausgelöst wird.
onUploadProgress	Rückruf, der beim Hochladen des Fortschritts ausgelöst wird.
timeout	Die Anzahl von Millisekunden, die eine Anforderung dauern kann, bevor sie automatisch beendet wird.

Details zur Eigenschaft

agency

Gibt an, ob Routen von bestimmten Agenturen nach Möglichkeit bevorzugt werden sollen; als durch Kommas getrennte Liste. Wenn eine gültige Reise nicht bei der bevorzugten Agentur gefunden wird, oder nur eine mit sehr langen Reisen oder mit einer großen Anzahl von Transfers, werden Reiserouten mit anderen Agenturen zurückgegeben.

agency?: string[]

Eigenschaftswert

string[]

agencyType

Gibt den Agenturbezeichner an, um Routen von bevorzugten Agenturen anzufordern. Standardmäßig ist agencyType=agencyId. Mögliche Werte: "agencyId", "agencyKey", "agencyName"

agencyType?: AgencyType

Eigenschaftswert

AgencyType

bikeType

Fahrradtyp des Fahrrads. Gibt an, welcher Typ von Fahrrädern verwendet wird. Wenn nicht angegeben, sind alle zulässig. Mögliche Werte sind: "privateBike", "dockedBike"

bikeType?: BikeType

Eigenschaftswert

BikeType

destinationType

Der Typ des Ziels. Mögliche Werte: "position", "stopId", "stopKey"

destinationType?: DestinationType

Eigenschaftswert

DestinationType

language

Sprache, in der Suchergebnisse zurückgegeben werden. Nur NGT wird unterstützt. Weitere Informationen finden Sie unter Unterstützte Sprachen .

language?: string

Eigenschaftswert

string

modeType

Die Art der Fahrt für die angeforderte Route; als kommagetrennte Liste. Wenn nicht angegeben, sind alle Modi zulässig. Möglicherweise sind nicht alle Modi in allen Metrobereichen verfügbar. Wenn eine gültige Reise nicht gefunden wird, wird ein leeres Ergebnis zurückgegeben.

modeType?: ModeType[]

Eigenschaftswert

ModeType[]

originType

Der Typ des Ursprungs. Standardmäßig originType=position, angegeben als kommagetrennte Zeichenfolge, die aus Breitengrad und längengrad besteht, z. B. "47.641268,-122.125679". Mögliche Werte: "position", "stopId", "stopKey"

originType?: OriginType

Eigenschaftswert

OriginType

routeType

Der Typ der angeforderten Route. Wenn nicht angegeben, wird "optimal" verwendet. Mögliche Werte: "optimal", "leastWalk", "leastTransfers"

routeType?: TransitRouteType

Eigenschaftswert

TransitRouteType

time

Die Abflug- oder Ankunftszeit in der Ortszeit im ISO-Format (2019-04-05T14:24:18-04:00). Wenn timeType nicht angegeben ist, wird davon ausgegangen, dass es "Abflug" ist, und die Zeit ist die aktuelle lokale Zeit am Ursprungspunkt.

time?: string

Eigenschaftswert

string

timeType

Gibt an, ob die Uhrzeit die Abflug- oder Ankunftszeit bedeutet. Falls nicht definiert, lautet der Standardwert "abflug". Mögliche Werte: "arrival", "departure", "last"

timeType?: TimeType

Eigenschaftswert

TimeType

transitType

Gilt nur für modeType = publicTransit. Zulassen, dass nur eine bestimmte Gruppe von Typen des öffentlichen Verkehrs (als durch Kommas getrennte Liste) für die Route zurückgegeben wird. Beachten Sie, dass der angeforderte transitType möglicherweise nicht für die gesamte Route verfügbar ist. Wenn nicht angegeben, sind alle Modi zulässig.

transitType?: TransitTypeFilter[]

Eigenschaftswert

TransitTypeFilter[]

Geerbte Eigenschaftsdetails

abortSignal

Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.

abortSignal?: AbortSignalLike

Eigenschaftswert

AbortSignalLike

Geerbt von RequestOptionsBase.abortSignal

customHeaders

{object} [customHeaders] Benutzerdefinierte benutzerdefinierte Anforderungsheader, die angewendet werden, bevor die Anforderung gesendet wird.

customHeaders?: [key: string]: string

Eigenschaftswert

[key: string]: string

Geerbt von RequestOptionsBase.customHeaders

onDownloadProgress

Rückruf, der beim Downloadfortschritt ausgelöst wird.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Eigenschaftswert

(progress: TransferProgressEvent) => void

Geerbt von RequestOptionsBase.onDownloadProgress

onUploadProgress

Rückruf, der beim Hochladen des Fortschritts ausgelöst wird.

onUploadProgress?: (progress: TransferProgressEvent) => void

Eigenschaftswert

(progress: TransferProgressEvent) => void

Geerbt von RequestOptionsBase.onUploadProgress

timeout

Die Anzahl von Millisekunden, die eine Anforderung dauern kann, bevor sie automatisch beendet wird.

timeout?: number

Eigenschaftswert

number

Geerbt von RequestOptionsBase.timeout