Home > @magiclane/maps-sdk > SearchService > searchLandmarkDetails
SearchService.searchLandmarkDetails() method
Get details for the given landmark list.
The main purpose of this method is to populate the details for a landmark provided by selecting a landmark from the upper zoom level of the map. Other types of landmarks (such as the ones provided by search) are already up-to-date. Does not work with user created landmarks.
Signature:
static searchLandmarkDetails(results: Landmark[], onCompleteCallback: (err: GemError) => void): TaskHandler | null;Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
results |
Landmark[] |
The landmark list for which the landmarks details are searched. |
|
onCompleteCallback |
(err: GemError) => void |
Will be invoked when the search operation is completed, providing the error code. If the landmarks in list already have the details populated, the function will return GemError.upToDate. - GemError.success if the search was successfully completed - GemError.invalidated if the landmark provided is invalid (ex: user created landmark) - GemError.upToDate if the landmark already has all the details. |
Returns:
TaskHandler | null
Associated TaskHandler for this operation if the search can be started otherwise null.
Exceptions
An exception if it fails.