c

com.gu.contentapi.client.model

PaginatedApiQuery

abstract class PaginatedApiQuery[Response <: ThriftStruct, Element] extends ContentApiQuery[Response]

Linear Supertypes
ContentApiQuery[Response], AnyRef, Any
Known Subclasses
FollowingSearchQuery, SearchQuery, TagsQuery
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PaginatedApiQuery
  2. ContentApiQuery
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PaginatedApiQuery()(implicit prd: PageableResponseDecoder[Response, Element])

Abstract Value Members

  1. abstract def followingQueryGivenFull(response: Response, direction: Direction): Option[PaginatedApiQuery[Response, Element]]

    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
  2. abstract def parameters: Map[String, String]
    Definition Classes
    ContentApiQuery
  3. abstract def pathSegment: String
    Definition Classes
    ContentApiQuery
  4. abstract def setPaginationConsistentWith(response: Response): PaginatedApiQuery[Response, Element]

    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!

Concrete 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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def followingQueryGiven(response: Response, direction: Direction): Option[PaginatedApiQuery[Response, Element]]
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. def getUrl(targetUrl: String, customParameters: Map[String, String] = Map.empty): String
    Definition Classes
    ContentApiQuery
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    ContentApiQuery → AnyRef → Any
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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 ContentApiQuery[Response]

Inherited from AnyRef

Inherited from Any

Ungrouped