MobilityGetTransitRoutePreviewOptionalParams interface
省略可能なパラメーター。
- Extends
-
RequestOptionsBase
プロパティ
agency | 可能であれば、特定の機関のセットからのルートを優先するかどうかを指定します。をコンマ区切りリストとして指定します。 優先代理店で有効な旅行が見つからない場合、または非常に長い旅行または多数の転送がある旅行のみが見つからない場合は、他の機関との旅程が返されます。 |
agency |
優先機関からのルートを要求する代理店識別子を指定します。 既定では、agencyType=agencyId です。 指定できる値は、'agencyId'、'agencyKey'、'agencyName' です。 |
bike |
自転車の種類。 使用する自転車の種類を指定します。 指定しない場合は、すべて許可されます。 使用可能な値は、'privateBike'、'dockedBike' です。 |
destination |
変換先の型。 使用できる値は、'position'、'stopId'、'stopKey' です。 |
language | 検索結果が返される言語。 NGT のみがサポートされています。 詳細については、「 サポートされている言語 」を参照してください。 |
mode |
要求されたルートの移動モード。をコンマ区切りリストとして指定します。 指定しない場合は、すべてのモードが許可されます。 すべてのモードは、すべての地下鉄エリアで使用できない場合があります。 有効なトリップが見つからない場合は、空の結果が返されます。 |
origin |
配信元の型。 既定では、originType=position。緯度と経度で構成されるコンマ区切りの文字列として指定されます(例: "47.641268,-122.125679" など)。 使用できる値は、'position'、'stopId'、'stopKey' です。 |
route |
要求されたルートの種類。 指定しない場合は、'最適' が使用されます。 使用可能な値は、'optimal'、'leastWalk'、'leastTransfers' です。 |
time | ISO 形式の現地時刻 (2019-04-05T14:24:18-04:00) での出発時刻または到着時刻。 timeType が指定されていない場合、"出発" と見なされ、time は原点の現在の現地時刻になります。 |
time |
時刻が出発時刻と到着時刻のどちらを示すかを指定します。 定義されていない場合、既定値は 'departure' です。 使用できる値は、'arrival'、'departure'、'last' です。 |
transit |
modeType = publicTransit でのみ適用できます。 ルートに対して返される公共輸送の種類の特定のセット (コンマ区切りリストとして) のみを許可します。 要求された transitType は、ルート全体で使用できない場合があることに注意してください。 指定しない場合は、すべてのモードが許可されます。 |
継承されたプロパティ
abort |
要求を中止するために使用できるシグナル。 |
custom |
{object}[customHeaders]要求が送信される前に適用されるユーザー定義のカスタム要求ヘッダー。 |
on |
ダウンロードの進行状況時に発生するコールバック。 |
on |
アップロードの進行状況時に発生するコールバック。 |
timeout | 要求が自動的に終了するまでの時間 (ミリ秒)。 |
プロパティの詳細
agency
可能であれば、特定の機関のセットからのルートを優先するかどうかを指定します。をコンマ区切りリストとして指定します。 優先代理店で有効な旅行が見つからない場合、または非常に長い旅行または多数の転送がある旅行のみが見つからない場合は、他の機関との旅程が返されます。
agency?: string[]
プロパティ値
string[]
agencyType
優先機関からのルートを要求する代理店識別子を指定します。 既定では、agencyType=agencyId です。 指定できる値は、'agencyId'、'agencyKey'、'agencyName' です。
agencyType?: AgencyType
プロパティ値
bikeType
自転車の種類。 使用する自転車の種類を指定します。 指定しない場合は、すべて許可されます。 使用可能な値は、'privateBike'、'dockedBike' です。
bikeType?: BikeType
プロパティ値
destinationType
変換先の型。 使用できる値は、'position'、'stopId'、'stopKey' です。
destinationType?: DestinationType
プロパティ値
language
modeType
要求されたルートの移動モード。をコンマ区切りリストとして指定します。 指定しない場合は、すべてのモードが許可されます。 すべてのモードは、すべての地下鉄エリアで使用できない場合があります。 有効なトリップが見つからない場合は、空の結果が返されます。
modeType?: ModeType[]
プロパティ値
ModeType[]
originType
配信元の型。 既定では、originType=position。緯度と経度で構成されるコンマ区切りの文字列として指定されます(例: "47.641268,-122.125679" など)。 使用できる値は、'position'、'stopId'、'stopKey' です。
originType?: OriginType
プロパティ値
routeType
要求されたルートの種類。 指定しない場合は、'最適' が使用されます。 使用可能な値は、'optimal'、'leastWalk'、'leastTransfers' です。
routeType?: TransitRouteType
プロパティ値
time
ISO 形式の現地時刻 (2019-04-05T14:24:18-04:00) での出発時刻または到着時刻。 timeType が指定されていない場合、"出発" と見なされ、time は原点の現在の現地時刻になります。
time?: string
プロパティ値
string
timeType
時刻が出発時刻と到着時刻のどちらを示すかを指定します。 定義されていない場合、既定値は 'departure' です。 使用できる値は、'arrival'、'departure'、'last' です。
timeType?: TimeType
プロパティ値
transitType
modeType = publicTransit でのみ適用できます。 ルートに対して返される公共輸送の種類の特定のセット (コンマ区切りリストとして) のみを許可します。 要求された transitType は、ルート全体で使用できない場合があることに注意してください。 指定しない場合は、すべてのモードが許可されます。
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