Discover Class Reference


                    
                    
                    apiType

Undocumented

Declaration

Swift

public let apiType: ApiType


                    
                    
                    init(accessToken:locationProvider:apiType:)

Basic internal initializer

Declaration

Swift

public convenience init(
    accessToken: String? = nil,
    locationProvider: LocationProvider? = DefaultLocationProvider(),
    apiType: ApiType = .searchBox
)

Parameters

`accessToken`	Mapbox Access Token to be used. Info.plist value for key `MBXAccessToken` will be used for `nil` argument
`locationProvider`	Provider configuration of `LocationProvider` that would grant location data by default
`apiType`	Specifies which API provider to use through this search feature. Defaults to `searchBox`.


                    
                    
                    search(for:proximity:options:completion:)

Search for places nearby the specified geographic point.

Declaration

Swift

public func search(
    for item: Discover.Query,
    proximity: CLLocationCoordinate2D,
    options: Options = .init(),
    completion: @escaping (Swift.Result<[Result], Error>) -> Void
)

Parameters

`item`	Search item
`proximity`	Geographic point to search nearby.
`options`	Search options
`completion`	Result of the search request, one of error or value.


                    
                    
                    search(for:in:proximity:options:completion:)

Search for places nearby the specified geographic point.

Declaration

Swift

public func search(
    for item: Discover.Query,
    in region: BoundingBox,
    proximity: CLLocationCoordinate2D? = nil,
    options: Options = .init(),
    completion: @escaping (Swift.Result<[Result], Error>) -> Void
)

Parameters

`item`	Search query.
`region`	Limit results to only those contained within the supplied bounding box.
`proximity`	Optional geographic point to search nearby.
`options`	Search options
`completion`	Result of the search request, one of error or value.


                    
                    
                    search(for:route:options:completion:)

Search for places nearby the specified geographic point.

Declaration

Swift

public func search(
    for item: Discover.Query,
    route: RouteOptions,
    options: Options = .init(),
    completion: @escaping (Swift.Result<[Result], Error>) -> Void
)

Parameters

`item`	Search item
`route`	Route to search across (points and deviation options).
`options`	Search options
`completion`	Result of the search request, one of error or value.


                    
                    
                    Address

Undocumented

Declaration

Swift

public struct Address


                    
                    
                    Options

Wraps parameters for Discover/Category searches. Use this to provide arguments that narrow your search.

Declaration

Swift

public struct Options


                    
                    
                    Query

String representing a category name to be searched for. Use one of the suggested categories listed in the enum extension or search for a given string.

Declaration

Swift

public struct Query


                    
                    
                    Result

Undocumented

Declaration

Swift

public struct Result