case class JsonApiPagination(originalUrl: Url, firstParams: Map[String, String] = Map.empty, lastParams: Map[String, String] = Map.empty, prevParams: Map[String, String] = Map.empty, nextParams: Map[String, String] = Map.empty, total: Option[Long] = None) extends Product with Serializable
Case class for handling the top level pagination links in collection responses, also supports
a total count of resources for collection responses.
- originalUrl
The URL (relative or absolute) of the original incoming request, complete with all query parameters
- Alphabetic
- By Inheritance
- JsonApiPagination
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new JsonApiPagination(originalUrl: Url, firstParams: Map[String, String] = Map.empty, lastParams: Map[String, String] = Map.empty, prevParams: Map[String, String] = Map.empty, nextParams: Map[String, String] = Map.empty, total: Option[Long] = None)
- originalUrl
The URL (relative or absolute) of the original incoming request, complete with all query parameters
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def allLinksAsUrls: Map[String, Url]
Returns all non empty pagination links in a map
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- val originalUrl: Url
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val total: Option[Long]
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def withFirst(pageParams: (String, String)*): JsonApiPagination
Adds a 'first' link to the response
Adds a 'first' link to the response
- pageParams
One or more tuples of pagination kind and value, e.g "size" -> "10" or "number" -> "2"
- def withLast(pageParams: (String, String)*): JsonApiPagination
Adds a 'last' link to the response
Adds a 'last' link to the response
- pageParams
One or more tuples of pagination kind and value, e.g "size" -> "10" or "number" -> "2"
- def withNext(pageParams: (String, String)*): JsonApiPagination
Adds a 'next' link to the response
Adds a 'next' link to the response
- pageParams
One or more tuples of pagination kind and value, e.g "size" -> "10" or "number" -> "2"
- def withPrev(pageParams: (String, String)*): JsonApiPagination
Adds a 'prev' link to the response
Adds a 'prev' link to the response
- pageParams
One or more tuples of pagination kind and value, e.g "size" -> "10" or "number" -> "2"
- def withTotal(total: Long): JsonApiPagination
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)