IndexableRecord

 
public protocol IndexableRecord

Defines data for index to represent external data to be included in search functionality

Required Fields
  • id

    Record unique identifier.

    Declaration

    Swift

    var id: String { get }

  • Record name.

    Declaration

    Swift

    var name: String { get }

  • Record coordinates.

    Declaration

    Swift

    var coordinate: CLLocationCoordinate2D { get }

  • Type of the search result represented by the record.

    Declaration

    Swift

    var type: SearchResultType { get }

Optional Fields

  • Additional description for this record.

    Declaration

    Swift

    var descriptionText: String? { get }

  • Record address.

    Declaration

    Swift

    var address: Address? { get }

  • List of points near coordinate, that represent entries to the associated building.

    Declaration

    Swift

    var routablePoints: [RoutablePoint]? { get }

  • Record categories.

    Declaration

    Swift

    var categories: [String]? { get }

  • Mapbox Maki icon ID.

    Declaration

    Swift

    var makiIcon: String? { get }

  • Search result metadata containing this place’s detailed information if available.

    Declaration

    Swift

    var metadata: SearchResultMetadata? { get }

  • Additional string literals that should be included in object index. For example, you may provide non-official names to force SearchEngine match them.

    Declaration

    Swift

    var additionalTokens: Set<String>? { get }