Skip to content

Interface

Options to register an app.

Inheritance: IRegisterAppOptionsOmit<IRequestOptions"params">

Properties

Hide inherited properties
PropertyTypeNotes
appTypeAppType

App types. For more info, refer to AppType.

authenticationIAuthenticationManager

IAuthenticationManager authentication.

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
HTTPMethods

The HTTP method to send the request with.

httpReferrersstring[]

Http Referrers set for this app.

itemIdstring

itemId that the newly registered app will be based on.

maxUrlLength
inherited
number

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

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

privilegesPrivileges

Privilege lists. For more info, refer to Privileges.

rawResponse
inherited
boolean

Return the raw response

redirect_urisstring[]

Redirect URIs set for this app.

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.

appType

Interface Property

authentication

Interface Property

credentials

optionalinherited
Interface Property

headers

optionalinherited
Interface Property

hideToken

optionalinherited
Interface Property

httpMethod

optionalinherited
Interface Property

httpReferrers

Interface Property

itemId

Interface Property

maxUrlLength

optionalinherited
Interface Property

portal

optionalinherited
Interface Property

privileges

Interface Property

rawResponse

optionalinherited
Interface Property

redirect_uris

Interface Property

signal

optionalinherited
Interface Property

suppressWarnings

optionalinherited
Interface Property

Methods

Hide inherited methods
MethodReturnsNotes
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

optionalinherited
Interface Method
request(urlstring, requestOptionsInternalRequestOptions): 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
ParameterTypeNotes
urlstring
requestOptionsInternalRequestOptions
Returns 
Promise<any>
Inherited from Omit.request

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