case class SearchQuery(parameterHolder: Map[String, Parameter] = Map.empty) extends PaginatedApiQuery[SearchResponse, Content] with SearchQueryBase[SearchQuery] with Product with Serializable

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SearchQuery
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. SearchQueryBase
  7. FilterSearchParameters
  8. FilterExtendedParameters
  9. FilterParameters
  10. PaginationParameters
  11. UseDateParameter
  12. OrderByParameter
  13. ShowReferencesParameters
  14. ShowParameters
  15. Parameters
  16. PaginatedApiQuery
  17. ContentApiQuery
  18. AnyRef
  19. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SearchQuery(parameterHolder: Map[String, Parameter] = Map.empty)

Type Members

  1. case class BoolParameter(name: String, value: Option[Boolean] = None) extends Owner.OwnedParameter with Product with Serializable
    Definition Classes
    Parameters
  2. case class DateParameter(name: String, value: Option[Instant] = None) extends Owner.OwnedParameter with Product with Serializable
    Definition Classes
    Parameters
  3. case class IntParameter(name: String, value: Option[Int] = None) extends Owner.OwnedParameter with Product with Serializable
    Definition Classes
    Parameters
  4. trait OwnedParameter extends Parameter
    Attributes
    protected
    Definition Classes
    Parameters
  5. case class StringParameter(name: String, value: Option[String] = None) extends Owner.OwnedParameter with Product with Serializable
    Definition Classes
    Parameters

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def boolParam(key: String, value: Boolean): SearchQuery
    Definition Classes
    Parameters
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  7. def commentable: BoolParameter
    Definition Classes
    FilterExtendedParameters
  8. def containsElement: StringParameter
    Definition Classes
    FilterExtendedParameters
  9. def contentType: StringParameter
    Definition Classes
    FilterExtendedParameters
  10. def dateParam(key: String, value: Instant): SearchQuery
    Definition Classes
    Parameters
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def filename: StringParameter
    Definition Classes
    FilterExtendedParameters
  13. def followingQueryGiven(response: SearchResponse, direction: Direction): Option[PaginatedApiQuery[SearchResponse, Content]]
    Definition Classes
    PaginatedApiQuery
  14. def followingQueryGivenFull(response: SearchResponse, direction: Direction): Option[FollowingSearchQuery]

    Construct a query for the subsequent results after this response.

    Construct a query for the subsequent results after this response. This method will only be called if the response was supplied a full page of results, meaning that there's the possibility of more results to fetch.

    Attributes
    protected
    Definition Classes
    SearchQuery → PaginatedApiQuery
  15. def fromDate: DateParameter
    Definition Classes
    FilterExtendedParameters
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. def getUrl(targetUrl: String, customParameters: Map[String, String] = Map.empty): String
    Definition Classes
    ContentApiQuery
  18. def has(param: String): Boolean
    Definition Classes
    Parameters
  19. def ids: StringParameter
    Definition Classes
    FilterExtendedParameters
  20. def intParam(key: String, value: Int): SearchQuery
    Definition Classes
    Parameters
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. def lang: StringParameter
    Definition Classes
    FilterExtendedParameters
  23. def leadContent: StringParameter
    Definition Classes
    FilterExtendedParameters
  24. def membershipAccess: StringParameter
    Definition Classes
    FilterExtendedParameters
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  28. def orderBy: StringParameter
    Definition Classes
    OrderByParameter
  29. def page: IntParameter
    Definition Classes
    PaginationParameters
  30. def pageSize: IntParameter
    Definition Classes
    PaginationParameters
  31. val parameterHolder: Map[String, Parameter]
    Definition Classes
    SearchQuery → Parameters
  32. def parameters: Map[String, String]
    Definition Classes
    Parameters
  33. def pathSegment: String
    Definition Classes
    SearchQuery → ContentApiQuery
  34. def paths: StringParameter
    Definition Classes
    FilterExtendedParameters
  35. def productionOffice: StringParameter
    Definition Classes
    FilterParameters
  36. def q: StringParameter
    Definition Classes
    FilterSearchParameters
  37. def queryFields: StringParameter
    Definition Classes
    FilterSearchParameters
  38. def reference: StringParameter
    Definition Classes
    FilterParameters
  39. def referenceType: StringParameter
    Definition Classes
    FilterParameters
  40. def rights: StringParameter
    Definition Classes
    FilterExtendedParameters
  41. def section: StringParameter
    Definition Classes
    FilterParameters
  42. def setPaginationConsistentWith(response: SearchResponse): PaginatedApiQuery[SearchResponse, Content]

    Produce a version of this query that explicitly sets previously unset pagination/ordering parameters, matching how the Content API server decided to process the previous request.

    Produce a version of this query that explicitly sets previously unset pagination/ordering parameters, matching how the Content API server decided to process the previous request.

    For instance, if the Content API decided to process https://content.guardianapis.com/search?q=brexit with pageSize:10 & orderBy:relevance, that will have been detailed in the CAPI response - and therefore we can copy those parameters into our following query so we don't change how we're ordering the results as we paginate through them!

    Definition Classes
    SearchQuery → PaginatedApiQuery
  43. def showAliasPaths: BoolParameter
    Definition Classes
    ShowParameters
  44. def showAtoms: StringParameter
    Definition Classes
    ShowParameters
  45. def showBlocks: StringParameter
    Definition Classes
    ShowParameters
  46. def showElements: StringParameter
    Definition Classes
    ShowParameters
  47. def showFields: StringParameter
    Definition Classes
    ShowParameters
  48. def showReferences: StringParameter
    Definition Classes
    ShowReferencesParameters
  49. def showRights: StringParameter
    Definition Classes
    ShowParameters
  50. def showSection: BoolParameter
    Definition Classes
    ShowParameters
  51. def showStats: BoolParameter
    Definition Classes
    ShowParameters
  52. def showTags: StringParameter
    Definition Classes
    ShowParameters
  53. def starRating: IntParameter
    Definition Classes
    FilterExtendedParameters
  54. def stringParam(key: String, value: String): SearchQuery
    Definition Classes
    Parameters
  55. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  56. def tag: StringParameter
    Definition Classes
    FilterExtendedParameters
  57. def toDate: DateParameter
    Definition Classes
    FilterExtendedParameters
  58. def toString(): String
    Definition Classes
    ContentApiQuery → AnyRef → Any
  59. def useDate: StringParameter
    Definition Classes
    UseDateParameter
  60. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  61. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  62. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  63. def withParameter(parameter: Parameter): SearchQuery
    Definition Classes
    Parameters
  64. def withParameters(parameterMap: Map[String, Parameter]): SearchQuery
    Definition Classes
    SearchQuery → Parameters

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from SearchQueryBase[SearchQuery]

Inherited from FilterSearchParameters[SearchQuery]

Inherited from FilterExtendedParameters[SearchQuery]

Inherited from FilterParameters[SearchQuery]

Inherited from PaginationParameters[SearchQuery]

Inherited from UseDateParameter[SearchQuery]

Inherited from OrderByParameter[SearchQuery]

Inherited from ShowReferencesParameters[SearchQuery]

Inherited from ShowParameters[SearchQuery]

Inherited from Parameters[SearchQuery]

Inherited from PaginatedApiQuery[SearchResponse, Content]

Inherited from ContentApiQuery[SearchResponse]

Inherited from AnyRef

Inherited from Any

Ungrouped