QueryType

public struct QueryType : Equatable, Sendable

A type that represents a search query filter.

Use the provided static constants to specify which kinds of results to include in a search.

let options = SearchOptions(types: [.place, .address])
  • Undocumented

    Declaration

    Swift

    public let rawValue: String
  • Generally recognized countries or, in some cases like Hong Kong, an area of quasi-national administrative status that has been given a designated country code under ISO 3166-1.

    Declaration

    Swift

    public static let country: QueryType
  • Top-level sub-national administrative features, such as states in the United States or provinces in Canada or China.

    Declaration

    Swift

    public static let region: QueryType
  • Postal codes used in country-specific national addressing systems.

    Declaration

    Swift

    public static let postcode: QueryType
  • Features that are smaller than top-level administrative features but typically larger than cities, in countries that use such an additional layer in postal addressing (for example, prefectures in China).

    Declaration

    Swift

    public static let district: QueryType
  • Typically these are cities, villages, municipalities, etc. They’re usually features used in postal addressing, and are suitable for display in ambient end-user applications where current-location context is needed (for example, in weather displays).

    Declaration

    Swift

    public static let place: QueryType
  • Official sub-city features present in countries where such an additional administrative layer is used in postal addressing, or where such features are commonly referred to in local parlance. Examples include city districts in Brazil and Chile and arrondissements in France.

    Declaration

    Swift

    public static let locality: QueryType
  • Colloquial sub-city features often referred to in local parlance. Unlike locality features, these typically lack official status and may lack universally agreed-upon boundaries.

    Declaration

    Swift

    public static let neighborhood: QueryType
  • Individual residential or business addresses.

    Declaration

    Swift

    public static let address: QueryType
  • poi

    Points of interest. These include restaurants, stores, concert venues, parks, museums, etc.

    Declaration

    Swift

    public static let poi: QueryType
  • The street, with no house number.

    Note

    Single-Box Search API only

    Declaration

    Swift

    public static let street: QueryType
  • Search for categories.

    Note

    Single-Box Search API only

    Declaration

    Swift

    public static let category: QueryType
  • Search for categories.

    Note

    Single-Box Search API only

    Declaration

    Swift

    public static let brand: QueryType