SearchParameters

public struct SearchParameters : Codable, Equatable

SearchParameters instances represent query setup for a search request. Use SearchParameters.query to directly create a search query with the default search configuration.

Properties

query
Query string (mandatory).
Declaration
Swift

public let query: String?
limit
Number of documents to take.
Declaration
Swift

public let limit: Int?
offset
Number of documents to skip.
Declaration
Swift

public let offset: Int?
attributesToRetrieve
Document attributes to show.
Declaration
Swift

public let attributesToRetrieve: [String]?
attributesToCrop
Which attributes to crop.
Declaration
Swift

public let attributesToCrop: [String]?
cropLength
Limit length at which to crop specified attributes.
Declaration
Swift

public let cropLength: Int?
attributesToHighlight
Which attributes to highlight.
Declaration
Swift

public let attributesToHighlight: [String]?
filter
Filter on attributes values.
Declaration
Swift

public let filter: String?
sort
Filter on attributes values.
Declaration
Swift

public let sort: [String]?
facetsDistribution
Retrieve the count of matching terms for each facets.
Declaration
Swift

public let facetsDistribution: [String]?
matches
Whether to return the raw matches or not.
Declaration
Swift

public let matches: Bool?

Initializers


                    
                    
                    init(query:offset:limit:attributesToRetrieve:attributesToCrop:cropLength:attributesToHighlight:filter:sort:facetsDistribution:matches:)

Undocumented

Declaration

Swift

public init(
  query: String?,
  offset: Int? = nil,
  limit: Int? = nil,
  attributesToRetrieve: [String]? = nil,
  attributesToCrop: [String]? = nil,
  cropLength: Int? = nil,
  attributesToHighlight: [String]? = nil,
  filter: String? = nil,
  sort: [String]? = nil,
  facetsDistribution: [String]? = nil,
  matches: Bool? = nil)

Query Initializers


                    
                    
                    query(_:)

Minimal static function used to easily initialize the SearchParameters instance with the search query applied.

Declaration

Swift

public static func query(_ value: String) -> SearchParameters

Parameters


                                value

Query string (mandatory).