Share via

MobilityGetRealTimeArrivalsPreviewOptionalParams interface

  • Referência
Pacote:
azure-maps-rest

Parâmetros opcionais.

Extends

RequestOptionsBase

Propriedades

agency

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

Especifica o identificador da agência para solicitar rotas de um conjunto específico de agências a serem retornadas. Por padrão, agencyType=agencyId. Os valores possíveis incluem: 'agencyId', 'agencyKey', 'agencyName'
language

Idioma no qual os resultados da pesquisa serão retornados. Há suporte apenas para NGT. Consulte Idiomas com suporte para obter detalhes.
limit

As chegadas máximas a serem retornadas. Se não for especificado, o padrão do sistema será usado. Para para o número máximo de chegadas por parada. Para as chegadas máximas de linhas por parada na linha. Para todo o resto, o máximo de chegadas é geral.
maxMinutesInFuture

O tempo máximo (em minutos) no futuro para o qual retornar as chegadas. Se não for especificado, o padrão do sistema (30 minutos) será usado. O valor mínimo é 0 e o valor máximo é 60 minutos.
queryType

O tipo do parâmetro de consulta. Define o modo da solicitação. Há suporte para apenas um modo por solicitação. Por padrão, queryType é definido como 'stops' retornando o número solicitado de Live Arrivals para todas as linhas que chegam à parada especificada. Os valores possíveis incluem: 'stops', 'line', 'lineAndStop', 'position'
stopQueryType

O tipo do parâmetro de consulta exclusivo da parada. Por padrão, stopQueryType=stopId. Esse parâmetro só pode ser usado em conjunto com queryType=stops ou queryType=lineAndStop. Os valores possíveis incluem: 'stopId', 'stopKey'
timeoutInSeconds

Tempo em segundos em que, se o provedor não responder, o ponto de extremidade retornará dados estáticos.
transitType

O tipo de usuário de transporte público está solicitando a respectiva parada de trânsito, como uma lista separada por vírgulas. Se não for especificado, todos serão permitidos. Esse parâmetro só pode ser usado em conjunto com queryType=stops. Os tipos de trânsito com suporte são Bonde, Metrô, Trilho, Ônibus, Balsa, CableCar, Gôndola, Funicular. Por exemplo, transitType=Bus,Subway.

Propriedades herdadas

abortSignal

O sinal que pode ser usado para anular solicitações.
customHeaders

{object} [customHeaders] Cabeçalhos de solicitação personalizados definidos pelo usuário que serão aplicados antes do envio da solicitação.
onDownloadProgress

Retorno de chamada que é disparado após o progresso do download.
onUploadProgress

Retorno de chamada que é disparado após o progresso do upload.
timeout

O número de milissegundos que uma solicitação pode levar antes de ser encerrada automaticamente.

Detalhes da propriedade

agency

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

agency?: string[]

Valor da propriedade

string[]

agencyType

Especifica o identificador da agência para solicitar rotas de um conjunto específico de agências a serem retornadas. Por padrão, agencyType=agencyId. Os valores possíveis incluem: 'agencyId', 'agencyKey', 'agencyName'

agencyType?: AgencyType

Valor da propriedade

AgencyType

language

Idioma no qual os resultados da pesquisa serão retornados. Há suporte apenas para NGT. Consulte Idiomas com suporte para obter detalhes.

language?: string

Valor da propriedade

string

limit

As chegadas máximas a serem retornadas. Se não for especificado, o padrão do sistema será usado. Para para o número máximo de chegadas por parada. Para as chegadas máximas de linhas por parada na linha. Para todo o resto, o máximo de chegadas é geral.

limit?: number

Valor da propriedade

number

maxMinutesInFuture

O tempo máximo (em minutos) no futuro para o qual retornar as chegadas. Se não for especificado, o padrão do sistema (30 minutos) será usado. O valor mínimo é 0 e o valor máximo é 60 minutos.

maxMinutesInFuture?: number

Valor da propriedade

number

queryType

O tipo do parâmetro de consulta. Define o modo da solicitação. Há suporte para apenas um modo por solicitação. Por padrão, queryType é definido como 'stops' retornando o número solicitado de Live Arrivals para todas as linhas que chegam à parada especificada. Os valores possíveis incluem: 'stops', 'line', 'lineAndStop', 'position'

queryType?: RealTimeArrivalsQueryType

Valor da propriedade

RealTimeArrivalsQueryType

stopQueryType

O tipo do parâmetro de consulta exclusivo da parada. Por padrão, stopQueryType=stopId. Esse parâmetro só pode ser usado em conjunto com queryType=stops ou queryType=lineAndStop. Os valores possíveis incluem: 'stopId', 'stopKey'

stopQueryType?: StopQueryType

Valor da propriedade

StopQueryType

timeoutInSeconds

Tempo em segundos em que, se o provedor não responder, o ponto de extremidade retornará dados estáticos.

timeoutInSeconds?: number

Valor da propriedade

number

transitType

O tipo de usuário de transporte público está solicitando a respectiva parada de trânsito, como uma lista separada por vírgulas. Se não for especificado, todos serão permitidos. Esse parâmetro só pode ser usado em conjunto com queryType=stops. Os tipos de trânsito com suporte são Bonde, Metrô, Trilho, Ônibus, Balsa, CableCar, Gôndola, Funicular. Por exemplo, transitType=Bus,Subway.

transitType?: TransitTypeFilter[]

Valor da propriedade

TransitTypeFilter[]

Detalhes das propriedades herdadas

abortSignal

O sinal que pode ser usado para anular solicitações.

abortSignal?: AbortSignalLike

Valor da propriedade

AbortSignalLike

Herdado de RequestOptionsBase.abortSignal

customHeaders

{object} [customHeaders] Cabeçalhos de solicitação personalizados definidos pelo usuário que serão aplicados antes do envio da solicitação.

customHeaders?: [key: string]: string

Valor da propriedade

[key: string]: string

Herdado de RequestOptionsBase.customHeaders

onDownloadProgress

Retorno de chamada que é disparado após o progresso do download.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valor da propriedade

(progress: TransferProgressEvent) => void

Herdado de RequestOptionsBase.onDownloadProgress

onUploadProgress

Retorno de chamada que é disparado após o progresso do upload.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valor da propriedade

(progress: TransferProgressEvent) => void

Herdado de RequestOptionsBase.onUploadProgress

timeout

O número de milissegundos que uma solicitação pode levar antes de ser encerrada automaticamente.

timeout?: number

Valor da propriedade

number

Herdado de RequestOptionsBase.timeout