AbstractQuery

@objc
open class AbstractQuery : NSObject, NSCopying

An abstract search query.

Warning

This class is not meant to be used directly. Please see Query or PlacesQuery instead.

KVO

Every parameter is observable via KVO under its own name.

Low-level (untyped) parameters

  • Parameters, as untyped values.

    Declaration

    Swift

    @objc
public private(set) var parameters: [String : String]

  • Get a parameter in an untyped fashion.

    Declaration

    Swift

    @objc
public func parameter(withName name: String) -> String?

    Parameters

    name

    The parameter’s name.

    Return Value

    The parameter’s value, or nil if a parameter with the specified name does not exist.

  • Set a parameter in an untyped fashion. This low-level accessor is intended to access parameters that this client does not yet support.

    Declaration

    Swift

    @objc
public func setParameter(withName name: String, to value: String?)

    Parameters

    name

    The parameter’s name.
    value

    The parameter’s value, or nill to remove it.

  • Convenience shortcut to parameter(withName:) and setParameter(withName:to:).

    Declaration

    Swift

    @objc
public subscript(index: String) -> String? { get set }

Initialization

  • Construct an empty query.

    Declaration

    Swift

    @objc
public override init()

  • Construct a query with the specified low-level parameters.

    Declaration

    Swift

    @objc
public init(parameters: [String : String])

  • Clear all parameters.

    Declaration

    Swift

    @objc
open func clear()

NSCopying

  • Support for NSCopying.

    Note

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

    Declaration

    Swift

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

Serialization & parsing

  • Return the final query string used in URL.

    Declaration

    Swift

    @objc
open func build() -> String

  • Build a query string from a set of parameters.

    Declaration

    Swift

    @objc
public static func build(parameters: [String : String]) -> String