Interface
Properties
Property | Type | Notes |
---|---|---|
async inherited | boolean | If true, the file is uploaded asynchronously. If false, the file is uploaded synchronously. |
authentication inherited | A session representing a logged in user. | |
credentials inherited | RequestCredentials | A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows. |
dataUrl inherited | string | The URL where the item can be downloaded. The resource will be downloaded and stored as a file type. Similar to uploading a file to be added, but instead of transferring the contents of the file, the URL of the data file is referenced and creates a file item. |
file inherited | The file to be uploaded. If uploading a file, the request must be a multipart request. | |
filename inherited | string | The filename being uploaded in multipart mode. Required if multipart=true. |
folderId inherited | string | Id of the folder to house the item. |
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 | The HTTP method to send the request with. | |
maxUrlLength inherited | number | If the length of a GET request's URL exceeds |
multipart inherited | boolean | If true, the file is uploaded in multiple parts. |
overwrite inherited | boolean | If true, overwrite the existing file. |
owner inherited | string | The owner of the item. If this property is not present, |
params inherited | 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 |
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. |
text inherited | string | The text content for the item to be submitted. |
string | Name of the folder to create. |
async
async: boolean
If true, the file is uploaded asynchronously. If false, the file is uploaded synchronously.
authentication
authentication: ArcGISIdentityManager
A session representing a logged in user.
credentials
credentials: RequestCredentials
A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.
dataUrl
dataUrl: string
The URL where the item can be downloaded. The resource will be downloaded and stored as a file type. Similar to uploading a file to be added, but instead of transferring the contents of the file, the URL of the data file is referenced and creates a file item.
file
file: Blob | File
The file to be uploaded. If uploading a file, the request must be a multipart request.
filename
filename: string
The filename being uploaded in multipart mode. Required if multipart=true.
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.
multipart
multipart: boolean
If true, the file is uploaded in multiple parts.
overwrite
overwrite: boolean
If true, overwrite the existing file.
owner
owner: string
The owner of the item. If this property is not present, item.owner
will be passed, or lastly authentication.username
.
params
params: IParams
Additional parameters to pass in the request.
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.
text
text: string
The text content for the item to be submitted.