Class

algolia.objects

Query

Related Doc: package objects

Permalink

case class Query(distinct: Option[Distinct] = None, getRankingInfo: Option[Boolean] = None, numericFilters: Option[Seq[String]] = None, tagFilters: Option[Seq[String]] = None, analytics: Option[Boolean] = None, analyticsTags: Option[Seq[String]] = None, synonyms: Option[Boolean] = None, replaceSynonymsInHighlight: Option[Boolean] = None, minProximity: Option[Int] = None, responseFields: Option[Seq[String]] = None, maxFacetHits: Option[Int] = None, percentileComputation: Option[Boolean] = None, attributesToRetrieve: Option[Seq[String]] = None, restrictSearchableAttributes: Option[Seq[String]] = None, filters: Option[String] = None, facets: Option[Seq[String]] = None, maxValuesPerFacet: Option[Int] = None, facetFilters: Option[Seq[String]] = None, facetingAfterDistinct: Option[Boolean] = None, aroundLatLng: Option[AroundLatLng] = None, aroundLatLngViaIP: Option[Boolean] = None, aroundRadius: Option[AroundRadius] = None, aroundPrecision: Option[Int] = None, minimumAroundRadius: Option[Int] = None, insideBoundingBox: Option[Seq[InsideBoundingBox]] = None, insidePolygon: Option[Seq[InsidePolygon]] = None, attributesToHighlight: Option[Seq[String]] = None, attributesToSnippet: Option[Seq[String]] = None, highlightPreTag: Option[String] = None, highlightPostTag: Option[String] = None, snippetEllipsisText: Option[String] = None, restrictHighlightAndSnippetArrays: Option[Boolean] = None, page: Option[Int] = None, hitsPerPage: Option[Int] = None, offset: Option[Int] = None, length: Option[Int] = None, queryType: Option[QueryType] = None, removeWordsIfNoResults: Option[RemoveWordsIfNoResults] = None, advancedSyntax: Option[Boolean] = None, optionalWords: Option[Seq[String]] = None, removeStopWords: Option[RemoveStopWords] = None, disableExactOnAttributes: Option[Seq[String]] = None, exactOnSingleWordQuery: Option[Seq[String]] = None, alternativesAsExact: Option[Seq[String]] = None, query: Option[String] = None, facetQuery: Option[String] = None, minWordSizefor1Typo: Option[Int] = None, minWordSizefor2Typos: Option[Int] = None, typoTolerance: Option[TypoTolerance] = None, allowTyposOnNumericTokens: Option[Boolean] = None, ignorePlurals: Option[IgnorePlurals] = None, disableTypoToleranceOnAttributes: Option[Seq[String]] = None, userToken: Option[String] = None, validUntil: Option[Int] = None, restrictIndices: Option[Seq[String]] = None, restrictSources: Option[String] = None, cursor: Option[String] = None, customParameters: Option[Map[String, String]] = None) extends Product with Serializable

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Query
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Query(distinct: Option[Distinct] = None, getRankingInfo: Option[Boolean] = None, numericFilters: Option[Seq[String]] = None, tagFilters: Option[Seq[String]] = None, analytics: Option[Boolean] = None, analyticsTags: Option[Seq[String]] = None, synonyms: Option[Boolean] = None, replaceSynonymsInHighlight: Option[Boolean] = None, minProximity: Option[Int] = None, responseFields: Option[Seq[String]] = None, maxFacetHits: Option[Int] = None, percentileComputation: Option[Boolean] = None, attributesToRetrieve: Option[Seq[String]] = None, restrictSearchableAttributes: Option[Seq[String]] = None, filters: Option[String] = None, facets: Option[Seq[String]] = None, maxValuesPerFacet: Option[Int] = None, facetFilters: Option[Seq[String]] = None, facetingAfterDistinct: Option[Boolean] = None, aroundLatLng: Option[AroundLatLng] = None, aroundLatLngViaIP: Option[Boolean] = None, aroundRadius: Option[AroundRadius] = None, aroundPrecision: Option[Int] = None, minimumAroundRadius: Option[Int] = None, insideBoundingBox: Option[Seq[InsideBoundingBox]] = None, insidePolygon: Option[Seq[InsidePolygon]] = None, attributesToHighlight: Option[Seq[String]] = None, attributesToSnippet: Option[Seq[String]] = None, highlightPreTag: Option[String] = None, highlightPostTag: Option[String] = None, snippetEllipsisText: Option[String] = None, restrictHighlightAndSnippetArrays: Option[Boolean] = None, page: Option[Int] = None, hitsPerPage: Option[Int] = None, offset: Option[Int] = None, length: Option[Int] = None, queryType: Option[QueryType] = None, removeWordsIfNoResults: Option[RemoveWordsIfNoResults] = None, advancedSyntax: Option[Boolean] = None, optionalWords: Option[Seq[String]] = None, removeStopWords: Option[RemoveStopWords] = None, disableExactOnAttributes: Option[Seq[String]] = None, exactOnSingleWordQuery: Option[Seq[String]] = None, alternativesAsExact: Option[Seq[String]] = None, query: Option[String] = None, facetQuery: Option[String] = None, minWordSizefor1Typo: Option[Int] = None, minWordSizefor2Typos: Option[Int] = None, typoTolerance: Option[TypoTolerance] = None, allowTyposOnNumericTokens: Option[Boolean] = None, ignorePlurals: Option[IgnorePlurals] = None, disableTypoToleranceOnAttributes: Option[Seq[String]] = None, userToken: Option[String] = None, validUntil: Option[Int] = None, restrictIndices: Option[Seq[String]] = None, restrictSources: Option[String] = None, cursor: Option[String] = None, customParameters: Option[Map[String, String]] = None)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. val advancedSyntax: Option[Boolean]

    Permalink

  5. val allowTyposOnNumericTokens: Option[Boolean]

    Permalink

  6. val alternativesAsExact: Option[Seq[String]]

    Permalink

  7. val analytics: Option[Boolean]

    Permalink

  8. val analyticsTags: Option[Seq[String]]

    Permalink

  9. val aroundLatLng: Option[AroundLatLng]

    Permalink

  10. val aroundLatLngViaIP: Option[Boolean]

    Permalink

  11. val aroundPrecision: Option[Int]

    Permalink

  12. val aroundRadius: Option[AroundRadius]

    Permalink

  13. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  14. val attributesToHighlight: Option[Seq[String]]

    Permalink

  15. val attributesToRetrieve: Option[Seq[String]]

    Permalink

  16. val attributesToSnippet: Option[Seq[String]]

    Permalink

  17. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  18. val cursor: Option[String]

    Permalink

  19. val customParameters: Option[Map[String, String]]

    Permalink

  20. val disableExactOnAttributes: Option[Seq[String]]

    Permalink

  21. val disableTypoToleranceOnAttributes: Option[Seq[String]]

    Permalink

  22. val distinct: Option[Distinct]

    Permalink

  23. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  24. val exactOnSingleWordQuery: Option[Seq[String]]

    Permalink

  25. val facetFilters: Option[Seq[String]]

    Permalink

  26. val facetingAfterDistinct: Option[Boolean]

    Permalink

  27. val facets: Option[Seq[String]]

    Permalink

  28. val filters: Option[String]

    Permalink

  29. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  30. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  31. val getRankingInfo: Option[Boolean]

    Permalink

  32. val highlightPostTag: Option[String]

    Permalink

  33. val highlightPreTag: Option[String]

    Permalink

  34. val hitsPerPage: Option[Int]

    Permalink

  35. val ignorePlurals: Option[IgnorePlurals]

    Permalink

  36. val insideBoundingBox: Option[Seq[InsideBoundingBox]]

    Permalink

  37. val insidePolygon: Option[Seq[InsidePolygon]]

    Permalink

  38. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  39. val length: Option[Int]

    Permalink

  40. val maxFacetHits: Option[Int]

    Permalink

  41. val maxValuesPerFacet: Option[Int]

    Permalink

  42. val minProximity: Option[Int]

    Permalink

  43. val minWordSizefor1Typo: Option[Int]

    Permalink

  44. val minWordSizefor2Typos: Option[Int]

    Permalink

  45. val minimumAroundRadius: Option[Int]

    Permalink

  46. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  47. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  48. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  49. val numericFilters: Option[Seq[String]]

    Permalink

  50. val offset: Option[Int]

    Permalink

  51. val optionalWords: Option[Seq[String]]

    Permalink

  52. val page: Option[Int]

    Permalink

  53. val percentileComputation: Option[Boolean]

    Permalink

  54. val query: Option[String]

    Permalink

  55. val queryType: Option[QueryType]

    Permalink

  56. val removeStopWords: Option[RemoveStopWords]

    Permalink

  57. val removeWordsIfNoResults: Option[RemoveWordsIfNoResults]

    Permalink

  58. val replaceSynonymsInHighlight: Option[Boolean]

    Permalink

  59. val responseFields: Option[Seq[String]]

    Permalink

  60. val restrictHighlightAndSnippetArrays: Option[Boolean]

    Permalink

  61. val restrictIndices: Option[Seq[String]]

    Permalink

  62. val restrictSearchableAttributes: Option[Seq[String]]

    Permalink

  63. val restrictSources: Option[String]

    Permalink

  64. val snippetEllipsisText: Option[String]

    Permalink

  65. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  66. val synonyms: Option[Boolean]

    Permalink

  67. val tagFilters: Option[Seq[String]]

    Permalink

  68. def toParam: String

    Permalink

  69. def toQueryParam: Map[String, String]

    Permalink

  70. val typoTolerance: Option[TypoTolerance]

    Permalink

  71. val userToken: Option[String]

    Permalink

  72. val validUntil: Option[Int]

    Permalink

  73. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  74. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  75. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped