Interface
Properties
| Property | Type | Notes |
|---|---|---|
authenticationinherited | string | IAuthenticationManager | The instance of |
barriers | IFeatureSet | ILocation | IPoint | [void, void][] | |
credentialsinherited | RequestCredentials | A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows. |
endpointinherited | string | Any ArcGIS Routing service (example: https://sampleserver3.arcgisonline.com/ArcGIS/rest/services/Network/USA/NAServer/Route/ ) to use for the routing service request. |
facilities | IFeatureSet | ILocation | IPoint | [void, void][] | Specify one or more locations around which service areas are generated. |
headersinherited | { [key: string]: any } | Additional Headers to pass into the request. |
hideTokeninherited | 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. |
httpMethodinherited | HTTPMethods | The HTTP method to send the request with. |
maxUrlLengthinherited | number | If the length of a GET request's URL exceeds |
outputLines | boolean | |
paramsinherited | IParams | Additional parameters to pass in the request. |
polygonBarriers | IFeatureSet | |
polylineBarriers | IFeatureSet | |
portalinherited | 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'. |
preserveObjectID | boolean | |
rawResponseinherited | boolean | Return the raw response |
returnBarriers | boolean | |
returnFacilities | boolean | |
returnPolygonBarriers | boolean | |
returnPolylineBarriers | boolean | |
signalinherited | AbortSignal | An AbortSignal object instance; allows you to abort a request and via an AbortController. |
suppressWarningsinherited | boolean | Suppress any ArcGIS REST JS related warnings for this request. |
travelDirection | "incidentsToFacilities" | "facilitiesToIncidents" | Specify if the service should return routes. |
barriers
barriers: IFeatureSet | ILocation | IPoint | [void, void][]polygonBarriers
polygonBarriers: IFeatureSetpolylineBarriers
polylineBarriers: IFeatureSetMethods
| 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>