SearchSuggestion

 
public protocol SearchSuggestion

Autocomplete common suggestion type.

To retrieve coordinate and detailed address information, you have to push suggestion back to SearchEngine.select(suggestion:) method.

  • id

    Unique identifier for suggestion result.

    Attention

    Mapbox backend may change the identifier of the object in the future.

    Declaration

    Swift

    var id: String { get }

  • Suggestion name.

    Declaration

    Swift

    var name: String { get }

  • Index in response from server.

    Declaration

    Swift

    var serverIndex: Int? { get }

  • Server provided result description. Usually contains pre-formatted address.

    Declaration

    Swift

    var descriptionText: String? { get }

  • Result categories types.

    Declaration

    Swift

    var categories: [String]? { get }

  • Result address.

    Declaration

    Swift

    var address: Address? { get }

  • Maki icon name.

    Declaration

    Swift

    var iconName: String? { get }

  • Result suggestion type.

    Declaration

    Swift

    var suggestionType: SearchSuggestType { get }

  • Original search request.

    Declaration

    Swift

    var searchRequest: SearchRequestOptions { get }

  • Distance in meters from result to requested proximity bias. May be nil even for correct proximity argument.

    Declaration

    Swift

    var distance: CLLocationDistance? { get }

  • Indicates whatever this suggestion can be batch resolved. Suggestion should be POI type.

    Declaration

    Swift

    var batchResolveSupported: Bool { get }