PickedPlace (API Reference)
Class PickedPlace
Carries the result of picking a Carto POI (point of interest) object.
-
Field Summary
FieldsModifier and TypeFieldDescriptionThe geographic coordinates of the POI.The name of the POI localized in the currently selected map language.The place ID to query an offline search to obtain additional data about this POI with theOfflineSearchEngine.The place category ID of the POI. -
Constructor Summary
ConstructorsConstructorDescriptionPickedPlace(String name, GeoCoordinates coordinates, String placeCategoryId) Creates a new instance. -
Method Summary
-
Field Details
-
name
The name of the POI localized in the currently selected map language.
-
coordinates
The geographic coordinates of the POI.
-
placeCategoryId
The place category ID of the POI. This is the same String value as
PlaceCategory.idthat can be obtained from theSearchEngineand theOfflineSearchEngine. Note that not all editions include theOfflineSearchEngine. -
offlineSearchId
The place ID to query an offline search to obtain additional data about this POI with the
OfflineSearchEngine. Note that not all editions include theOfflineSearchEngine.
-
-
Constructor Details
-
PickedPlace
public PickedPlace(@NonNull String name, @NonNull GeoCoordinates coordinates, @NonNull String placeCategoryId) Creates a new instance.
- Parameters:
name-The name of the POI localized in the currently selected map language.
coordinates-The geographic coordinates of the POI.
placeCategoryId-The place category ID of the POI. This is the same String value as
PlaceCategory.idthat can be obtained from theSearchEngineand theOfflineSearchEngine. Note that not all editions include theOfflineSearchEngine.
-
-
Method Details