Package 

Interface DynamicPOISearchController

  • All Implemented Interfaces:

    
    public interface DynamicPOISearchController
    
                        

    Interface for managing dynamic POI (Point of Interest) search operations.

    <p> The Dynamic POI Search feature provides real-time, context-aware POI search capabilities with automatic refresh and intelligent caching. It allows developers to integrate dynamic POI search into their applications, delivering up-to-date information about nearby places of interest as users move around the map. </p><p><b>Key Features:</b></p> <ul> <li>Real-time POI search with automatic camera movement detection</li> <li>Configurable POI refresh strategies with customizable intervals</li> <li>ID-based POI tracking for efficient add/update/remove operations</li> <li>Custom search engine support for flexible data sourcing</li> <li>Intelligent caching with time-based expiration</li> <li>Layer-based POI display optimized for zoom levels</li> <li>Custom coroutine dispatcher support for performance tuning</li> </ul>
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Field Summary

      Fields 
      Modifier and Type Field Description
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      abstract Unit injectSearchEngine(DynamicSearchEngine searchEngine, CoroutineDispatcher dispatcher) Inject a search engine to the controller.
      abstract Unit setRefreshStrategy(PoiRefreshStrategy poiRefreshStrategy) set a strategy for POI refresh, if null, it will be regarded as PoiRefreshStrategies.DISABLED.
      abstract Unit displayPOI(List<String> displayContent) SDK will observe the movement of camera and show POI if exist.
      abstract Unit clear() Clear all displayed POIs and their cached data.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

    • Method Detail

      • injectSearchEngine

         abstract Unit injectSearchEngine(DynamicSearchEngine searchEngine, CoroutineDispatcher dispatcher)

        Inject a search engine to the controller. If inject search engine multiple times, only the last one will work.

        Parameters:
        searchEngine - engine for the search task.
        dispatcher - used for custom kotlinx.coroutines CoroutineDispatcher for poi search task, default dispatcher is Dispatchers.
      • setRefreshStrategy

         abstract Unit setRefreshStrategy(PoiRefreshStrategy poiRefreshStrategy)

        set a strategy for POI refresh, if null, it will be regarded as PoiRefreshStrategies.DISABLED.

        Parameters:
        poiRefreshStrategy - The strategy for POI refresh.
      • displayPOI

         abstract Unit displayPOI(List<String> displayContent)

        SDK will observe the movement of camera and show POI if exist. The POIs are searched by the injected searchEngine with the searchTexts as search parameter. If the searchEngine is not injected. This method will not work.

        Parameters:
        displayContent - The search parameter.
      • clear

         abstract Unit clear()

        Clear all displayed POIs and their cached data.