MobilityGetRealTimeArrivalsPreviewOptionalParams interface

Pacote:

azure-maps-rest

Parâmetros Opcionais.

Extends

RequestOptionsBase

Propriedades

agency	Caso prefira que as rotas de um conjunto específico de agências sejam devolvidas. Especificado como uma cadeia separada por vírgulas.
agencyType	Especifica o identificador da agência para pedir rotas de um conjunto específico de agências a serem devolvidas. Por predefinição, agencyType=agencyId. Os valores possíveis incluem: "agencyId", "agencyKey", "agencyName"
language	Idioma no qual os resultados da pesquisa serão devolvidos. Apenas a NGT é suportada. Veja idiomas suportados para obter detalhes.
limit	As chegadas máximas a devolver. Se não for especificado, será utilizada a predefinição do sistema. Para paragens, o número máximo de chegadas por paragem. Para as linhas com o máximo de chegadas por paragem na linha. Para tudo o resto, o máximo de chegadas em geral.
maxMinutesInFuture	O tempo máximo (em minutos) no futuro para o qual pretende devolver chegadas. Se não for especificado, será utilizada a predefinição do sistema (30 minutos). O valor mínimo é 0 e o valor máximo é 60 minutos.
queryType	O tipo do parâmetro de consulta. Define o modo do pedido. Só é suportado um modo por pedido. Por predefinição, queryType está definido como "para" devolvendo o número pedido de Chegadas em Direto para todas as linhas que chegam à paragem especificada. Os valores possíveis incluem: "stops", "line", "lineAndStop", "position"
stopQueryType	O tipo do parâmetro de consulta exclusivo da paragem. Por predefinição, stopQueryType=stopId. Este parâmetro só pode ser utilizado em conjunto com queryType=stops ou queryType=lineAndStop. Os valores possíveis incluem: "stopId", "stopKey"
timeoutInSeconds	Tempo em segundos em que, se o fornecedor não responder, o ponto final devolverá dados estáticos.
transitType	O tipo de utilizador de trânsito público está a pedir a respetiva paragem de trânsito, como uma lista separada por vírgulas. Se não for especificado, todos serão permitidos. Este parâmetro só pode ser utilizado em conjunto com queryType=stops. Os tipos de trânsito suportados são Tram, Metro, Rail, Bus, Ferry, CableCar, Gondola, Funicular. Por exemplo, transitType=Bus,Metro.

Propriedades Herdadas

abortSignal	O sinal que pode ser utilizado para abortar pedidos.
customHeaders	{object} [customHeaders] Cabeçalhos de pedido personalizados definidos pelo utilizador que serão aplicados antes do pedido ser enviado.
onDownloadProgress	Chamada de retorno que é acionada após o progresso da transferência.
onUploadProgress	Chamada de retorno que é acionada após o progresso do carregamento.
timeout	O número de milissegundos que um pedido pode tomar antes de ser terminado automaticamente.

Detalhes de Propriedade

agency

Caso prefira que as rotas de um conjunto específico de agências sejam devolvidas. Especificado como uma cadeia separada por vírgulas.

agency?: string[]

Valor de Propriedade

string[]

agencyType

Especifica o identificador da agência para pedir rotas de um conjunto específico de agências a serem devolvidas. Por predefinição, agencyType=agencyId. Os valores possíveis incluem: "agencyId", "agencyKey", "agencyName"

agencyType?: AgencyType

Valor de Propriedade

AgencyType

language

Idioma no qual os resultados da pesquisa serão devolvidos. Apenas a NGT é suportada. Veja idiomas suportados para obter detalhes.

language?: string

Valor de Propriedade

string

limit

As chegadas máximas a devolver. Se não for especificado, será utilizada a predefinição do sistema. Para paragens, o número máximo de chegadas por paragem. Para as linhas com o máximo de chegadas por paragem na linha. Para tudo o resto, o máximo de chegadas em geral.

limit?: number

Valor de Propriedade

number

maxMinutesInFuture

O tempo máximo (em minutos) no futuro para o qual pretende devolver chegadas. Se não for especificado, será utilizada a predefinição do sistema (30 minutos). O valor mínimo é 0 e o valor máximo é 60 minutos.

maxMinutesInFuture?: number

Valor de Propriedade

number

queryType

O tipo do parâmetro de consulta. Define o modo do pedido. Só é suportado um modo por pedido. Por predefinição, queryType está definido como "para" devolvendo o número pedido de Chegadas em Direto para todas as linhas que chegam à paragem especificada. Os valores possíveis incluem: "stops", "line", "lineAndStop", "position"

queryType?: RealTimeArrivalsQueryType

Valor de Propriedade

RealTimeArrivalsQueryType

stopQueryType

O tipo do parâmetro de consulta exclusivo da paragem. Por predefinição, stopQueryType=stopId. Este parâmetro só pode ser utilizado em conjunto com queryType=stops ou queryType=lineAndStop. Os valores possíveis incluem: "stopId", "stopKey"

stopQueryType?: StopQueryType

Valor de Propriedade

StopQueryType

timeoutInSeconds

Tempo em segundos em que, se o fornecedor não responder, o ponto final devolverá dados estáticos.

timeoutInSeconds?: number

Valor de Propriedade

number

transitType

O tipo de utilizador de trânsito público está a pedir a respetiva paragem de trânsito, como uma lista separada por vírgulas. Se não for especificado, todos serão permitidos. Este parâmetro só pode ser utilizado em conjunto com queryType=stops. Os tipos de trânsito suportados são Tram, Metro, Rail, Bus, Ferry, CableCar, Gondola, Funicular. Por exemplo, transitType=Bus,Metro.

transitType?: TransitTypeFilter[]

Valor de Propriedade

TransitTypeFilter[]

Detalhes da Propriedade Herdada

abortSignal

O sinal que pode ser utilizado para abortar pedidos.

abortSignal?: AbortSignalLike

Valor de Propriedade

AbortSignalLike

Herdado de RequestOptionsBase.abortSignal

customHeaders

{object} [customHeaders] Cabeçalhos de pedido personalizados definidos pelo utilizador que serão aplicados antes do pedido ser enviado.

customHeaders?: [key: string]: string

Valor de Propriedade

[key: string]: string

Herdado de RequestOptionsBase.customHeaders

onDownloadProgress

Chamada de retorno que é acionada após o progresso da transferência.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valor de Propriedade

(progress: TransferProgressEvent) => void

Herdado de RequestOptionsBase.onDownloadProgress

onUploadProgress

Chamada de retorno que é acionada após o progresso do carregamento.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valor de Propriedade

(progress: TransferProgressEvent) => void

Herdado de RequestOptionsBase.onUploadProgress

timeout

O número de milissegundos que um pedido pode tomar antes de ser terminado automaticamente.

timeout?: number

Valor de Propriedade

number

Herdado de RequestOptionsBase.timeout