case class TagsQuery(parameterHolder: Map[String, Parameter] = Map.empty) extends PaginatedApiQuery[TagsResponse, Tag] with ShowReferencesParameters[TagsQuery] with PaginationParameters[TagsQuery] with FilterParameters[TagsQuery] with FilterTagParameters[TagsQuery] with FilterSearchParameters[TagsQuery] with Product with Serializable

Linear Supertypes
Serializable, Serializable, Product, Equals, FilterSearchParameters[TagsQuery], FilterTagParameters[TagsQuery], FilterParameters[TagsQuery], PaginationParameters[TagsQuery], ShowReferencesParameters[TagsQuery], Parameters[TagsQuery], PaginatedApiQuery[TagsResponse, Tag], ContentApiQuery[TagsResponse], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TagsQuery
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. FilterSearchParameters
  7. FilterTagParameters
  8. FilterParameters
  9. PaginationParameters
  10. ShowReferencesParameters
  11. Parameters
  12. PaginatedApiQuery
  13. ContentApiQuery
  14. AnyRef
  15. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TagsQuery(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): TagsQuery
    Definition Classes
    Parameters
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  7. def dateParam(key: String, value: Instant): TagsQuery
    Definition Classes
    Parameters
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def followingQueryGiven(response: TagsResponse, direction: Direction): Option[PaginatedApiQuery[TagsResponse, Tag]]
    Definition Classes
    PaginatedApiQuery
  10. def followingQueryGivenFull(response: TagsResponse, direction: Direction): Option[TagsQuery]

    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
    TagsQuery → PaginatedApiQuery
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. def getUrl(targetUrl: String, customParameters: Map[String, String] = Map.empty): String
    Definition Classes
    ContentApiQuery
  13. def has(param: String): Boolean
    Definition Classes
    Parameters
  14. def intParam(key: String, value: Int): TagsQuery
    Definition Classes
    Parameters
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. def page: IntParameter
    Definition Classes
    PaginationParameters
  20. def pageSize: IntParameter
    Definition Classes
    PaginationParameters
  21. val parameterHolder: Map[String, Parameter]
    Definition Classes
    TagsQuery → Parameters
  22. def parameters: Map[String, String]
    Definition Classes
    Parameters
  23. def pathSegment: String
    Definition Classes
    TagsQuery → ContentApiQuery
  24. def productionOffice: StringParameter
    Definition Classes
    FilterParameters
  25. def q: StringParameter
    Definition Classes
    FilterSearchParameters
  26. def queryFields: StringParameter
    Definition Classes
    FilterSearchParameters
  27. def reference: StringParameter
    Definition Classes
    FilterParameters
  28. def referenceType: StringParameter
    Definition Classes
    FilterParameters
  29. def section: StringParameter
    Definition Classes
    FilterParameters
  30. def setPaginationConsistentWith(response: TagsResponse): PaginatedApiQuery[TagsResponse, Tag]

    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
    TagsQuery → PaginatedApiQuery
  31. def showReferences: StringParameter
    Definition Classes
    ShowReferencesParameters
  32. def sponsorshipType: StringParameter
    Definition Classes
    FilterTagParameters
  33. def stringParam(key: String, value: String): TagsQuery
    Definition Classes
    Parameters
  34. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  35. def tagType: StringParameter
    Definition Classes
    FilterTagParameters
  36. def toString(): String
    Definition Classes
    ContentApiQuery → AnyRef → Any
  37. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  39. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. def withParameter(parameter: Parameter): TagsQuery
    Definition Classes
    Parameters
  41. def withParameters(parameterMap: Map[String, Parameter]): TagsQuery
    Definition Classes
    TagsQuery → Parameters

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[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 FilterSearchParameters[TagsQuery]

Inherited from FilterTagParameters[TagsQuery]

Inherited from FilterParameters[TagsQuery]

Inherited from PaginationParameters[TagsQuery]

Inherited from ShowReferencesParameters[TagsQuery]

Inherited from Parameters[TagsQuery]

Inherited from PaginatedApiQuery[TagsResponse, Tag]

Inherited from ContentApiQuery[TagsResponse]

Inherited from AnyRef

Inherited from Any

Ungrouped