Interface ISearchOptions

Options for the request() method.

interface ISearchOptions {
    authentication?: IAuthenticationManager;
    categories?: string;
    categoryFilters?: string;
    countFields?: string;
    countSize?: number;
    credentials?: RequestCredentials;
    fetch?: ((input, init?) => Promise<Response>);
    filter?: string;
    headers?: {
        [key: string]: any;
    };
    hideToken?: boolean;
    httpMethod?: HTTPMethods;
    maxUrlLength?: number;
    num?: number;
    params?: IParams;
    portal?: string;
    q: string | SearchQueryBuilder;
    rawResponse?: boolean;
    sortField?: string;
    sortOrder?: string;
    start?: number;
    [key: string]: any;
}

Hierarchy (view full)

Indexable

[key: string]: any

Properties

authentication? categories? categoryFilters? countFields? countSize? credentials? fetch? filter? headers? hideToken? httpMethod? maxUrlLength? num? params? portal? q rawResponse? sortField? sortOrder? start?

Properties

Optional authentication

authentication?: IAuthenticationManager

The instance of IAuthenticationManager to use to authenticate this request.

Optional categories

categories?: string

Optional categoryFilters

categoryFilters?: string

Optional countFields

countFields?: string

Optional countSize

countSize?: number

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 filter

filter?: string

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 num

num?: number

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

q

q: string | SearchQueryBuilder

Optional rawResponse

rawResponse?: boolean

Return the raw response

Optional sortField

sortField?: string

Optional sortOrder

sortOrder?: string

Optional start

start?: number

Settings

Member Visibility

Theme

On This Page

authenticationcategoriescategoryFilterscountFieldscountSizecredentialsfetchfilterheadershideTokenhttpMethodmaxUrlLengthnumparamsportalqrawResponsesortFieldsortOrderstart