Interface
Properties
Property | Type | Notes |
---|---|---|
authentication inherited | string | IAuthenticationManager | The instance of |
barriers | IFeatureSet | ILocation | IPoint | [void, void][] | |
credentials inherited | RequestCredentials | A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows. |
destinations | IFeatureSet | ILocation | IPoint | [void, void][] | Specify the ending point locations to travel to from the origins. |
endpoint inherited | string | Any ArcGIS Routing service (example: https://sampleserver3.arcgisonline.com/ArcGIS/rest/services/Network/USA/NAServer/Route/ ) to use for the routing service request. |
headers inherited | { [key: string]: any } | Additional Headers to pass into the request. |
hideToken inherited | boolean | Prevents the token from being passed in a URL Query param that is saved in browser history. Instead, the token will be passed in POST request body or through X-Esri-Authorization header. NOTE: This will force POST requests in browsers since auth header is not yet supported by preflight OPTIONS check with CORS. |
httpMethod inherited | HTTPMethods | The HTTP method to send the request with. |
maxUrlLength inherited | number | If the length of a GET request's URL exceeds |
origins | IFeatureSet | ILocation | IPoint | [void, void][] | Specify the starting points from which to travel to the destinations. |
outputType | "esriNAODOutputSparseMatrix" | "esriNAODOutputStraightLines" | "esriNAODOutputNoLines" | Specify the type of output returned by the service. Defaults to "esriNAODOutputSparseMatrix". |
params inherited | IParams | Additional parameters to pass in the request. |
polygonBarriers | IFeatureSet | |
polylineBarriers | IFeatureSet | |
portal inherited | string | Base url for the portal you want to make the request to. Defaults to authentication.portal if authentication exists, otherwise to 'https://www.arcgis.com/sharing/rest'. |
rawResponse inherited | boolean | Return the raw response |
returnBarriers | boolean | |
returnDestinations | boolean | |
returnOrigins | boolean | |
returnPolygonBarriers | boolean | |
returnPolylineBarriers | boolean | |
signal inherited | AbortSignal | An AbortSignal object instance; allows you to abort a request and via an AbortController. |
suppressWarnings inherited | boolean | Suppress any ArcGIS REST JS related warnings for this request. |
authentication
authentication: string | IAuthenticationManager
The instance of ArcGISIdentityManager
, ApplicationCredentialsManager
or APIKeyManager
to use to authenticate this request. A token may also be passed directly as a string however using the built in authentication managers is encouraged.
barriers
barriers: IFeatureSet | ILocation | IPoint | [void, void][]
credentials
credentials: RequestCredentials
A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.
destinations
Interface Propertydestinations: IFeatureSet | ILocation | IPoint | [void, void][]
Specify the ending point locations to travel to from the origins.
endpoint
endpoint: string
Any ArcGIS Routing service (example: https://sampleserver3.arcgisonline.com/ArcGIS/rest/services/Network/USA/NAServer/Route/ ) to use for the routing service request.
headers
headers: { [key: string]: any }
Additional Headers to pass into the request.
Type declaration
- [key: string]: any
hideToken
hideToken: boolean
Prevents the token from being passed in a URL Query param that is saved in browser history. Instead, the token will be passed in POST request body or through X-Esri-Authorization header. NOTE: This will force POST requests in browsers since auth header is not yet supported by preflight OPTIONS check with CORS.
httpMethod
httpMethod: HTTPMethods
The HTTP method to send the request with.
maxUrlLength
maxUrlLength: number
If the length of a GET request's URL exceeds maxUrlLength
the request will use POST instead.
origins
Interface Propertyorigins: IFeatureSet | ILocation | IPoint | [void, void][]
Specify the starting points from which to travel to the destinations.
outputType
outputType: "esriNAODOutputSparseMatrix" | "esriNAODOutputStraightLines" | "esriNAODOutputNoLines"
Specify the type of output returned by the service. Defaults to "esriNAODOutputSparseMatrix".
polygonBarriers
polygonBarriers: IFeatureSet
polylineBarriers
polylineBarriers: IFeatureSet
portal
portal: string
Base url for the portal you want to make the request to. Defaults to authentication.portal if authentication exists, otherwise to 'https://www.arcgis.com/sharing/rest'.
signal
signal: AbortSignal
An AbortSignal object instance; allows you to abort a request and via an AbortController.
suppressWarnings
suppressWarnings: boolean
Suppress any ArcGIS REST JS related warnings for this request.
Methods
Method | Returns | Notes |
---|---|---|
request(url, requestOptions) inherited | Promise<any> | Override the default function for making the request. This is mainly useful for testing purposes (i.e. so you can pass in a spy). |
request
request(url: string, requestOptions: InternalRequestOptions): Promise<any>
Override the default function for making the request. This is mainly useful for testing purposes (i.e. so you can pass in a spy).
Parameters
Parameter | Type | Notes |
---|---|---|
url | string | |
request | InternalRequestOptions |
Returns
Promise<any>