sdk/com.mapbox.search/SearchEngine/retrieve

retrieve

@MapboxExperimental
abstract fun retrieve(mapboxId: String, options: RetrieveOptions, executor: Executor, callback: SearchResultCallback): AsyncOperationTask

Function to retrieve the details for a given mapboxId. The callback will be invoked with a SearchResult on successful execution. This method is only supported for a SearchEngine with ApiType.SEARCH_BOX or ApiType.SBS.

Return

AsyncOperationTask object representing pending completion of the request

Parameters

mapboxId

for the item to retrieve details for

options

options used for controlling the "retrieve" request

executor

Executor used for events dispatching, default is the main thread

callback

used to receive the SearchResult on successful execution

Throws

when invoked for any ApiType except ApiType.SEARCH_BOX or ApiType.SBS

open fun retrieve(mapboxId: String, executor: Executor, callback: SearchResultCallback): AsyncOperationTask

Function to retrieve the details for a given mapboxId. The callback will be invoked with a SearchResult on successful execution. This method is only supported for a SearchEngine with ApiType.SEARCH_BOX or ApiType.SBS.

Return

AsyncOperationTask object representing pending completion of the request

Parameters

mapboxId

for the item to retrieve details for

executor

Executor used for events dispatching, default is the main thread

callback

used to receive the SearchResult on successful execution

Throws

when invoked for any ApiType except ApiType.SEARCH_BOX or ApiType.SBS

@MapboxExperimental
open fun retrieve(mapboxId: String, options: RetrieveOptions, callback: SearchResultCallback): AsyncOperationTask

Function to retrieve the details for a given mapboxId that dispatches events using the main executor. The callback will be invoked with a SearchResult on successful execution.

Note that this method is only supported for a SearchEngine with ApiType.SEARCH_BOX or ApiType.SBS.

Return

AsyncOperationTask object representing pending completion of the request

Parameters

mapboxId

for the item to retrieve details for

options

options used for controlling the "retrieve" request

callback

used to receive the SearchResult on successful execution

open fun retrieve(mapboxId: String, callback: SearchResultCallback): AsyncOperationTask

Function to retrieve the details for a given mapboxId that dispatches events using the main executor. The callback will be invoked with a SearchResult on successful execution.

Note that this method is only supported for a SearchEngine with ApiType.SEARCH_BOX or ApiType.SBS.

Return

AsyncOperationTask object representing pending completion of the request

Parameters

mapboxId

for the item to retrieve details for

callback

used to receive the SearchResult on successful execution