com.gu.openplatform.contentapi.Api

CollectionQuery

case class CollectionQuery(path: Option[String] = None, parameterHolder: Map[String, Parameter] = Map.empty) extends GeneralParameters[CollectionQuery] with ShowParameters[CollectionQuery] with FilterParameters[CollectionQuery] with PaginationParameters[CollectionQuery] with ShowReferenceParameters[CollectionQuery] with Product with Serializable

Linear Supertypes
Serializable, Serializable, Product, Equals, ShowReferenceParameters[CollectionQuery], PaginationParameters[CollectionQuery], FilterParameters[CollectionQuery], ShowParameters[CollectionQuery], GeneralParameters[CollectionQuery], Parameters[CollectionQuery], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. CollectionQuery
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. ShowReferenceParameters
  7. PaginationParameters
  8. FilterParameters
  9. ShowParameters
  10. GeneralParameters
  11. Parameters
  12. AnyRef
  13. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CollectionQuery(path: Option[String] = None, 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[ReadableInstant] = 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. def apiUrl(newContentPath: String): CollectionQuery

  5. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  6. def boolParam(key: String, value: Boolean): CollectionQuery

    Definition Classes
    Parameters

  7. def clone(): AnyRef

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

  8. def dateParam(key: String, value: ReadableInstant): CollectionQuery

    Definition Classes
    Parameters

  9. def edition: StringParameter

    Definition Classes
    ShowParameters

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

    Definition Classes
    AnyRef

  11. def finalize(): Unit

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

  12. def folder: StringParameter

    Definition Classes
    FilterParameters

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

    Definition Classes
    AnyRef → Any

  14. def ids: StringParameter

    Definition Classes
    FilterParameters

  15. def intParam(key: String, value: Int): CollectionQuery

    Definition Classes
    Parameters

  16. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  17. def itemId(collectionId: String): CollectionQuery

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

    Definition Classes
    AnyRef

  19. final def notify(): Unit

    Definition Classes
    AnyRef

  20. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  21. def page: IntParameter

    Definition Classes
    PaginationParameters

  22. def pageSize: IntParameter

    Definition Classes
    PaginationParameters

  23. val parameterHolder: Map[String, Parameter]

    Definition Classes
    CollectionQuery → Parameters

  24. def parameters: Map[String, String]

    Definition Classes
    GeneralParameters → Parameters

  25. val path: Option[String]

  26. def q: StringParameter

    Definition Classes
    FilterParameters

  27. lazy val response: F[CollectionResponse]

  28. def section: StringParameter

    Definition Classes
    FilterParameters

  29. def showBestBets: BoolParameter

    Definition Classes
    ShowParameters

  30. def showEditorsPicks: BoolParameter

    Definition Classes
    ShowParameters

  31. def showElements: StringParameter

    Definition Classes
    ShowParameters

  32. def showExpired: BoolParameter

    Definition Classes
    ShowParameters

  33. def showFactboxes: StringParameter

    Definition Classes
    ShowParameters

  34. def showFields: StringParameter

    Definition Classes
    ShowParameters

  35. def showInlineElements: StringParameter

    Definition Classes
    ShowParameters

  36. def showMedia: StringParameter

    Definition Classes
    ShowParameters

  37. def showMostViewed: BoolParameter

    Definition Classes
    ShowParameters

  38. def showReferences: StringParameter

    Definition Classes
    ShowReferenceParameters

  39. def showRelated: BoolParameter

    Definition Classes
    ShowParameters

  40. def showSnippets: StringParameter

    Definition Classes
    ShowParameters

  41. def showStoryPackage: BoolParameter

    Definition Classes
    ShowParameters

  42. def showTags: StringParameter

    Definition Classes
    ShowParameters

  43. def snippetPost: StringParameter

    Definition Classes
    ShowParameters

  44. def snippetPre: StringParameter

    Definition Classes
    ShowParameters

  45. def stringParam(key: String, value: String): CollectionQuery

    Definition Classes
    Parameters

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

    Definition Classes
    AnyRef

  47. def tag: StringParameter

    Definition Classes
    FilterParameters

  48. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  51. def withParameter(parameter: Parameter): CollectionQuery

    Definition Classes
    Parameters

  52. def withParameters(parameterMap: Map[String, Parameter]): CollectionQuery

    Definition Classes
    CollectionQuery → Parameters

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from ShowReferenceParameters[CollectionQuery]

Inherited from PaginationParameters[CollectionQuery]

Inherited from FilterParameters[CollectionQuery]

Inherited from ShowParameters[CollectionQuery]

Inherited from GeneralParameters[CollectionQuery]

Inherited from Parameters[CollectionQuery]

Inherited from AnyRef

Inherited from Any

Ungrouped