Interface IUserRequestOptions

Used internally by packages for requests that require authentication.

interface IUserRequestOptions {
    authentication: UserSession;
    credentials?: RequestCredentials;
    fetch?: ((input, init?) => Promise<Response>);
    headers?: {
        [key: string]: any;
    };
    hideToken?: boolean;
    httpMethod?: HTTPMethods;
    maxUrlLength?: number;
    params?: IParams;
    portal?: string;
    rawResponse?: boolean;
}

Hierarchy (view full)

Properties

authentication credentials? fetch? headers? hideToken? httpMethod? maxUrlLength? params? portal? rawResponse?

Properties

authentication

authentication: UserSession

A session representing a logged in user.

Optional credentials

credentials?: RequestCredentials

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

Optional fetch

fetch?: ((input, init?) => Promise<Response>)

The implementation of fetch to use. Defaults to a global fetch.

Type declaration

    • (input, init?): Promise<Response>

    • Parameters

      • input: RequestInfo
      • Optional init: RequestInit

      Returns Promise<Response>

Optional headers

headers?: {
    [key: string]: any;
}

Additional Headers to pass into the request.

Type declaration

  • [key: string]: any

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

Optional httpMethod

httpMethod?: HTTPMethods

The HTTP method to send the request with.

Optional maxUrlLength

maxUrlLength?: number

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

Optional params

params?: IParams

Additional parameters to pass in the request.

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

Optional rawResponse

rawResponse?: boolean

Return the raw response

Settings

Member Visibility

Theme

On This Page

authenticationcredentialsfetchheadershideTokenhttpMethodmaxUrlLengthparamsportalrawResponse