MobilityGetTransitRoutePreviewOptionalParams interface

Pacote:

azure-maps-rest

Parâmetros Opcionais.

Extends

RequestOptionsBase

Propriedades

agency	Especifica se deve 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 preferida, ou apenas uma com viagens muito longas ou com um grande número de transferências, serão devolvidos itinerários com outras agências.
agencyType	Especifica o identificador da agência para pedir rotas a agências preferenciais. Por predefinição, agencyType=agencyId. Os valores possíveis incluem: "agencyId", "agencyKey", "agencyName"
bikeType	Tipo de bicicleta da bicicleta. Especifica que tipo de bicicletas serão utilizadas. Se não for especificado, todos serão permitidos. Os valores possíveis incluem: "privateBike", "dockedBike"
destinationType	O tipo de destino. Os valores possíveis incluem: "position", "stopId", "stopKey"
language	Idioma no qual os resultados da pesquisa serão devolvidos. Apenas o NGT é suportado. Consulte idiomas suportados para obter detalhes.
modeType	O modo de viagem para a rota pedida; 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 de metro. Se não for encontrada uma viagem válida, será devolvido o resultado vazio.
originType	O tipo de origem. Por predefinição originType=position, especificada como uma cadeia separada por vírgulas composta pela latitude seguida de longitude, por exemplo, "47.641268,-122.125679". Os valores possíveis incluem: "position", "stopId", "stopKey"
routeType	O tipo de rota pedida. Se não for especificado, será utilizado "ideal". Os valores possíveis incluem: "ideal", "leastWalk", "leastTransfers"
time	A hora de partida ou chegada na hora local no formato ISO (2019-04-05T14:24:18-04:00). Se timeType não for especificado, será assumido como "partida" e a 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 predefinido é "partida". Os valores possíveis incluem: "chegada", "partida", "último"
transitType	Aplicável apenas com modeType = publicTransit. Permitir que apenas um conjunto específico de tipos de trânsito público (como uma lista separada por vírgulas) seja devolvido para a rota. Tenha em atenção que o transitType pedido 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 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

Especifica se deve 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 preferida, ou apenas uma com viagens muito longas ou com um grande número de transferências, serão devolvidos itinerários com outras agências.

agency?: string[]

Valor de Propriedade

string[]

agencyType

Especifica o identificador da agência para pedir rotas a agências preferenciais. Por predefinição, agencyType=agencyId. Os valores possíveis incluem: "agencyId", "agencyKey", "agencyName"

agencyType?: AgencyType

Valor de Propriedade

AgencyType

bikeType

Tipo de bicicleta da bicicleta. Especifica que tipo de bicicletas serão utilizadas. Se não for especificado, todos serão permitidos. Os valores possíveis incluem: "privateBike", "dockedBike"

bikeType?: BikeType

Valor de Propriedade

BikeType

destinationType

O tipo de destino. Os valores possíveis incluem: "position", "stopId", "stopKey"

destinationType?: DestinationType

Valor de Propriedade

DestinationType

language

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

language?: string

Valor de Propriedade

string

modeType

O modo de viagem para a rota pedida; 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 de metro. Se não for encontrada uma viagem válida, será devolvido o resultado vazio.

modeType?: ModeType[]

Valor de Propriedade

ModeType[]

originType

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

originType?: OriginType

Valor de Propriedade

OriginType

routeType

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

routeType?: TransitRouteType

Valor de Propriedade

TransitRouteType

time

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

time?: string

Valor de Propriedade

string

timeType

Especifica se a hora significa a hora de partida ou a hora de chegada. Se não estiver definido, o valor predefinido é "partida". Os valores possíveis incluem: "chegada", "partida", "último"

timeType?: TimeType

Valor de Propriedade

TimeType

transitType

Aplicável apenas com modeType = publicTransit. Permitir que apenas um conjunto específico de tipos de trânsito público (como uma lista separada por vírgulas) seja devolvido para a rota. Tenha em atenção que o transitType pedido pode não estar disponível para toda a rota. Se não for especificado, todos os modos serão permitidos.

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