AlongRouteQueryBuilder

public class AlongRouteQueryBuilder

Builder for AlongRouteQuery. Optional parameters can be set using With methods.

Important

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


                    
                    
                    create(route:maxDetourTime:query:)

Create method for a AlongRouteQuery object.

Swift

public class func create(
    route: [SearchRoutePoint],
    maxDetourTime: Int,
    query: String
)
    -> AlongRouteQueryBuilder

`route`	Route object with list of coordinates.
`maxDetourTime`	Maximum detour time in seconds. Max value is 3600.
`query`	Object containing the data needed to perform a search.

AlongRouteQueryBuilder object.


                    
                    
                    withCategorySet(categories:)

Builder method that allows adding a category to the AlongRouteQueryBuilder.

Swift

@discardableResult
public func withCategorySet(categories: [Int]) -> AlongRouteQueryBuilder


                                categories

The list of categories can be discovered using the POICategoriesRequest.

AlongRouteQueryBuilder object.


                    
                    
                    withResultLimit(limit:)

Builder method that allows adding a limit to the AlongRouteQueryBuilder.

Swift

@discardableResult
public func withResultLimit(limit: Int) -> AlongRouteQueryBuilder


                                limit

limit Maximum number of responses that will be returned.

AlongRouteQueryBuilder object.