IUserSearchOptions

Interface

Inheritance: IUserSearchOptionsISearchOptions

Properties

PropertyTypeNotes

The instance of ApiKey, ArcGISIdentityManager or ApplicationSession to use to authenticate this request. A token may also be passed directly as a string however using the built in authentication managers is encouraged.

credentials
 optional 
RequestCredentials

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

headers
 optional 
{ [key: string]: any }

Additional Headers to pass into the request.

hideToken
 optional 
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
 optional 

The HTTP method to send the request with.

maxUrlLength
 optional 
number

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

num
 optional 
number
params
 optional 

Additional parameters to pass in the request.

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

The query string to search against.

rawResponse
 optional 
boolean

Return the raw response

signal
 optional 
AbortSignal

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

sortField
 optional 
string

Field to sort by.

sortOrder
 optional 
"asc" | "desc"

Describes whether order returns in ascending or descending order. The default is ascending.

start
 optional 
number
suppressWarnings
 optional 
boolean

Suppress any ArcGIS REST JS related warnings for this request.

authentication

authentication: IAuthenticationManager

The instance of ApiKey, ArcGISIdentityManager or ApplicationSession to use to authenticate this request. A token may also be passed directly as a string however using the built in authentication managers is encouraged.

credentials optional

credentials: RequestCredentials

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

headers optional

headers: { [key: string]: any }

Additional Headers to pass into the request.

hideToken optional

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 optional

httpMethod: HTTPMethods

The HTTP method to send the request with.

maxUrlLength optional

maxUrlLength: number

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

num optional

num: number

params optional

params: IParams

Additional parameters to pass in the request.

portal optional

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

The query string to search against.

rawResponse optional

rawResponse: boolean

Return the raw response

signal optional

signal: AbortSignal

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

sortField optional

sortField: string

Field to sort by.

sortOrder optional

sortOrder: "asc" | "desc"

Describes whether order returns in ascending or descending order. The default is ascending.

start optional

start: number

suppressWarnings optional

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.