Sdílet prostřednictvím

MobilityGetRealTimeArrivalsPreviewOptionalParams interface

  • Reference
Balíček:
azure-maps-rest

Volitelné parametry.

Extends

RequestOptionsBase

Vlastnosti

agency

V případě, že dáváte přednost vrácení tras z konkrétní sady agentur. Zadaný jako řetězec oddělený čárkami.
agencyType

Určuje identifikátor agentury pro vyžádání tras z konkrétní sady agentur, které mají být vráceny. Ve výchozím nastavení je agencyType=agencyId. Mezi možné hodnoty patří: 'agencyId', 'agencyKey', 'agencyName'
language

Jazyk, ve kterém se budou výsledky hledání vracet. Podporuje se jenom NGT. Podrobnosti najdete v tématu Podporované jazyky .
limit

Maximální počet příletů, které se mají vrátit. Pokud není zadaný, použije se výchozí nastavení systému. U zastávek je maximální počet příjezdů na zastávku. Pro řádky maximální počet příchozích na jednu zastávku na lince. Pro všechno ostatní max příjezdy celkově.
maxMinutesInFuture

Maximální doba (v minutách) v budoucnu pro vrácení příletů. Pokud není zadaný, použije se výchozí nastavení systému (30 minut). Minimální hodnota je 0 a maximální hodnota je 60 minut.
queryType

Typ parametru dotazu. Definuje režim požadavku. Podporuje se pouze jeden režim na každou žádost. Ve výchozím nastavení je parametr queryType nastavený na "stop", který vrací požadovaný počet živých příletů pro všechny řádky přicházející na zadanou zastávku. Mezi možné hodnoty patří: "stops", 'line', 'lineAndStop', 'position'
stopQueryType

Typ jedinečného parametru dotazu stop. Ve výchozím nastavení stopQueryType=stopId. Tento parametr lze použít pouze ve spojení s queryType=stops nebo queryType=lineAndStop. Mezi možné hodnoty patří: stopId, stopKey.
timeoutInSeconds

Čas v sekundách, během kterého v případě, že poskytovatel neodpoví, vrátí koncový bod statická data.
transitType

Typ veřejné dopravy, který uživatel žádá o příslušnou veřejnou dopravu v seznamu odděleném čárkami. Pokud není zadaný, budou povoleny všechny. Tento parametr lze použít pouze ve spojení s queryType=stops. Podporované typy dopravy jsou Tramvaj, Metro, Železnice, Autobus, Trajekt, Lanovka, Gondola, Lanovka. Například transitType=Bus,Subway.

Zděděné vlastnosti

abortSignal

Signál, který lze použít k přerušení požadavků.
customHeaders

{object} [customHeaders] Vlastní hlavičky požadavků definované uživatelem, které se použijí před odesláním požadavku.
onDownloadProgress

Zpětné volání, které se aktivuje při stahování.
onUploadProgress

Zpětné volání, které se aktivuje při průběhu nahrávání.
timeout

Počet milisekund, které může požadavek trvat, než se automaticky ukončí.

Podrobnosti vlastnosti

agency

V případě, že dáváte přednost vrácení tras z konkrétní sady agentur. Zadaný jako řetězec oddělený čárkami.

agency?: string[]

Hodnota vlastnosti

string[]

agencyType

Určuje identifikátor agentury pro vyžádání tras z konkrétní sady agentur, které mají být vráceny. Ve výchozím nastavení je agencyType=agencyId. Mezi možné hodnoty patří: 'agencyId', 'agencyKey', 'agencyName'

agencyType?: AgencyType

Hodnota vlastnosti

AgencyType

language

Jazyk, ve kterém se budou výsledky hledání vracet. Podporuje se jenom NGT. Podrobnosti najdete v tématu Podporované jazyky .

language?: string

Hodnota vlastnosti

string

limit

Maximální počet příletů, které se mají vrátit. Pokud není zadaný, použije se výchozí nastavení systému. U zastávek je maximální počet příjezdů na zastávku. Pro řádky maximální počet příchozích na jednu zastávku na lince. Pro všechno ostatní max příjezdy celkově.

limit?: number

Hodnota vlastnosti

number

maxMinutesInFuture

Maximální doba (v minutách) v budoucnu pro vrácení příletů. Pokud není zadaný, použije se výchozí nastavení systému (30 minut). Minimální hodnota je 0 a maximální hodnota je 60 minut.

maxMinutesInFuture?: number

Hodnota vlastnosti

number

queryType

Typ parametru dotazu. Definuje režim požadavku. Podporuje se pouze jeden režim na každou žádost. Ve výchozím nastavení je parametr queryType nastavený na "stop", který vrací požadovaný počet živých příletů pro všechny řádky přicházející na zadanou zastávku. Mezi možné hodnoty patří: "stops", 'line', 'lineAndStop', 'position'

queryType?: RealTimeArrivalsQueryType

Hodnota vlastnosti

RealTimeArrivalsQueryType

stopQueryType

Typ jedinečného parametru dotazu stop. Ve výchozím nastavení stopQueryType=stopId. Tento parametr lze použít pouze ve spojení s queryType=stops nebo queryType=lineAndStop. Mezi možné hodnoty patří: stopId, stopKey.

stopQueryType?: StopQueryType

Hodnota vlastnosti

StopQueryType

timeoutInSeconds

Čas v sekundách, během kterého v případě, že poskytovatel neodpoví, vrátí koncový bod statická data.

timeoutInSeconds?: number

Hodnota vlastnosti

number

transitType

Typ veřejné dopravy, který uživatel žádá o příslušnou veřejnou dopravu v seznamu odděleném čárkami. Pokud není zadaný, budou povoleny všechny. Tento parametr lze použít pouze ve spojení s queryType=stops. Podporované typy dopravy jsou Tramvaj, Metro, Železnice, Autobus, Trajekt, Lanovka, Gondola, Lanovka. Například transitType=Bus,Subway.

transitType?: TransitTypeFilter[]

Hodnota vlastnosti

TransitTypeFilter[]

Podrobnosti zděděných vlastností

abortSignal

Signál, který lze použít k přerušení požadavků.

abortSignal?: AbortSignalLike

Hodnota vlastnosti

AbortSignalLike

Zděděno z RequestOptionsBase.abortSignal

customHeaders

{object} [customHeaders] Vlastní hlavičky požadavků definované uživatelem, které se použijí před odesláním požadavku.

customHeaders?: [key: string]: string

Hodnota vlastnosti

[key: string]: string

Zděděno z RequestOptionsBase.customHeaders

onDownloadProgress

Zpětné volání, které se aktivuje při stahování.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Hodnota vlastnosti

(progress: TransferProgressEvent) => void

Zděděno z RequestOptionsBase.onDownloadProgress

onUploadProgress

Zpětné volání, které se aktivuje při průběhu nahrávání.

onUploadProgress?: (progress: TransferProgressEvent) => void

Hodnota vlastnosti

(progress: TransferProgressEvent) => void

Zděděno z RequestOptionsBase.onUploadProgress

timeout

Počet milisekund, které může požadavek trvat, než se automaticky ukončí.

timeout?: number

Hodnota vlastnosti

number

Zděděno z RequestOptionsBase.timeout