MobilityGetRealTimeArrivalsPreviewOptionalParams interface

Pakiet:

azure-maps-rest

Parametry opcjonalne.

Extends

RequestOptionsBase

Właściwości

agency	Jeśli wolisz zwracać trasy z określonego zestawu agencji. Określony jako ciąg rozdzielony przecinkami.
agencyType	Określa identyfikator agencji, aby zażądać tras z określonego zestawu agencji do zwrócenia. Domyślnie agencyType=agencyId. Możliwe wartości to: "agencyId", "agencyKey", "agencyName"
language	Język, w którym będą zwracane wyniki wyszukiwania. Obsługiwane jest tylko rozwiązanie NGT. Aby uzyskać szczegółowe informacje, zobacz Obsługiwane języki .
limit	Maksymalna liczba przyjazdów do powrotu. Jeśli nie zostanie określony, zostanie użyta wartość domyślna systemu. W przypadku przystanków maksymalna liczba przylotów na przystanek. W przypadku linii maksymalna liczba przylotów na przystanek w wierszu. Dla wszystkich innych maksymalnych przyjazdów ogólnie.
maxMinutesInFuture	Maksymalny czas (w minutach) w przyszłości do powrotu przyjazdów. Jeśli nie zostanie określony, zostanie użyta domyślna wartość systemowa (30 minut). Wartość minimalna to 0, a maksymalna wartość to 60 minut.
queryType	Typ parametru zapytania. Definiuje tryb żądania. Obsługiwany jest tylko jeden tryb na żądanie. Domyślnie parametr queryType ma wartość "stop" zwracającą żądaną liczbę przyjazdów na żywo dla wszystkich wierszy przybywających do określonego zatrzymania. Możliwe wartości to: "stop", "line", "lineAndStop", "position"
stopQueryType	Typ unikatowego parametru zapytania zatrzymania. Domyślnie stopQueryType=stopId. Ten parametr może być używany tylko w połączeniu z queryType=stop lub queryType=lineAndStop. Możliwe wartości to: "stopId", "stopKey"
timeoutInSeconds	Czas w sekundach, w ciągu którego dostawca nie odpowiada, punkt końcowy zwróci dane statyczne.
transitType	Typ użytkownika transportu publicznego żąda odpowiedniego przystanku tranzytowego jako listy rozdzielanej przecinkami. Jeśli nie zostanie określony, wszystkie będą dozwolone. Ten parametr może być używany tylko w połączeniu z queryType=stop. Obsługiwane typy tranzytowe to Tram, Subway, Rail, Bus, Ferry, CableCar, Gondola, Funicular. Na przykład transitType=Bus,Subway.

Właściwości dziedziczone

abortSignal	Sygnał, który może służyć do przerwania żądań.
customHeaders	{object} [customHeaders] Niestandardowe nagłówki żądań zdefiniowane przez użytkownika, które będą stosowane przed wysłaniem żądania.
onDownloadProgress	Wywołanie zwrotne uruchamiane po postępie pobierania.
onUploadProgress	Wywołanie zwrotne uruchamiane po postępie przekazywania.
timeout	Liczba milisekund, które żądanie może potrwać przed automatycznym zakończeniem.

Szczegóły właściwości

agency

Jeśli wolisz zwracać trasy z określonego zestawu agencji. Określony jako ciąg rozdzielony przecinkami.

agency?: string[]

Wartość właściwości

string[]

agencyType

Określa identyfikator agencji, aby zażądać tras z określonego zestawu agencji do zwrócenia. Domyślnie agencyType=agencyId. Możliwe wartości to: "agencyId", "agencyKey", "agencyName"

agencyType?: AgencyType

Wartość właściwości

AgencyType

language

Język, w którym będą zwracane wyniki wyszukiwania. Obsługiwane jest tylko rozwiązanie NGT. Aby uzyskać szczegółowe informacje, zobacz Obsługiwane języki .

language?: string

Wartość właściwości

string

limit

Maksymalna liczba przyjazdów do powrotu. Jeśli nie zostanie określony, zostanie użyta wartość domyślna systemu. W przypadku przystanków maksymalna liczba przylotów na przystanek. W przypadku linii maksymalna liczba przylotów na przystanek w wierszu. Dla wszystkich innych maksymalnych przyjazdów ogólnie.

limit?: number

Wartość właściwości

number

maxMinutesInFuture

Maksymalny czas (w minutach) w przyszłości do powrotu przyjazdów. Jeśli nie zostanie określony, zostanie użyta domyślna wartość systemowa (30 minut). Wartość minimalna to 0, a maksymalna wartość to 60 minut.

maxMinutesInFuture?: number

Wartość właściwości

number

queryType

Typ parametru zapytania. Definiuje tryb żądania. Obsługiwany jest tylko jeden tryb na żądanie. Domyślnie parametr queryType ma wartość "stop" zwracającą żądaną liczbę przyjazdów na żywo dla wszystkich wierszy przybywających do określonego zatrzymania. Możliwe wartości to: "stop", "line", "lineAndStop", "position"

queryType?: RealTimeArrivalsQueryType

Wartość właściwości

RealTimeArrivalsQueryType

stopQueryType

Typ unikatowego parametru zapytania zatrzymania. Domyślnie stopQueryType=stopId. Ten parametr może być używany tylko w połączeniu z queryType=stop lub queryType=lineAndStop. Możliwe wartości to: "stopId", "stopKey"

stopQueryType?: StopQueryType

Wartość właściwości

StopQueryType

timeoutInSeconds

Czas w sekundach, w ciągu którego dostawca nie odpowiada, punkt końcowy zwróci dane statyczne.

timeoutInSeconds?: number

Wartość właściwości

number

transitType

Typ użytkownika transportu publicznego żąda odpowiedniego przystanku tranzytowego jako listy rozdzielanej przecinkami. Jeśli nie zostanie określony, wszystkie będą dozwolone. Ten parametr może być używany tylko w połączeniu z queryType=stop. Obsługiwane typy tranzytowe to Tram, Subway, Rail, Bus, Ferry, CableCar, Gondola, Funicular. Na przykład transitType=Bus,Subway.

transitType?: TransitTypeFilter[]

Wartość właściwości

TransitTypeFilter[]

Szczegóły właściwości dziedziczonej

abortSignal

Sygnał, który może służyć do przerwania żądań.

abortSignal?: AbortSignalLike

Wartość właściwości

AbortSignalLike

Dziedziczone z RequestOptionsBase.abortSignal

customHeaders

{object} [customHeaders] Niestandardowe nagłówki żądań zdefiniowane przez użytkownika, które będą stosowane przed wysłaniem żądania.

customHeaders?: [key: string]: string

Wartość właściwości

[key: string]: string

Dziedziczone z RequestOptionsBase.customHeaders

onDownloadProgress

Wywołanie zwrotne uruchamiane po postępie pobierania.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Wartość właściwości

(progress: TransferProgressEvent) => void

Dziedziczone z RequestOptionsBase.onDownloadProgress

onUploadProgress

Wywołanie zwrotne uruchamiane po postępie przekazywania.

onUploadProgress?: (progress: TransferProgressEvent) => void

Wartość właściwości

(progress: TransferProgressEvent) => void

Dziedziczone z RequestOptionsBase.onUploadProgress

timeout

Liczba milisekund, które żądanie może potrwać przed automatycznym zakończeniem.

timeout?: number

Wartość właściwości

number

Dziedziczone z RequestOptionsBase.timeout