Class/Object

com.qvantel.jsonapi

JsonApiPagination

Related Docs: object JsonApiPagination | package jsonapi

Permalink

case class JsonApiPagination(originalUri: Uri, firstParams: Map[String, String] = Map.empty, lastParams: Map[String, String] = Map.empty, prevParams: Map[String, String] = Map.empty, nextParams: Map[String, String] = Map.empty) extends Product with Serializable

Case class for handling the top level pagination links in collection responses

originalUri

The URI (relative or absolute) of the original incoming request, complete with all query parameters

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JsonApiPagination
  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 JsonApiPagination(originalUri: Uri, firstParams: Map[String, String] = Map.empty, lastParams: Map[String, String] = Map.empty, prevParams: Map[String, String] = Map.empty, nextParams: Map[String, String] = Map.empty)

    Permalink

    originalUri

    The URI (relative or absolute) of the original incoming request, complete with all query parameters

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. def allLinksAsUris: Map[String, Uri]

    Permalink

    Returns all non empty pagination links in a map

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  6. def clone(): AnyRef

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

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

    Permalink
    Definition Classes
    AnyRef

  8. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  10. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  12. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  13. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  14. val originalUri: Uri

    Permalink

    The URI (relative or absolute) of the original incoming request, complete with all query parameters

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

    Permalink
    Definition Classes
    AnyRef

  16. final def wait(): Unit

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

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

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

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

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

  19. def withFirst(pageParams: (String, String)*): JsonApiPagination

    Permalink

    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"

  20. def withLast(pageParams: (String, String)*): JsonApiPagination

    Permalink

    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"

  21. def withNext(pageParams: (String, String)*): JsonApiPagination

    Permalink

    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"

  22. def withPrev(pageParams: (String, String)*): JsonApiPagination

    Permalink

    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"

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped