Skip to main content

Places

const Places: object

Places service

Type declaration

authenticate

authenticate: Object

Gets authentication token for the api key.

Example

const authPromise = TrimbleMaps.Places.authenticate();
authPromise.then((resp) =\> {
  const token = JSON.parse(resp).token;
});

getPlace

getPlace: Object

Gets the standard information about a single place.

Param

PlaceOptions. Options

Param

string. Authentication token. Required.

Param

string. Place Id. Required.

Example

const placePromise = TrimbleMaps.Places.getPlace({
  token: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9',
  placeId: '0xlM0l28x0LEiCiOPrHt-_WQ'
});

getPlaceDetails

getPlaceDetails: Object

Gets the full details about a single place.

Param

PlaceOptions. Options

Param

string. Authentication token. Required.

Param

string. Place Id. Required.

Example

const placeDetailsPromise = TrimbleMaps.Places.getPlaceDetails({
  token: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9',
  placeId: '0xlM0l28x0LEiCiOPrHt-_WQ'
});
Last updated August 23, 2024.