TTAlongRouteSearchQueryBuilder
@interface TTAlongRouteSearchQueryBuilder : NSObject
TTAlongRouteSearchQueryBuilder
-
Init of TTAlongRouteSearchQueryBuilder object
Declaration
Objective-C
- (instancetype _Nonnull)initWithTerm:(NSString *_Nonnull)term withRoute:(id _Nonnull)route withMaxDetourTime:(int)maxDetourTime;
Swift
init(term: String, withRoute route: Any, withMaxDetourTime maxDetourTime: Int32)
Parameters
term
Object containing the data needed to perform a search.
route
Route object with list of coordination.
maxDetourTime
Maximum detour time. Max value is 3600.
Return Value
TTAlongRouteSearchQuery object.
-
Builder of TTAlongRouteSearchQueryBuilder object
Declaration
Objective-C
+ (TTAlongRouteSearchQueryBuilder *_Nonnull)withTerm:(NSString *_Nonnull)term withRoute:(id _Nonnull)route withMaxDetourTime:(int)maxDetourTime;
Swift
class func withTerm(_ term: String, withRoute route: Any, withMaxDetourTime maxDetourTime: Int32) -> TTAlongRouteSearchQueryBuilder
Parameters
term
Object containing the data needed to perform a search.
route
Route object with list of coordination.
maxDetourTime
Maximum detour time. Max value is 3600.
Return Value
TTAlongRouteSearchQuery object.
-
Part of builder TTAlongRouteSearchQueryBuilder obejct.
Declaration
Objective-C
- (TTAlongRouteSearchQueryBuilder *_Nonnull)withLimit:(int)limit;
Swift
func withLimit(_ limit: Int32) -> TTAlongRouteSearchQueryBuilder
Parameters
limit
Maximum number of responses that will be returned. Default value 10.
Return Value
TTAlongRouteSearchQuery object.
-
A comma-separated list of brand names which could be used to restrict the result to Points Of Interest of specific brands.
Declaration
Objective-C
- (TTAlongRouteSearchQueryBuilder *_Nonnull)withBrandSet: (NSString *_Nonnull)brandSet;
Swift
func withBrandSet(_ brandSet: String) -> TTAlongRouteSearchQueryBuilder
Parameters
brandSet
A comma-separated list of brand names.
Return Value
TTAlongRouteSearchQuery object.
-
Bitmask of TTEVConnectorTypes be used to restrict the result to Points Of Interest of type Electric Vehicle Station supporting specific connector types.
Declaration
Objective-C
- (TTAlongRouteSearchQueryBuilder *_Nonnull)withEVConnectorTypeSet: (TTEVConnectorTypes)connectorTypesSet;
Swift
func withEVConnectorTypeSet(_ connectorTypesSet: TTEVConnectorTypes) -> TTAlongRouteSearchQueryBuilder
Parameters
connectorTypesSet
TTEVConnectorTypes
Return Value
TTSearchQueryBuilder
-
Specifies HTTP headers for the Request. It can be used to trace a call.
Declaration
Objective-C
- (TTAlongRouteSearchQueryBuilder *_Nonnull)withHTTPHeaders:(id)headers;
Swift
func withHTTPHeaders(_ headers: Any!) -> TTAlongRouteSearchQueryBuilder
Parameters
headers
HTTP headers for the Request
Return Value
TTAlongRouteSearchQueryBuilder
-
Parameter which turns on calculation of the distance between the start of the route and the starting point of the detour to a POI.
Declaration
Objective-C
- (TTAlongRouteSearchQueryBuilder *_Nonnull)withDetourOffset;
Swift
func withDetourOffset() -> TTAlongRouteSearchQueryBuilder
Return Value
TTAlongRouteSearchQueryBuilder
-
Parameter which provides possibility to sort returned results.
Declaration
Objective-C
- (TTAlongRouteSearchQueryBuilder *_Nonnull)withSortBy: (TTAlongRouteSearchSortByMode)sortByMode;
Swift
func withSortBy(_ sortByMode: TTAlongRouteSearchSortByMode) -> TTAlongRouteSearchQueryBuilder
Parameters
sortByMode
TTAlongRouteSearchSortByMode
Return Value
TTAlongRouteSearchQueryBuilder
-
Enables the spreading of returned results evenly along the route.
Declaration
Objective-C
- (TTAlongRouteSearchQueryBuilder *_Nonnull)withSpreadingMode: (TTAlongRouteSpreadingMode)spreadingMode;
Swift
func withSpreadingMode(_ spreadingMode: TTAlongRouteSpreadingMode) -> TTAlongRouteSearchQueryBuilder
Parameters
spreadingMode
TTAlongRouteSpreadingMode
Return Value
TTAlongRouteSearchQueryBuilder
-
List of opening hours for a POI (Points of Interest).
Declaration
Objective-C
- (TTAlongRouteSearchQueryBuilder *_Nonnull)withOpeningHours: (TTOpeningHoursEnum)openingHours;
Swift
func withOpeningHours(_ openingHours: TTOpeningHoursEnum) -> TTAlongRouteSearchQueryBuilder
Parameters
openingHours
The opening hours mode.
Return Value
TTAlongRouteSearchQueryBuilder
-
Enables the return of a comma-separated mapcodes list. Can also filter the Response to only show selected mapcode types.
Declaration
Objective-C
- (TTAlongRouteSearchQueryBuilder *_Nonnull)withMapCodes: (TTMapCodeOptions)mapCodes;
Swift
func withMapCodes(_ mapCodes: TTMapCodeOptions = []) -> TTAlongRouteSearchQueryBuilder
Parameters
mapCodes
An array of enum types indicating supported MapCodes.
Return Value
TTAlongRouteSearchQueryBuilder
-
Used to indicate the mode in which the timeZone object should be returned.
Declaration
Objective-C
- (TTAlongRouteSearchQueryBuilder *_Nonnull)withTimeZone: (TTTimeZoneEnum)timeZone;
Swift
func withTimeZone(_ timeZone: TTTimeZoneEnum) -> TTAlongRouteSearchQueryBuilder
Parameters
timeZone
The enum indicating the type of the time zone. @result TTAlongRouteSearchQueryBuilder
-
Build method.
Declaration
Objective-C
- (TTAlongRouteSearchQuery *_Nonnull)build;
Swift
func build() -> TTAlongRouteSearchQuery
Return Value
TTAlongRouteSearchQuery object.