StructuredQuery

public struct StructuredQuery : Hashable

The options to specify a structured query. Only supported in OfflineSearchEngine (only available for the Navigate license).

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.

  • Desired query to search.

    Declaration

    Swift

    public var query: String

  • Geographic coordinates of the prioritized area center.

    Declaration

    Swift

    public var areaCenter: GeoCoordinates

  • Query address elements to get the results from a specific geographical area.

    Declaration

    Swift

    public var addressElements: StructuredQuery.AddressElements

  • An optional field to indicates the type of result expected.

    Declaration

    Swift

    public var resultType: StructuredQuery.ResultType?

  • Creates a new instance.

    Declaration

    Swift

    public init(query: String, areaCenter: GeoCoordinates, addressElements: StructuredQuery.AddressElements = StructuredQuery.AddressElements(), resultType: StructuredQuery.ResultType? = nil)

  • Specifies expected result type.

    See more

    Declaration

    Swift

    public enum ResultType : UInt32, CaseIterable, Codable

  • Defines query address elements which will be used to build address hierarchy during searches. It is advised to provide at least one intermediate address element when a large address element is provided for small admin area searches. For example if a user is building a query for a street and providing only country as an address element, consider providing city along with it.

    See more

    Declaration

    Swift

    public struct AddressElements : Hashable