TomTom SDK for iOS SearchConfiguration

SearchConfiguration

public struct SearchConfiguration

These configuration parameters are used to execute a Point of Interest (TomTomSDKPOIVisualization/POI) search.

Important

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

  • Initializes a new instance of SearchConfiguration with the specified parameters.

    Declaration

    Swift

    public init(
    categories: Set<POICategoryID> = Defaults.categories,
    detourTime: Measurement<UnitDuration> = Defaults.detourTime,
    numberOfResults: UInt = Defaults.numberOfResults,
    minPower: Measurement<UnitPower>? = nil,
    maxPower: Measurement<UnitPower>? = nil,
    engineType: EngineType? = nil,
    openingHoursMode: OpeningHoursMode? = .nextSevenDays(from: Date())
)

    Parameters

    categories

    A set of TomTomSDKPOIVisualization/POI categories used for the search. Default categories include places commonly researched, like restaurants, parking areas, and hotels.
    detourTime

    The maximum allowed detour time for a TomTomSDKPOIVisualization/POI. Specifies how much extra time a user is willing to spend to reach a TomTomSDKPOIVisualization/POI from their route. Defaults to 15 minutes.
    numberOfResults

    The maximum number of TomTomSDKPOIVisualization/POI results to retrieve. Limits the number of results returned from a TomTomSDKPOIVisualization/POI search. Defaults to 20.
    minPower

    The minimum power requirement for a charging station. It is useful for filtering out charging stations below a certain power level. If not provided, no minimum power filter is applied.
    maxPower

    The maximum power limit for a charging station. Useful for filtering out charging stations that exceed a certain power. If not provided, no maximum power filter is applied.
    engineType

    Specifies the engine type for vehicles to filter TomTomSDKPOIVisualization/POIs based on vehicle type. If not provided, no engine-type filter is applied. If electric(connectors:) is selected, it restricts the results to Points Of Interest of type Electric Vehicle Station. supporting the specified connectors. If combustion(fuelTypes:) is selected, it restricts the results to Points Of Interest with the specified fuelTypes.
    openingHoursMode

    Scope of the opening hours to be provided. If the parameter is set to nil, no opening hours are returned in the response. By default, requests opening hours for the next seven (7) days. If a chosen mode contains an associated start date, it is ignored by the backend.

  • The set of categories used for the TomTomSDKPOIVisualization/POI search.

    These categories determine the types of places in which you are interested, such as restaurants, hotels, or parking areas.

    Declaration

    Swift

    public let categories: Set<POICategoryID>

  • The maximum allowed detour time when searching for a TomTomSDKPOIVisualization/POI.

    This property specifies how much extra time a user is willing to spend to reach a TomTomSDKPOIVisualization/POI. from their route.

    Declaration

    Swift

    public let detourTime: Measurement<UnitDuration>

  • The maximum number of TomTomSDKPOIVisualization/POI results to retrieve.

    This property limits the number of results returned from a TomTomSDKPOIVisualization/POI search.

    Declaration

    Swift

    public let numberOfResults: UInt

  • The minimum power requirement for a charging station.

    Use this property to filter out charging stations that don’t provide the required minimum power.

    Declaration

    Swift

    internal(set) public var minPower: Measurement<UnitPower>? { get }

  • The maximum power limit for a charging station.

    Use this property to filter out charging stations that exceed the maximum power limit.

    Declaration

    Swift

    internal(set) public var maxPower: Measurement<UnitPower>? { get }

  • Specifies the engine type for vehicles.

    This property helps in filteringTomTomSDKPOIVisualization/POIs based on vehicle engine type, whether it’s electric, combustion, or hybrid.

    Declaration

    Swift

    internal(set) public var engineType: EngineType? { get }

  • Contains default values for various TomTomSDKPOIVisualization/POI search configuration parameters.

    Important

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

    Declaration

    Swift

    public enum Defaults

  • An enumeration representing different types of vehicle engines and their associated criteria.

    Use this enum to specify engine-related search criteria in the configuration. Depending on the engine type, you can provide further details like the types of connectors for electric vehicles or fuel types for combustion vehicles.

    Important

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

    Declaration

    Swift

    public enum EngineType