MapboxSearchController
public class MapboxSearchController : UIViewController
extension MapboxSearchController: SearchEngineDelegate
Undocumented
-
Undocumented
See moreDeclaration
Swift
public class Configuration
-
Undocumented
Declaration
Swift
public var favoritesProvider: FavoritesProvider
-
Undocumented
Declaration
Swift
public var historyProvider: HistoryProvider
-
Undocumented
Declaration
Swift
public var categorySearchEngine: CategorySearchEngine
-
Undocumented
Declaration
Swift
public var searchEngine: SearchEngine { get set }
-
Options used to customize search, nil by default.
Declaration
Swift
public var searchOptions: SearchEngine.RequestOptions?
-
Options used to customize category search, nil by default.
Declaration
Swift
public var categorySearchOptions: CategorySearchEngine.RequestOptions?
-
Undocumented
Declaration
Swift
public let configuration: Configuration
-
Undocumented
Declaration
Swift
public weak var delegate: SearchControllerDelegate?
-
Instantiate MapboxSearchController with explicit accessToken and custom location provider
Declaration
Swift
public required init(accessToken: String, configuration: Configuration = Configuration())
Parameters
accessToken
Mapbox public access token. Checkout
init(locationProvider:)
toconfiguration
configuration for search and categorySearch engines.
-
MapboxSearchController initializer with accessToken taken from application Info.plist
Access token is expected to be at
MGLMapboxAccessToken
key in application Info.plist. Missing accessToken will trigger fatalErrorDeclaration
Swift
public required init(configuration: Configuration = Configuration())
Parameters
configuration
configuration for search and categorySearch engines.
-
Undocumented
Declaration
Swift
public override func viewDidLoad()
-
Undocumented
Declaration
Swift
public override func viewWillAppear(_ animated: Bool)
-
Undocumented
Declaration
Swift
public override func viewDidDisappear(_ animated: Bool)
-
Reset MapboxSearchController state recursively
Declaration
Swift
public func resetSearchUI(animated: Bool, collapse: MapboxPanelController.State? = .collapsed)
Parameters
animated
Should changes be animated
collapse
Change the collapsing status. Pass
nil
to not apply status changes. Default:.collapsed
-
Declaration
Swift
public func resultsUpdated(searchEngine: SearchEngine)
-
Declaration
Swift
public func resolvedResult(result: SearchResult)
-
Declaration
Swift
public func searchErrorHappened(searchError: SearchError)
-
Undocumented
Declaration
Swift
public func searchQueryDidChanged(_ newQuery: String?)
-
Undocumented
Declaration
Swift
public func searchTextFieldBeginEditing()
-
Undocumented
Declaration
Swift
public func cancelSearch()