SearchResult

public struct SearchResult : Codable

SearchResult Object containing grouped information about places or points of interest.

Important

This is a Public Preview API. It may be changed or removed at any time.

Lifecycle

  • SearchResult init method.

    Declaration

    Swift

    public init(
        type: String,
        id: String?,
        score: Double?,
        dist: Double?,
        info: String?,
        poi: Poi?,
        address: Address,
        position: Position,
        viewport: Viewport?,
        entryPoints: [EntryPoint]?,
        dataSources: DataSources?,
        detourTime: Int?,
        detourDistance: Int?
    )

    Parameters

    type

    The type of result (should always be “POI”).

    id

    The ID of the result.

    score

    The score of the result.

    dist

    The distance from the route provided in the request.

    info

    Additional info.

    poi

    Information about the POI.

    address

    Detailed address of the result.

    position

    The geographical position of the POI.

    viewport

    The viewport.

    entryPoints

    A list of entrances to the POI.

    dataSources

    Additional data sources related to the result.

    detourTime

    Maximum detour time. (Maximum value: 3600 seconds.)

    detourDistance

    Detour distance in meters.

Public

  • The type of result (should always be “POI”).

    Declaration

    Swift

    public let type: String
  • id

    The ID of the result.

    Declaration

    Swift

    public let id: String?
  • The score of the result.

    Declaration

    Swift

    public let score: Double?
  • The distance from the route provided in the request.

    Declaration

    Swift

    public let dist: Double?
  • Additional info.

    Declaration

    Swift

    public let info: String?
  • poi

    Information about the POI.

    Declaration

    Swift

    public let poi: Poi?
  • Detailed address of the result.

    Declaration

    Swift

    public let address: Address
  • The geographical position of the POI.

    Declaration

    Swift

    public let position: Position
  • The viewport.

    Declaration

    Swift

    public let viewport: Viewport?
  • A list of entrances to the POI.

    Declaration

    Swift

    public let entryPoints: [EntryPoint]?
  • Additional data sources related to the result.

    Declaration

    Swift

    public let dataSources: DataSources?
  • Maximum detour time. (Maximum value: 3600 seconds.)

    Declaration

    Swift

    public let detourTime: Int?
  • Detour distance in meters.

    Declaration

    Swift

    public let detourDistance: Int?