Share via

MobilityGetTransitRoutePreviewOptionalParams interface

  • Referência
Pacote:
azure-maps-rest

Parâmetros opcionais.

Extends

RequestOptionsBase

Propriedades

agency

Especifica se é necessário preferir rotas de um conjunto específico de agências, se possível; como uma lista separada por vírgulas. Se a viagem válida não for encontrada com a agência preferencial, ou apenas uma com viagens muito longas ou com um grande número de transferências, itinerários com outras agências serão retornados.
agencyType

Especifica o identificador da agência para solicitar rotas de agências preferenciais. Por padrão, agencyType=agencyId. Os valores possíveis incluem: 'agencyId', 'agencyKey', 'agencyName'
bikeType

Tipo de bicicleta da bicicleta. Especifica qual tipo de bicicletas será usada. Se não for especificado, todos serão permitidos. Os valores possíveis incluem: 'privateBike', 'dockedBike'
destinationType

O tipo do destino. Os valores possíveis incluem: 'position', 'stopId', 'stopKey'
language

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

O modo de viagem para a rota solicitada; como lista separada por vírgulas. Se não for especificado, todos os modos serão permitidos. Todos os modos podem não estar disponíveis em todas as áreas metropolitanas. Se a viagem válida não for encontrada, o resultado vazio será retornado.
originType

O tipo da origem. Por padrão originType=position, especificado como uma cadeia de caracteres separada por vírgulas composta por latitude seguida de longitude, por exemplo, "47.641268,-122.125679". Os valores possíveis incluem: 'position', 'stopId', 'stopKey'
routeType

O tipo de rota solicitada. Se não for especificado, 'ideal' será usado. Os valores possíveis incluem: 'ideal', 'leastWalk', 'leastTransfers'
time

A hora da partida ou chegada na hora local no formato ISO (2019-04-05T14:24:18-04:00). Se timeType não for especificado, ele será considerado como 'departure' e hora é a hora local atual no ponto de origem.
timeType

Especifica se a hora significa a hora de partida ou a hora de chegada. Se não estiver definido, o valor padrão será 'departure'. Os valores possíveis incluem: 'arrival', 'departure', 'last'
transitType

Aplicável somente com modeType = publicTransit. Permitir que apenas um conjunto específico de tipos de transporte público (como uma lista separada por vírgulas) seja retornado para a rota. Observe que o transitType solicitado pode não estar disponível para toda a rota. Se não for especificado, todos os modos serão permitidos.

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

Especifica se é necessário preferir rotas de um conjunto específico de agências, se possível; como uma lista separada por vírgulas. Se a viagem válida não for encontrada com a agência preferencial, ou apenas uma com viagens muito longas ou com um grande número de transferências, itinerários com outras agências serão retornados.

agency?: string[]

Valor da propriedade

string[]

agencyType

Especifica o identificador da agência para solicitar rotas de agências preferenciais. Por padrão, agencyType=agencyId. Os valores possíveis incluem: 'agencyId', 'agencyKey', 'agencyName'

agencyType?: AgencyType

Valor da propriedade

AgencyType

bikeType

Tipo de bicicleta da bicicleta. Especifica qual tipo de bicicletas será usada. Se não for especificado, todos serão permitidos. Os valores possíveis incluem: 'privateBike', 'dockedBike'

bikeType?: BikeType

Valor da propriedade

BikeType

destinationType

O tipo do destino. Os valores possíveis incluem: 'position', 'stopId', 'stopKey'

destinationType?: DestinationType

Valor da propriedade

DestinationType

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

modeType

O modo de viagem para a rota solicitada; como lista separada por vírgulas. Se não for especificado, todos os modos serão permitidos. Todos os modos podem não estar disponíveis em todas as áreas metropolitanas. Se a viagem válida não for encontrada, o resultado vazio será retornado.

modeType?: ModeType[]

Valor da propriedade

ModeType[]

originType

O tipo da origem. Por padrão originType=position, especificado como uma cadeia de caracteres separada por vírgulas composta por latitude seguida de longitude, por exemplo, "47.641268,-122.125679". Os valores possíveis incluem: 'position', 'stopId', 'stopKey'

originType?: OriginType

Valor da propriedade

OriginType

routeType

O tipo de rota solicitada. Se não for especificado, 'ideal' será usado. Os valores possíveis incluem: 'ideal', 'leastWalk', 'leastTransfers'

routeType?: TransitRouteType

Valor da propriedade

TransitRouteType

time

A hora da partida ou chegada na hora local no formato ISO (2019-04-05T14:24:18-04:00). Se timeType não for especificado, ele será considerado como 'departure' e hora é a hora local atual no ponto de origem.

time?: string

Valor da propriedade

string

timeType

Especifica se a hora significa a hora de partida ou a hora de chegada. Se não estiver definido, o valor padrão será 'departure'. Os valores possíveis incluem: 'arrival', 'departure', 'last'

timeType?: TimeType

Valor da propriedade

TimeType

transitType

Aplicável somente com modeType = publicTransit. Permitir que apenas um conjunto específico de tipos de transporte público (como uma lista separada por vírgulas) seja retornado para a rota. Observe que o transitType solicitado pode não estar disponível para toda a rota. Se não for especificado, todos os modos serão permitidos.

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