AbstractSearchEngine Class Reference


                    
                    
                    apiType

Provide a specific API type

Declaration

Swift

public let apiType: ApiType


                    
                    
                    locationProvider

Location provider for search results proximity argument

Declaration

Swift

public let locationProvider: LocationProvider?


                    
                    
                    feedbackManager

Manager to provide feedback events

Declaration

Swift

public let feedbackManager: FeedbackManager


                    
                    
                    offlineManager

OfflineManager with default TileStore.

Declaration

Swift

public private(set) var offlineManager: SearchOfflineManager { get }


                    
                    
                    defaultSearchOptions

Default options to use when nil was passed to the search(…: options:) call

Full SearchOptions structure would be used when nothing was passed to the search function In other case, each structure field would be tested. Each nil field in search(options:) parameter would be replaced with the value from defaultSearchOptions

Declaration

Swift

public var defaultSearchOptions: SearchOptions


                    
                    
                    init(accessToken:locationProvider:defaultSearchOptions:apiType:)

Initializer with safe-to-go defaults

Declaration

Swift

public convenience init(
    accessToken: String? = nil,
    locationProvider: LocationProvider? = DefaultLocationProvider(),
    defaultSearchOptions: SearchOptions = SearchOptions(),
    apiType: ApiType
)

Parameters

`accessToken`	Mapbox Access Token to be used. Info.plist value for key `MBXAccessToken` will be used for `nil` argument.
`locationProvider`	Provider configuration of LocationProvider that would grant location data by default.
`defaultSearchOptions`	Default options to use when `nil` was passed to the `search(…: options:)` call/
`apiType`	Choose which API provider to use through this search engine.


                    
                    
                    init(accessToken:locationProvider:defaultSearchOptions:)

Initializer with safe-to-go defaults

Declaration

Swift

@available(*, deprecated, message: "Specify ApiType explicitly instead.")
public convenience init(
    accessToken: String? = nil,
    locationProvider: LocationProvider? = DefaultLocationProvider(),
    defaultSearchOptions: SearchOptions = SearchOptions()
)

Parameters

`accessToken`	Mapbox Access Token to be used. Info.plist value for key `MBXAccessToken` will be used for `nil` argument.
`locationProvider`	Provider configuration of LocationProvider that would grant location data by default.
`defaultSearchOptions`	Default options to use when `nil` was passed to the `search(…: options:)` call.


                    
                    
                    init(accessToken:locationProvider:defaultSearchOptions:apiType:baseURL:)

Initializer with safe-to-go defaults.

Declaration

Swift

public convenience init(
    accessToken: String? = nil,
    locationProvider: LocationProvider? = DefaultLocationProvider(),
    defaultSearchOptions: SearchOptions = SearchOptions(),
    apiType: ApiType,
    baseURL: URL
)

Parameters

`accessToken`	Mapbox Access Token to be used. Info.plist value for key `MBXAccessToken` will be used for `nil` argument.
`locationProvider`	Provider configuration of `LocationProvider` that would grant location data by default.
`defaultSearchOptions`	Default options to use when `nil` was passed to the `search(…: options:)` call
`apiType`	choose which API provider to use through this search engine.
`baseURL`	A custom Mapbox API endpoint.


                    
                    
                    init(accessToken:locationProvider:defaultSearchOptions:baseURL:)

Initializer with safe-to-go defaults.

Declaration

Swift

@available(*, deprecated, message: "Specify ApiType explicitly instead.")
public convenience init(
    accessToken: String? = nil,
    locationProvider: LocationProvider? = DefaultLocationProvider(),
    defaultSearchOptions: SearchOptions = SearchOptions(),
    baseURL: URL
)

Parameters

`accessToken`	Mapbox Access Token to be used. Info.plist value for key `MBXAccessToken` will be used for `nil` argument.
`locationProvider`	Provider configuration of `LocationProvider` that would grant location data by default.
`defaultSearchOptions`	Default options to use when `nil` was passed to the `search(…: options:)` call.
`baseURL`	A custom Mapbox API endpoint.


                    
                    
                    register(dataProvider:priority:)

Register indexable data provider to provide custom data layer for SearchEngine

Throws

SearchError.failedToRegisterDataProvider(error, dataProvider)

Declaration

Swift

public func register(dataProvider: IndexableDataProvider, priority: Int) throws -> 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)