IGetCategoryOptions

The instance of @esri/arcgis-rest-request!ArcGISIdentityManager , @esri/arcgis-rest-request!ApplicationCredentialsManager or @esri/arcgis-rest-request!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.

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

The requested response format - either json or pjson (pretty json).

Additional Headers to pass into the request.

Type declaration

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.

Determines whether icons are returned and the type of icon to use with a place or category.

Use this parameter to define the type of icon URL for a given place or category. Place icons are available in the following formats:

• svg
• cim (Cartographic Information Model)
• png 48 x 48 pixels

The SVG and CIM symbols default to 15 x 15 pixels but can be scaled smoothly for display in larger UI elements or to emphasize these features on a map. The PNG icons are provided as 48 x 48 pixels but for map display the recommended size is 16 x 16 pixels.

The default is none (no icon URL will be returned).

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

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

Additional parameters to pass in the request.

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

Return the raw response

Override the default function for making the request. This is mainly useful for testing purposes (i.e. so you can pass in a spy).

Type declaration

function(url: string, requestOptions: InternalRequestOptions): Promise<any>

Parameters

Parameter	Type
url	string
requestOptions	InternalRequestOptions

Returns 

Promise<any>

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

Suppress any ArcGIS REST JS related warnings for this request.

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. See ArcGIS security documentation for 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>