PlacesQuery

@objc
public class PlacesQuery : AbstractQuery

Search parameters for Algolia Places.

See also

PlacesClient.search(...)

Initialization

  • Construct a query with the specified full text query.

    Declaration

    Swift

    @objc
public convenience init(query: String?)

  • Clone an existing query.

    Declaration

    Swift

    @objc
public convenience init(copy: PlacesQuery)

NSCopying

  • Support for NSCopying.

    Note

    Primarily intended for Objective-C use. Swift coders should use init(copy:).

    Declaration

    Swift

    @objc
public override func copy(with zone: NSZone?) -> Any

Serialization & parsing

  • Parse a query from a URL query string.

    Declaration

    Swift

    @objc
public static func parse(_ queryString: String) -> PlacesQuery

Parameters

  • Full text query.

    Declaration

    Swift

    @objc
public var query: String? { get set }

  • Types of places that can be searched for.

    See also

    The type parameter.
    See more

    Declaration

    Swift

    public enum Type : String

  • Restrict the search results to a specific type. If nil, searches in all types. Default: nil.

    Declaration

    Swift

    public var type: Type? { get set }

  • Specifies how many results you want to retrieve per search. Default: 20.

    Declaration

    Swift

    public var hitsPerPage: UInt? { get set }

  • If specified, restrict the search results to a single language. You can pass two letters country codes (ISO 639-1).

    Declaration

    Swift

    @objc
public var language: String? { get set }

  • If specified, restrict the search results to a specific list of countries. You can pass two letters country codes (ISO 3166-1).

    Default: Search on the whole planet.

    Declaration

    Swift

    @objc
public var countries: [String]? { get set }

  • Force to first search around a specific latitude/longitude.

    The default is to search around the location of the user determined via his IP address (geoip).

    Declaration

    Swift

    @objc
public var aroundLatLng: LatLng? { get set }

  • Whether or not to first search around the geolocation of the user found via his IP address. Default: true.

    Declaration

    Swift

    public var aroundLatLngViaIP: Bool? { get set }

  • Applicable values for the aroundRadius parameter.

    See more

    Declaration

    Swift

    public enum AroundRadius : Equatable

  • Radius in meters to search around the latitude/longitutde. Otherwise a default radius is automatically computed given the area density.

    Declaration

    Swift

    public var aroundRadius: AroundRadius? { get set }

  • String marking the beginning of highlighted text in the response. Default: <em>.

    Declaration

    Swift

    @objc
public var highlightPreTag: String? { get set }

  • String marking the end of highlighted text in the response. Default: </em>.

    Declaration

    Swift

    @objc
public var highlightPostTag: String? { get set }