PlaceFilter Structure Reference
- Last UpdatedJun 10, 2025
- 3 minute read
public struct PlaceFilter : Hashable
The filter options to specify a place. Consists of fuel, truck and EV options.
-
The list of
FuelType
elements that should be used to find only theFuelStation
search results that support all of them. This filter is available to use with theSearchEngine
andOfflineSearchEngine
(not available for all editions), howeverOfflineSearchEngine
supports it only forsearchByText
andsearchByCategory
with allowed fuel typesDIESEL
,LPG
,BIO_DIESEL
,CNG
,DIESEL_WITH_ADDITIVES
,E10
,E85
,ETHANOL
,ETHANOL_WITH_ADDITIVES
,GASOLINE
,HYDROGEN
,LNG
,MIDGRADE
,PREMIUM
andREGULAR
.Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.
Declaration
Swift
public var fuelTypes: [FuelType]
-
The list of
TruckFuelType
elements that should be used to find only theFuelStation
search results that support all of them. Not supported forsuggestByText
inOfflineSearchEngine
(not available in all editions).Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.
Declaration
Swift
public var truckFuelTypes: [TruckFuelType]
-
Should be used to find only the
FuelStation
search results with minimum supportedTruckClass
. This filter is only available to use with theSearchEngine
. TheOfflineSearchEngine
(not available for all editions) does not apply this filter.TruckClass.lightClass
is not accepted in the filter. Otherwise will result inSearchError.invalidTruckClass
.Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.
Declaration
Swift
public var truckClass: TruckClass?
-
Constraints that are applicable on the places of category EV station.
Declaration
Swift
public var ev: PlaceFilter.Ev
-
Creates a new instance.
Parameters
- fuelTypes: The list of
FuelType
elements that should be used to find only theFuelStation
search results that support all of them. This filter is available to use with theSearchEngine
andOfflineSearchEngine
(not available for all editions), howeverOfflineSearchEngine
supports it only forsearchByText
andsearchByCategory
with allowed fuel typesDIESEL
,LPG
,BIO_DIESEL
,CNG
,DIESEL_WITH_ADDITIVES
,E10
,E85
,ETHANOL
,ETHANOL_WITH_ADDITIVES
,GASOLINE
,HYDROGEN
,LNG
,MIDGRADE
,PREMIUM
andREGULAR
.
Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.
- truckFuelTypes: The list of
TruckFuelType
elements that should be used to find only theFuelStation
search results that support all of them. Not supported forsuggestByText
inOfflineSearchEngine
(not available in all editions).
Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.
- truckClass: Should be used to find only the
FuelStation
search results with minimum supportedTruckClass
. This filter is only available to use with theSearchEngine
. TheOfflineSearchEngine
(not available for all editions) does not apply this filter.TruckClass.lightClass
is not accepted in the filter. Otherwise will result inSearchError.invalidTruckClass
.
Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.
- ev: Constraints that are applicable on the places of category EV station.
- fuelTypes: The list of
Declaration
Swift
public init(fuelTypes: [FuelType] = [], truckFuelTypes: [TruckFuelType] = [], truckClass: TruckClass? = nil, ev: PlaceFilter.Ev = PlaceFilter.Ev())
-
Constraints that are applicable on the places of category EV station.
See moreDeclaration
Swift
public struct Ev : Hashable