次の方法で共有

MobilityGetRealTimeArrivalsPreviewOptionalParams interface

  • リファレンス
パッケージ:
azure-maps-rest

省略可能なパラメーター。

Extends

RequestOptionsBase

プロパティ

agency

特定の機関のセットからのルートを返す必要がある場合。 コンマ区切り文字列として指定します。
agencyType

返される特定の機関セットからのルートを要求する機関識別子を指定します。 既定では、agencyType=agencyId です。 使用できる値は、'agencyId'、'agencyKey'、'agencyName' です。
language

検索結果が返される言語。 NGT のみがサポートされています。 詳細については、「 サポートされている言語 」を参照してください。
limit

返される最大到着数。 指定しない場合は、システムの既定値が使用されます。 ストップの場合、1 ストップあたりの最大到着数。 ラインの場合、ライン上のストップあたりの最大到着数。 それ以外の場合は、全体的に最大の到着。
maxMinutesInFuture

到着を返す最大時間 (分)。 指定しない場合は、システムの既定値 (30 分) が使用されます。 最小値は 0 で、最大値は 60 分です。
queryType

クエリ パラメーターの型。 要求のモードを定義します。 要求ごとに 1 つのモードのみがサポートされます。 既定では、queryType は 'stop' に設定され、指定されたストップに到着するすべての行に対して要求されたライブ到着数が返されます。 指定できる値は、'stops'、'line'、'lineAndStop'、'position' です。
stopQueryType

ストップの一意のクエリ パラメーターの型。 既定では、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

返される最大到着数。 指定しない場合は、システムの既定値が使用されます。 ストップの場合、1 ストップあたりの最大到着数。 ラインの場合、ライン上のストップあたりの最大到着数。 それ以外の場合は、全体的に最大の到着。

limit?: number

プロパティ値

number

maxMinutesInFuture

到着を返す最大時間 (分)。 指定しない場合は、システムの既定値 (30 分) が使用されます。 最小値は 0 で、最大値は 60 分です。

maxMinutesInFuture?: number

プロパティ値

number

queryType

クエリ パラメーターの型。 要求のモードを定義します。 要求ごとに 1 つのモードのみがサポートされます。 既定では、queryType は 'stop' に設定され、指定されたストップに到着するすべての行に対して要求されたライブ到着数が返されます。 指定できる値は、'stops'、'line'、'lineAndStop'、'position' です。

queryType?: RealTimeArrivalsQueryType

プロパティ値

RealTimeArrivalsQueryType

stopQueryType

ストップの一意のクエリ パラメーターの型。 既定では、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