IItemResourceOptions

Interface

Inheritance: IItemResourceOptionsIUserItemOptions

Properties

Hide inherited properties
PropertyTypeNotes

A session representing a logged in user.

string

Text input to be added as a file resource.

credentials
inherited
RequestCredentials

A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.

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.

id
inherited
string

Unique identifier of the item.

maxUrlLength
inherited
number

If the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.

string

New resource filename.

owner
inherited
string

Item owner username. If not present, authentication.username is utilized.

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'.

string

Folder in which to store the new resource.

boolean

Controls whether access to the file resource is restricted to the owner or inherited from the sharing permissions set for the associated item.

rawResponse
inherited
boolean

Return the raw response

any

Object to store

signal
inherited
AbortSignal

An AbortSignal object instance; allows you to abort a request and via an AbortController.

boolean

Suppress any ArcGIS REST JS related warnings for this request.

authentication

inherited
Interface Property
authentication: ArcGISIdentityManager

A session representing a logged in user.

content

optional
Interface Property
content: string

Text input to be added as a file resource.

credentials

optionalinherited
Interface Property
credentials: RequestCredentials

A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.

headers

optionalinherited
Interface Property
headers: { [key: string]: any }

Additional Headers to pass into the request.

Type declaration
  • [key: string]: any

hideToken

optionalinherited
Interface Property
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

optionalinherited
Interface Property
httpMethod: HTTPMethods

The HTTP method to send the request with.

id

inherited
Interface Property
id: string

Unique identifier of the item.

Inherited from IUserItemOptions.id

maxUrlLength

optionalinherited
Interface Property
maxUrlLength: number

If the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.

name

optional
Interface Property
name: string

New resource filename.

owner

optionalinherited
Interface Property
owner: string

Item owner username. If not present, authentication.username is utilized.

Inherited from IUserItemOptions.owner

params

optionalinherited
Interface Property
params: IParams

Additional parameters to pass in the request.

portal

optionalinherited
Interface Property
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'.

prefix

optional
Interface Property
prefix: string

Folder in which to store the new resource.

private

optional
Interface Property
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.

rawResponse

optionalinherited
Interface Property
rawResponse: boolean

Return the raw response

resource

optional
Interface Property
resource: any

Object to store

signal

optionalinherited
Interface Property
signal: AbortSignal

An AbortSignal object instance; allows you to abort a request and via an AbortController.

suppressWarnings

optionalinherited
Interface Property
suppressWarnings: boolean

Suppress any ArcGIS REST JS related warnings for this request.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.