ISearchParams

Interface

Extends

Properties

Property Type Notes
q string
access Optional string
agg Optional {
fields:
string
mode:
string
size:
number
}
bbox Optional string
collection Optional any
content Optional any
downloadable Optional string
groupIds Optional string
hasApi Optional string
hubType Optional string
id Optional string
isPortal Optional string
location_name Optional string
owner Optional string
page Optional {
ago:
{
size:
number
start:
number
}
hub:
{
size:
number
start:
number
}
}
region Optional string
sector Optional string
sort Optional string
source Optional string
tags Optional string
type Optional string
authentication Optional Inherited IAuthenticationManager

The instance of IAuthenticationManager to use to authenticate this request.

credentials Optional Inherited RequestCredentials

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

fetch Optional Inherited function(input: RequestInfo, init: RequestInit) : Promise<Response>

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

headers Optional Inherited [key: string]: any

Additional Headers to pass into the request.

hideToken Optional 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 Optional Inherited HTTPMethods

The HTTP method to send the request with.

maxUrlLength Optional Inherited number

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

num Optional Inherited number
params Optional Inherited IParams

Additional parameters to pass in the request.

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

rawResponse Optional Inherited boolean

Return the raw response

sortField Optional Inherited string
sortOrder Optional Inherited string
start Optional Inherited number

Index Signatures

Key Type Value Type Notes
string any

Interface defined in packages/search/src/ago/params.ts:6