A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://developers.arcgis.com/arcgis-rest-js/api-reference/arcgis-rest-places/IGetPlaceOptions/ below:

IGetPlaceOptions | ArcGIS REST JS

Interface

Options for getPlace.

Inheritance: IGetPlaceOptions Omit<IRequestOptions, "httpMethod"> queryParams Properties

Hide inherited properties

Property Type Notes authentication

inherited

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

inherited

RequestCredentials

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

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.

icon IconOptions maxUrlLength

inherited

number

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

params

inherited

IParams

Additional parameters to pass in the request.

placeId string 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

requestedFields

inherited

"all" | "additionalLocations" | "additionalLocations:dropOff" | "additionalLocations:frontDoor" | "additionalLocations:road" | "additionalLocations:roof" | "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" | "location" | "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.

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

optionalinherited

Interface Property credentials

optionalinherited

Interface Property credentials: RequestCredentials

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

Inherited from Omit.credentials

headers

optionalinherited

Interface Property headers: { [key: string]: any }

Additional Headers to pass into the request.

Type declaration

Inherited from Omit.headers

hideToken

optionalinherited

Interface Property 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.

Inherited from Omit.hideToken

icon

optional

Interface Property maxUrlLength

optionalinherited

Interface Property maxUrlLength: number

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

Inherited from Omit.maxUrlLength

params

optionalinherited

Interface Property params: IParams

Additional parameters to pass in the request.

Inherited from Omit.params

placeId Interface Property

placeId: string

portal

optionalinherited

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

Inherited from Omit.portal

rawResponse

optionalinherited

Interface Property rawResponse: boolean

Return the raw response

Inherited from Omit.rawResponse

requestedFields

inherited

Interface Property requestedFields: "all" | "additionalLocations" | "additionalLocations:dropOff" | "additionalLocations:frontDoor" | "additionalLocations:road" | "additionalLocations:roof" | "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" | "location" | "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 requestedFields=name,address:streetAddress. However, you can also set this value to requestedFields=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.

Inherited from queryParams.requestedFields

signal

optionalinherited

Interface Property signal: AbortSignal

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

Inherited from Omit.signal

suppressWarnings

optionalinherited

Interface Property suppressWarnings: boolean

Suppress any ArcGIS REST JS related warnings for this request.

Inherited from Omit.suppressWarnings

Methods

Hide inherited methods

Method Returns Notes request(url, requestOptions)

inherited

Promise<any>

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

request

optionalinherited

Interface Method request(url: string, requestOptions: InternalRequestOptions): Promise<any>

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

Returns Promise<any>

Inherited from Omit.request

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4