ISearchParams
Extends
Properties
Property | Type | Notes |
---|---|---|
string | ||
Optional | string | |
Optional |
{
|
|
Optional | string | |
Optional | any | |
Optional | any | |
Optional | string | |
Optional | any | |
Optional | string | |
Optional | string | |
Optional | string | |
Optional | string | |
Optional | string | |
Optional | string | |
Optional | string | |
Optional |
{
|
|
Optional | string | |
Optional | string | |
Optional | string | |
Optional | string | |
Optional | string | |
Optional | string | |
Optional Inherited | IAuthenticationManager | string |
The instance of {@linkcode ApiKey}, {@linkcode ArcGISIdentityManager} or {@linkcode 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. |
Optional Inherited | string | Array<string> |
A JSON array or comma-separated list of up to eight org content categories to search items. |
Optional Inherited | string |
A comma-separated list of up to three category terms to search for items that have matching categories. |
Optional Inherited | string |
A comma-separated list of fields to count. The maximum count fields allowed per request is three. Supported count fields are tags, type, access, contentstatus, and categories. |
Optional Inherited | number |
The maximum number of field values to count for each |
Optional Inherited | RequestCredentials |
A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows. |
Optional Inherited | [key: string]: any |
Additional Headers to pass into the request. |
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. |
Optional Inherited | HTTPMethods |
The HTTP method to send the request with. |
Optional Inherited | number |
If the length of a GET request's URL exceeds |
Optional Inherited | number | |
Optional Inherited | IParams |
Additional parameters to pass in the request. |
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'. |
Optional Inherited | boolean |
Return the raw response |
Optional Inherited | AbortSignal |
An AbortSignal object instance; allows you to abort a request and via an AbortController. |
Optional Inherited | string |
Field to sort by. |
Optional Inherited | "asc" | "desc" |
Describes whether order returns in ascending or descending order. The default is ascending. |
Optional Inherited | number | |
Optional Inherited | boolean |
Suppress any ArcGIS REST JS related warnings for this request. |
Index Signatures
Interface defined in search/src/ago/params.ts:7