Interface
Options for getCategories
.
Properties
Property | Type | Notes |
---|---|---|
authentication inherited | string | IAuthenticationManager | The instance of |
credentials inherited | RequestCredentials | A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows. |
filter inherited | string | A text filter that will be used for searching categories. |
headers inherited | { [key: string]: any } | Additional Headers to pass into the request. |
hideToken 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. |
maxUrlLength inherited | number | If the length of a GET request's URL exceeds |
params inherited | Additional parameters to pass in the request. | |
portal 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 inherited | boolean | Return the raw response |
signal inherited | AbortSignal | An AbortSignal object instance; allows you to abort a request and via an AbortController. |
suppressWarnings inherited | boolean | Suppress any ArcGIS REST JS related warnings for this request. |
authentication
authentication: string | 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
credentials: RequestCredentials
A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.
filter
filter: string
A text filter that will be used for searching categories.
The text must be at least three characters and will be applied as a partial match. For example, using the filter "off" would return categories using the word "Office" as well as those using the word "Coffee".
headers
headers: { [key: string]: any }
Additional Headers to pass into the request.
Type declaration
- [key: string]: any
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.
maxUrlLength
maxUrlLength: number
If the length of a GET request's URL exceeds maxUrlLength
the request will use POST instead.
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'.
signal
signal: AbortSignal
An AbortSignal object instance; allows you to abort a request and via an AbortController.