AbstractSearchEngine

public class AbstractSearchEngine<Configuration> where Configuration : AbstractSearchEngineConfiguration

Common root for SearchEngine and CategorySearchEngine. Should never be instantiated directly

  • Undocumented

    Declaration

    Swift

    public internal(set) var supportSBS: Bool { get }
  • Common initializer for SearchEngine and CategorySearchEngine

    Declaration

    Swift

    public convenience init(accessToken: String? = nil, configuration: Configuration = .default)

    Parameters

    accessToken

    Mapbox Access Token to be used. Info.plist value for key MGLMapboxAccessToken will be used for nil argument

    configuration

    Provider configuration of LocationProvider that would grant location data by default

  • Update existing Access Token on the fly

    Declaration

    Swift

    public func setAccessToken(_ token: String)

    Parameters

    token

    New valid Mapbox access token

  • Register indexable data provider to provide custom data layer for SearchEngine

    Declaration

    Swift

    public func register(dataProvider: IndexableDataProvider, priority: Int) -> RecordsProviderInteractor

    Parameters

    dataProvider

    IndexableDataProvider to register

    priority

    data layer priority compared with other layers. Bigger is higher in result’s list.

    Return Value

    interactor for data operations (add, update, delete)

  • Send user feedback events. Does a result or suggestion have any problem with naming, location or something else? Please send feedback describing the issue!

    Declaration

    Swift

    public func sendFeedback(event: FeedbackEvent)

    Parameters

    event

    Feedback event build based on SearchSuggestion or SearchResult.