你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
MobilityGetRealTimeArrivalsPreviewOptionalParams interface
可选参数。
- Extends
-
RequestOptionsBase
属性
agency | 如果希望返回来自特定机构集的路线。 指定为逗号分隔的字符串。 |
agency |
指定要从要返回的特定机构集请求路由的代理标识符。 默认情况下,agencyType=agencyId。 可能的值包括:“agencyId”、“agencyKey”、“agencyName” |
language | 返回搜索结果时使用的语言。 仅支持 NGT。 有关详细信息,请参阅 支持的语言 。 |
limit | 要返回的最大到达数。 如果未指定,将使用系统默认值。 对于 stops,每个站点的最大到达数。 对于行,行上每站的最大到达数。 对于其他所有内容,总到达数上限。 |
max |
) 将来返回到达的最长时间 (分钟。 如果未指定,将使用系统默认 (30 分钟) 。 最小值为 0,最大值为 60 分钟。 |
query |
查询参数的类型。 定义请求的模式。 每个请求仅支持一种模式。 默认情况下,queryType 设置为“stops”,返回到达指定站点的所有行的请求实时到达数。 可能的值包括:“stops”、“line”、“lineAndStop”、“position” |
stop |
停止的唯一查询参数的类型。 默认情况下,stopQueryType=stopId。 此参数只能与 queryType=stops 或 queryType=lineAndStop 一起使用。 可能的值包括:“stopId”、“stopKey” |
timeout |
如果提供程序不响应,则终结点将返回静态数据的时间(以秒为单位)。 |
transit |
公共交通用户的类型正在请求相应的交通站,作为逗号分隔列表。 如果未指定,将允许所有项。 此参数只能与 queryType=stops 一起使用。 支持的交通类型包括有轨电车、地铁、铁路、公共汽车、渡轮、有线电视、贡多拉、索道。 例如,transitType=Bus,Subway。 |
继承属性
abort |
可用于中止请求的信号。 |
custom |
{object}[customHeaders]用户定义的自定义请求标头,将在发送请求之前应用。 |
on |
下载进度时触发的回调。 |
on |
上传进度时触发的回调。 |
timeout | 请求在自动终止之前可以花费的毫秒数。 |
属性详细信息
agency
如果希望返回来自特定机构集的路线。 指定为逗号分隔的字符串。
agency?: string[]
属性值
string[]
agencyType
指定要从要返回的特定机构集请求路由的代理标识符。 默认情况下,agencyType=agencyId。 可能的值包括:“agencyId”、“agencyKey”、“agencyName”
agencyType?: AgencyType
属性值
language
limit
要返回的最大到达数。 如果未指定,将使用系统默认值。 对于 stops,每个站点的最大到达数。 对于行,行上每站的最大到达数。 对于其他所有内容,总到达数上限。
limit?: number
属性值
number
maxMinutesInFuture
) 将来返回到达的最长时间 (分钟。 如果未指定,将使用系统默认 (30 分钟) 。 最小值为 0,最大值为 60 分钟。
maxMinutesInFuture?: number
属性值
number
queryType
查询参数的类型。 定义请求的模式。 每个请求仅支持一种模式。 默认情况下,queryType 设置为“stops”,返回到达指定站点的所有行的请求实时到达数。 可能的值包括:“stops”、“line”、“lineAndStop”、“position”
queryType?: RealTimeArrivalsQueryType
属性值
stopQueryType
停止的唯一查询参数的类型。 默认情况下,stopQueryType=stopId。 此参数只能与 queryType=stops 或 queryType=lineAndStop 一起使用。 可能的值包括:“stopId”、“stopKey”
stopQueryType?: StopQueryType
属性值
timeoutInSeconds
如果提供程序不响应,则终结点将返回静态数据的时间(以秒为单位)。
timeoutInSeconds?: number
属性值
number
transitType
公共交通用户的类型正在请求相应的交通站,作为逗号分隔列表。 如果未指定,将允许所有项。 此参数只能与 queryType=stops 一起使用。 支持的交通类型包括有轨电车、地铁、铁路、公共汽车、渡轮、有线电视、贡多拉、索道。 例如,transitType=Bus,Subway。
transitType?: 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