Interface
Options for getCategory
.
Properties
Property | Type | Notes |
---|---|---|
authentication inherited | string | IAuthenticationManager | The instance of |
string | ||
credentials inherited | RequestCredentials | A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows. |
f inherited | "json" | "pjson" | The requested response format - either |
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. |
language inherited | "en" | "es" | "de" | "fr" | "ja" | "pt" | Optional case-sensitive parameter to specify the preferred language to use for category names. |
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. |
token inherited | string | The authentication token, created from an ArcGIS Location Platform account, with the |
authentication
authentication: string | IAuthenticationManager
The instance of ArcGISIdentityManager
, ApplicationCredentialsManager
or APIKeyManager
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.
f
f: "json" | "pjson"
The requested response format - either json
or pjson
(pretty json).
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.
icon
icon: IconOptions
language
language: "en" | "es" | "de" | "fr" | "ja" | "pt"
Optional case-sensitive parameter to specify the preferred language to use for category names.
This query parameter uses language codes to specify the preferred language. If not set, or if no translation is available, the default behavior is to return category names in English.
The language codes use the CLDR (Common Locale Data Repository) format string that uses a two letter language code (e.g. "fr" for French) optionally followed by a two letter country code (e.g. "fr-CA" for French in Canada).
If an unsupported language code is used, then the service will attempt
to fall-back to the closest available language. This is done by
stripping regional and extension subtags to find a known language code.
For example, French Canadian (fr-CA
) is unsupported so this falls back
to French fr
.
Should the fallback fail, then the service will return category names in
the default language en
for English.
Language codes:
- English, default US -
en
- French -
fr
- German -
de
- Japanese -
ja
- Portuguese, default Brazil -
pt
- Spanish -
es
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.
suppressWarnings
suppressWarnings: boolean
Suppress any ArcGIS REST JS related warnings for this request.
token
token: string
The authentication token, created from an ArcGIS Location Platform account, with the premium:user:places
privilege, used to access the Places service.
The token
parameter can be either an API Key or short-lived token. SeeArcGIS security
documentationfor more information on authenticating with a token or API key.
Alternatively, you can supply a token in the request header with one of the following keys using the "Bearer" scheme:
Authorization: Bearer <YOUR_TOKEN>
X-Esri-Authorization: Bearer <YOUR_TOKEN>