HistoryRecord

 
public struct HistoryRecord : IndexableRecord, SearchResult, Codable, Hashable

Resolved search result intended to represent user search history

  • “history icon” by default

    Declaration

    Swift

    public var iconName: String?

  • Declaration

    Swift

    public var makiIcon: String? { get }

  • Type of stored history record

    See more

    Declaration

    Swift

    public enum HistoryType : Int, Codable
  • id

    Unique identifier

    Declaration

    Swift

    public private(set) var id: String { get }

  • Declaration

    Swift

    public private(set) var mapboxId: String? { get }

  • Record’s name

    Declaration

    Swift

    public private(set) var name: String { get }

  • Index in response from server.

    Declaration

    Swift

    public let serverIndex: Int?

  • A point accuracy metric for the returned address.

    Declaration

    Swift

    public let accuracy: SearchResultAccuracy?

  • The feature name, as matched by the search algorithm. Not available in searchBox results.

    Warning

    The field is exposed for compatibility only and should be considered deprecated.

    Declaration

    Swift

    public private(set) var matchingName: String? { get }

  • Address formatted with medium style

    Declaration

    Swift

    public var descriptionText: String?

  • Coordinate associated with the record

    Declaration

    Swift

    public internal(set) var coordinate: CLLocationCoordinate2D { get set }

  • An approximate distance to the origin location, in meters.

    Declaration

    Swift

    public var distance: CLLocationDistance?

  • The time when the record was created.

    Declaration

    Swift

    public private(set) var timestamp: Date { get }

  • Type of object used to make a history record, e.g. result or query

    Declaration

    Swift

    public private(set) var historyType: HistoryType { get }

  • Original result type of object, e.g. address or POI

    Declaration

    Swift

    public private(set) var type: SearchResultType { get }

  • FavoriteRecord Always has estimatedTime as nil.

    Declaration

    Swift

    public var estimatedTime: Measurement<UnitDuration>?

  • Associated metadata at creating time if available.

    Declaration

    Swift

    public var metadata: SearchResultMetadata?

  • Address components of specific record

    Declaration

    Swift

    public var address: Address?

  • Additional indexable tokens for search engine

    SearchEngine would track that tokens to match results

    Declaration

    Swift

    public var additionalTokens: Set<String>?

  • POI categories associated with the original result

    Declaration

    Swift

    public var categories: [String]?

  • Canonical POI category IDs associated with the original result

    Declaration

    Swift

    public var categoryIds: [String]?

  • Original search request.

    Declaration

    Swift

    public let searchRequest: SearchRequestOptions

  • Coordinates of building entries

    Declaration

    Swift

    public var routablePoints: [RoutablePoint]?

  • Optional bounding box that represents the geographical boundaries of a location, e.g., a building.

    Declaration

    Swift

    public let boundingBox: BoundingBox?

  • History record constructor

    Declaration

    Swift

    public init(
    id: String = UUID().uuidString,
    mapboxId: String?,
    name: String,
    matchingName: String?,
    serverIndex: Int?,
    accuracy: SearchResultAccuracy?,
    coordinate: CLLocationCoordinate2D,
    distance: CLLocationDistance? = nil,
    timestamp: Date = Date(),
    historyType: HistoryRecord.HistoryType,
    type: SearchResultType,
    address: Address?,
    metadata: SearchResultMetadata? = nil,
    categories: [String]? = nil,
    categoryIds: [String]? = nil,
    searchRequest: SearchRequestOptions,
    routablePoints: [RoutablePoint]? = nil,
    descriptionText: String? = nil,
    boundingBox: BoundingBox? = nil
)

    Parameters

    id

    UUID used by default
    mapboxId

    Unique record identifier
    name

    History name
    matchingName

    The feature name, as matched by the search algorithm
    serverIndex

    The index in response from server
    accuracy

    A point accuracy metric for the returned address
    coordinate

    History coordinate
    distance

    An approximate distance to the origin location, in meters
    timestamp

    History timestamp
    historyType

    History type
    type

    History type
    address

    History address
    metadata

    Associated metadata
    categories

    Categories of original object
    categoryIds

    Category IDs of original object
    searchRequest

    The original search request
    routablePoints

    Coordinates of building entries
    descriptionText

    Address formatted with the medium style
    boundingBox

    Bounding box that represents the geographical boundaries of a location

  • Construct HistoryRecord based on concrete SearchResult

    Declaration

    Swift

    public init(
    historyType: HistoryRecord.HistoryType = .result,
    searchResult: SearchResult,
    timestamp: Date = Date()
)

    Parameters

    historyType

    Type of history result
    searchResult

    Prototype result
    timestamp

    creating timestamp. Calling time by default