Поделиться через

MobilityGetRealTimeArrivalsPreviewOptionalParams interface

  • Ссылка
Пакет:
azure-maps-rest

Необязательные параметры.

Extends

RequestOptionsBase

Свойства

agency

Если вы предпочитаете возвращать маршруты из определенного набора агентств. Указывается в виде строки, разделенной запятыми.
agencyType

Указывает идентификатор агентства для запроса маршрутов из определенного набора агентств, которые должны быть возвращены. По умолчанию — agencyType=agencyId. Возможные значения: "agencyId", "agencyKey", "agencyName"
language

Язык, на котором будут возвращены результаты поиска. Поддерживается только NGT. Дополнительные сведения см. в статье Поддерживаемые языки .
limit

Максимальное количество возвращаемых поступлений. Если не указано, будет использоваться системное значение по умолчанию. Для остановок максимальное количество прибытий на остановку. Для строк максимальное количество прибытий на остановку линии. Для всего остального максимальное количество прибытий в целом.
maxMinutesInFuture

Максимальное время (в минутах) в будущем для возврата прибытий. Если не указано, будет использоваться системное значение по умолчанию (30 минут). Минимальное значение — 0, а максимальное — 60 минут.
queryType

Тип параметра запроса. Определяет режим запроса. Поддерживается только один режим для каждого запроса. По умолчанию параметр queryType имеет значение "stop", возвращающее требуемое количество поступлений в реальном времени для всех строк, поступающих на указанную остановку. Возможные значения: "stop", "line", "lineAndStop", "position"
stopQueryType

Тип уникального параметра запроса stop. По умолчанию stopQueryType=stopId. Этот параметр можно использовать только в сочетании с queryType=stops или queryType=lineAndStop. Возможные значения: stopId, stopKey.
timeoutInSeconds

Время в секундах, в течение которого, если поставщик не отвечает, конечная точка вернет статические данные.
transitType

Тип пользователя общественного транспорта запрашивает соответствующую транзитную остановку в виде списка, разделенного запятыми. Если не указано, будут разрешены все. Этот параметр можно использовать только в сочетании с queryType=stops. Поддерживаемые типы транзита: трамвай, метро, железная дорога, автобус, паром, канатная дорога, гондола, фуникулер. Например, transitType=Bus,Subway.

Унаследованные свойства

abortSignal

Сигнал, который можно использовать для прерывания запросов.
customHeaders

{object} [customHeaders] Определяемые пользователем пользовательские заголовки запросов, которые будут применены перед отправкой запроса.
onDownloadProgress

Обратный вызов, который срабатывает при скачивании.
onUploadProgress

Обратный вызов, который запускается при выполнении отправки.
timeout

Количество миллисекундах, которые может занять запрос до автоматического завершения.

Сведения о свойстве

agency

Если вы предпочитаете возвращать маршруты из определенного набора агентств. Указывается в виде строки, разделенной запятыми.

agency?: string[]

Значение свойства

string[]

agencyType

Указывает идентификатор агентства для запроса маршрутов из определенного набора агентств, которые должны быть возвращены. По умолчанию — agencyType=agencyId. Возможные значения: "agencyId", "agencyKey", "agencyName"

agencyType?: AgencyType

Значение свойства

AgencyType

language

Язык, на котором будут возвращены результаты поиска. Поддерживается только NGT. Дополнительные сведения см. в статье Поддерживаемые языки .

language?: string

Значение свойства

string

limit

Максимальное количество возвращаемых поступлений. Если не указано, будет использоваться системное значение по умолчанию. Для остановок максимальное количество прибытий на остановку. Для строк максимальное количество прибытий на остановку линии. Для всего остального максимальное количество прибытий в целом.

limit?: number

Значение свойства

number

maxMinutesInFuture

Максимальное время (в минутах) в будущем для возврата прибытий. Если не указано, будет использоваться системное значение по умолчанию (30 минут). Минимальное значение — 0, а максимальное — 60 минут.

maxMinutesInFuture?: number

Значение свойства

number

queryType

Тип параметра запроса. Определяет режим запроса. Поддерживается только один режим для каждого запроса. По умолчанию параметр queryType имеет значение "stop", возвращающее требуемое количество поступлений в реальном времени для всех строк, поступающих на указанную остановку. Возможные значения: "stop", "line", "lineAndStop", "position"

queryType?: RealTimeArrivalsQueryType

Значение свойства

RealTimeArrivalsQueryType

stopQueryType

Тип уникального параметра запроса stop. По умолчанию stopQueryType=stopId. Этот параметр можно использовать только в сочетании с queryType=stops или queryType=lineAndStop. Возможные значения: stopId, stopKey.

stopQueryType?: StopQueryType

Значение свойства

StopQueryType

timeoutInSeconds

Время в секундах, в течение которого, если поставщик не отвечает, конечная точка вернет статические данные.

timeoutInSeconds?: number

Значение свойства

number

transitType

Тип пользователя общественного транспорта запрашивает соответствующую транзитную остановку в виде списка, разделенного запятыми. Если не указано, будут разрешены все. Этот параметр можно использовать только в сочетании с queryType=stops. Поддерживаемые типы транзита: трамвай, метро, железная дорога, автобус, паром, канатная дорога, гондола, фуникулер. Например, transitType=Bus,Subway.

transitType?: TransitTypeFilter[]

Значение свойства

TransitTypeFilter[]

Сведения об унаследованном свойстве

abortSignal

Сигнал, который можно использовать для прерывания запросов.

abortSignal?: AbortSignalLike

Значение свойства

AbortSignalLike

Наследуется от RequestOptionsBase.abortSignal

customHeaders

{object} [customHeaders] Определяемые пользователем пользовательские заголовки запросов, которые будут применены перед отправкой запроса.

customHeaders?: [key: string]: string

Значение свойства

[key: string]: string

Наследуется от RequestOptionsBase.customHeaders

onDownloadProgress

Обратный вызов, который срабатывает при скачивании.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Значение свойства

(progress: TransferProgressEvent) => void

Наследуется от RequestOptionsBase.onDownloadProgress

onUploadProgress

Обратный вызов, который запускается при выполнении отправки.

onUploadProgress?: (progress: TransferProgressEvent) => void

Значение свойства

(progress: TransferProgressEvent) => void

Наследуется от RequestOptionsBase.onUploadProgress

timeout

Количество миллисекундах, которые может занять запрос до автоматического завершения.

timeout?: number

Значение свойства

number

Наследуется от RequestOptionsBase.timeout