IGetPlaceOptions
Interface
Options for getPlace.
Properties
| Property | Type | Notes |
|---|---|---|
string | IAuthenticationManager | The instance of | |
RequestCredentials | A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows. | |
{ [key: string]: any } | Additional Headers to pass into the request. | |
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. | |
number | If the length of a GET request's URL exceeds | |
Additional parameters to pass in the request. | ||
string | ||
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'. | |
boolean | Return the raw response | |
"all" | "address" | "address:adminRegion" | "address:censusBlockId" | "address:country" | "address:designatedMarketArea" | "address:extended" | "address:locality" | "address:neighborhood" | "address:poBox" | "address:postcode" | "address:postTown" | "address:region" | "address:streetAddress" | "categories" | "contactInfo" | "contactInfo:email" | "contactInfo:fax" | "contactInfo:telephone" | "contactInfo:website" | "chains" | "description" | "hours" | "hours:opening" | "hours:openingText" | "hours:popular" | "name" | "rating" | "rating:price" | "rating:user" | "socialMedia" | "socialMedia:facebookId" | "socialMedia:instagram" | "socialMedia:twitter"[] | The array of fields that define the attributes to return for a place. | |
AbortSignal | An AbortSignal object instance; allows you to abort a request and via an AbortController. | |
boolean | Suppress any ArcGIS REST JS related warnings for this request. |
credentials
credentials: RequestCredentialsA string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.
headers
headers: { [key: string]: any }Additional Headers to pass into the request.
Type declaration
- [key: string]: any
hideToken
hideToken: booleanPrevents 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: numberIf the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.
portal
portal: stringBase 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'.
requestedFields
requestedFields: "all" | "address" | "address:adminRegion" | "address:censusBlockId" | "address:country" | "address:designatedMarketArea" | "address:extended" | "address:locality" | "address:neighborhood" | "address:poBox" | "address:postcode" | "address:postTown" | "address:region" | "address:streetAddress" | "categories" | "contactInfo" | "contactInfo:email" | "contactInfo:fax" | "contactInfo:telephone" | "contactInfo:website" | "chains" | "description" | "hours" | "hours:opening" | "hours:openingText" | "hours:popular" | "name" | "rating" | "rating:price" | "rating:user" | "socialMedia" | "socialMedia:facebookId" | "socialMedia:instagram" | "socialMedia:twitter"[]The array of fields that define the attributes to return for a place.
Use this parameter to define the attributes you would like returned,
for example ["name", "address:streetAddress"]. However, you can also
set this value to ["all"] to return all of the attributes available
for a place.
The placeId attribute is always returned in addition to the other
attributes you requested. If a valid attribute value is not available,null, or an empty collection, is returned and you are not charged for it. To see the fields and
pricing groups they belong to, go to the table above.
signal
signal: AbortSignalAn AbortSignal object instance; allows you to abort a request and via an AbortController.
authentication: string | IAuthenticationManagerThe instance of
ApiKey,ArcGISIdentityManagerorApplicationSessionto use to authenticate this request. A token may also be passed directly as a string however using the built in authentication managers is encouraged.