sdk/com.mapbox.search.details/DetailsApi/retrieveDetails

retrieveDetails

open fun retrieveDetails(mapboxId: String, options: RetrieveDetailsOptions, callback: SearchResultCallback): AsyncOperationTask

Request basic metadata for a POI, which includes attributes such as POI name, address, coordinates, primary photo and category classification.

To retrieve additional attributes beyond the basic data for a POI, specify RetrieveDetailsOptions.attributeSets in the provided options.

Return

AsyncOperationTask object representing pending completion of the request

Parameters

mapboxId

A unique identifier for the geographic feature.

options

Retrieve options.

callback

Search result callback. Events are dispatched on the main thread.

abstract fun retrieveDetails(mapboxId: String, options: RetrieveDetailsOptions, executor: Executor, callback: SearchResultCallback): AsyncOperationTask

Request basic metadata for a POI, which includes attributes such as POI name, address, coordinates, primary photo and category classification.

To retrieve additional attributes beyond the basic data for a POI, specify RetrieveDetailsOptions.attributeSets in the provided options.

Return

AsyncOperationTask object representing pending completion of the request

Parameters

mapboxId

A unique identifier for the geographic feature.

options

Retrieve options.

executor

Executor used for events dispatching, default is the main thread.

callback

Search result callback.

open fun retrieveDetails(mapboxIds: List<String>, options: RetrieveDetailsOptions, callback: SearchCallback): AsyncOperationTask

Request basic metadata for POIs, which includes attributes such as POI name, address, coordinates, primary photo and category classification.

To retrieve additional attributes beyond the basic data for a POI, specify RetrieveDetailsOptions.attributeSets in the provided options.

Return

AsyncOperationTask object representing pending completion of the request

Parameters

mapboxIds

Unique identifiers for the geographic features.

options

Retrieve options.

callback

Search result callback. Events are dispatched on the main thread.

abstract fun retrieveDetails(mapboxIds: List<String>, options: RetrieveDetailsOptions, executor: Executor, callback: SearchCallback): AsyncOperationTask

Request basic metadata for POIs, which includes attributes such as POI name, address, coordinates, primary photo and category classification.

To retrieve additional attributes beyond the basic data for a POI, specify RetrieveDetailsOptions.attributeSets in the provided options.

Return

AsyncOperationTask object representing pending completion of the request

Parameters

mapboxIds

Unique identifiers for the geographic features.

options

Retrieve options.

executor

Executor used for events dispatching, default is the main thread.

callback

Search result callback.