Interface
Properties
Property | Type | Notes |
---|---|---|
authentication inherited | string | IAuthenticationManager | The instance of |
credentials inherited | RequestCredentials | A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows. |
direction | "forward" | "reverse" | The direction of the relationship. Either forward (from origin -> destination) or reverse (from destination -> origin). |
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. |
id | string | Unique identifier of the item. |
maxUrlLength inherited | number | If the length of a GET request's URL exceeds |
params inherited | IParams | Additional parameters to pass in the request. |
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 |
relationshipType | ItemRelationshipType | ItemRelationshipType[] | The type of relationship between the two items. |
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.
credentials
credentials: RequestCredentials
A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.
direction
direction: "forward" | "reverse"
The direction of the relationship. Either forward (from origin -> destination) or reverse (from destination -> origin).
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.
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'.
relationshipType
Interface PropertyrelationshipType: ItemRelationshipType | ItemRelationshipType[]
The type of relationship between the two items.
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>