MobilityGetRealTimeArrivalsPreviewOptionalParams interface

Paquete:

azure-maps-rest

Parámetros opcionales

Extends

RequestOptionsBase

Propiedades

agency	En caso de que prefiera rutas de un conjunto específico de agencias que se van a devolver. Se especifica como una cadena separada por comas.
agencyType	Especifica el identificador de agencia para solicitar rutas de un conjunto específico de agencias que se van a devolver. De forma predeterminada, agencyType=agencyId. Entre los valores posibles se incluyen: 'agencyId', 'agencyKey', 'agencyName'
language	Idioma en el que se devolverán los resultados de búsqueda. Solo se admite NGT. Consulte Idiomas admitidos para obtener más información.
limit	Las llegadas máximas que se van a devolver. Si no se especifica, se usará el valor predeterminado del sistema. Para paradas número máximo de llegadas por parada. Para las líneas máximas de llegadas por parada en la línea. Para todo lo demás, máximo de llegadas en general.
maxMinutesInFuture	El tiempo máximo (en minutos) en el futuro para devolver las llegadas. Si no se especifica, se usará el valor predeterminado del sistema (30 minutos). El valor mínimo es 0 y el valor máximo es de 60 minutos.
queryType	Tipo del parámetro de consulta. Define el modo de la solicitud. Solo se admite un modo por solicitud. De forma predeterminada, queryType se establece en "stop" que devuelve el número solicitado de llegadas activas para todas las líneas que llegan a la parada especificada. Entre los valores posibles se incluyen: 'stops', 'line', 'lineAndStop', 'position'
stopQueryType	Tipo del parámetro de consulta único de la detención. De forma predeterminada, stopQueryType=stopId. Este parámetro solo se puede usar junto con queryType=stops o queryType=lineAndStop. Entre los valores posibles se incluyen: 'stopId', 'stopKey'
timeoutInSeconds	Tiempo en segundos en el que, si el proveedor no responde, el punto de conexión devolverá datos estáticos.
transitType	El tipo de usuario de transporte público solicita la parada de tránsito correspondiente, como una lista separada por comas. Si no se especifica, se permitirán todos. Este parámetro solo se puede usar junto con queryType=stops. Los tipos de tránsito admitidos son Tranvía, Metro, Rail, Bus, Ferry, CableCar, Gondola, Funicular. Por ejemplo, transitType=Bus,Subway.

Propiedades heredadas

abortSignal	Señal que se puede usar para anular las solicitudes.
customHeaders	{object} [customHeaders] Encabezados de solicitud personalizados definidos por el usuario que se aplicarán antes de enviar la solicitud.
onDownloadProgress	Devolución de llamada que se activa tras el progreso de la descarga.
onUploadProgress	Devolución de llamada que se activa tras el progreso de la carga.
timeout	El número de milisegundos que una solicitud puede realizar antes de finalizarse automáticamente.

Detalles de las propiedades

agency

En caso de que prefiera rutas de un conjunto específico de agencias que se van a devolver. Se especifica como una cadena separada por comas.

agency?: string[]

Valor de propiedad

string[]

agencyType

Especifica el identificador de agencia para solicitar rutas de un conjunto específico de agencias que se van a devolver. De forma predeterminada, agencyType=agencyId. Entre los valores posibles se incluyen: 'agencyId', 'agencyKey', 'agencyName'

agencyType?: AgencyType

Valor de propiedad

AgencyType

language

Idioma en el que se devolverán los resultados de búsqueda. Solo se admite NGT. Consulte Idiomas admitidos para obtener más información.

language?: string

Valor de propiedad

string

limit

Las llegadas máximas que se van a devolver. Si no se especifica, se usará el valor predeterminado del sistema. Para paradas número máximo de llegadas por parada. Para las líneas máximas de llegadas por parada en la línea. Para todo lo demás, máximo de llegadas en general.

limit?: number

Valor de propiedad

number

maxMinutesInFuture

El tiempo máximo (en minutos) en el futuro para devolver las llegadas. Si no se especifica, se usará el valor predeterminado del sistema (30 minutos). El valor mínimo es 0 y el valor máximo es de 60 minutos.

maxMinutesInFuture?: number

Valor de propiedad

number

queryType

Tipo del parámetro de consulta. Define el modo de la solicitud. Solo se admite un modo por solicitud. De forma predeterminada, queryType se establece en "stop" que devuelve el número solicitado de llegadas activas para todas las líneas que llegan a la parada especificada. Entre los valores posibles se incluyen: 'stops', 'line', 'lineAndStop', 'position'

queryType?: RealTimeArrivalsQueryType

Valor de propiedad

RealTimeArrivalsQueryType

stopQueryType

Tipo del parámetro de consulta único de la detención. De forma predeterminada, stopQueryType=stopId. Este parámetro solo se puede usar junto con queryType=stops o queryType=lineAndStop. Entre los valores posibles se incluyen: 'stopId', 'stopKey'

stopQueryType?: StopQueryType

Valor de propiedad

StopQueryType

timeoutInSeconds

Tiempo en segundos en el que, si el proveedor no responde, el punto de conexión devolverá datos estáticos.

timeoutInSeconds?: number

Valor de propiedad

number

transitType

El tipo de usuario de transporte público solicita la parada de tránsito correspondiente, como una lista separada por comas. Si no se especifica, se permitirán todos. Este parámetro solo se puede usar junto con queryType=stops. Los tipos de tránsito admitidos son Tranvía, Metro, Rail, Bus, Ferry, CableCar, Gondola, Funicular. Por ejemplo, transitType=Bus,Subway.

transitType?: TransitTypeFilter[]

Valor de propiedad

TransitTypeFilter[]

Detalles de las propiedades heredadas

abortSignal

Señal que se puede usar para anular las solicitudes.

abortSignal?: AbortSignalLike

Valor de propiedad

AbortSignalLike

Heredado de RequestOptionsBase.abortSignal

customHeaders

{object} [customHeaders] Encabezados de solicitud personalizados definidos por el usuario que se aplicarán antes de enviar la solicitud.

customHeaders?: [key: string]: string

Valor de propiedad

[key: string]: string

Heredado de RequestOptionsBase.customHeaders

onDownloadProgress

Devolución de llamada que se activa tras el progreso de la descarga.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valor de propiedad

(progress: TransferProgressEvent) => void

Heredado de RequestOptionsBase.onDownloadProgress

onUploadProgress

Devolución de llamada que se activa tras el progreso de la carga.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valor de propiedad

(progress: TransferProgressEvent) => void

Heredado de RequestOptionsBase.onUploadProgress

timeout

El número de milisegundos que una solicitud puede realizar antes de finalizarse automáticamente.

timeout?: number

Valor de propiedad

number

Heredado de RequestOptionsBase.timeout