Interface
Base options interface for making authenticated requests for items.
Properties
| Property | Type | Notes |
|---|---|---|
authenticationinherited | IAuthenticationManager | The instance of |
content | string | Text input to be added as a file resource. |
credentialsinherited | RequestCredentials | A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows. |
headersinherited | {} | 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. |
idinherited | string | Unique identifier of the item. |
maxUrlLengthinherited | number | If the length of a GET request's URL exceeds |
name | string | New resource filename. |
ownerinherited | string | Item owner username. If not present, |
paramsinherited | IParams | Additional parameters to pass in the request. |
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'. |
prefix | string | Folder in which to store the new resource. |
private | boolean | Controls whether access to the file resource is restricted to the owner or inherited from the sharing permissions set for the associated item. |
rawResponseinherited | boolean | Return the raw response |
requestinherited | (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). |
resource | any | Object to store |
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. |
authentication
authentication: IAuthenticationManagerThe instance of @esri/arcgis-rest-request!ArcGISIdentityManager , @esri/arcgis-rest-request!ApplicationCredentialsManager or @esri/arcgis-rest-request!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: RequestCredentialsA string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.
headers
headers: {}Additional Headers to pass into the request.
Type declaration
hideToken
hideToken: booleanPrevents 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: HTTPMethodsThe HTTP method to send the request with.
maxUrlLength
maxUrlLength: numberIf the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.
owner
owner: stringItem owner username. If not present, authentication.getUsername() is utilized.
portal
portal: stringBase 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'.
private
private: booleanControls whether access to the file resource is restricted to the owner or inherited from the sharing permissions set for the associated item.
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).
Type declaration
function(url: string, requestOptions: InternalRequestOptions): Promise<any>Parameters
| Parameter | Type |
|---|---|
url | string |
request | InternalRequestOptions |
Returns
Promise<any>signal
signal: AbortSignalAn AbortSignal object instance; allows you to abort a request and via an AbortController.
suppressWarnings
suppressWarnings: booleanSuppress any ArcGIS REST JS related warnings for this request.