com.gu.openplatform.contentapi

Api

trait Api[F[_]] extends Http[F] with JsonParser

Linear Supertypes
JsonParser, Http[F], AnyRef, Any
Known Subclasses
Api, DispatchAsyncApi, FutureAsyncApi, SyncApi
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Api
  2. JsonParser
  3. Http
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

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

  2. trait ContentFilterParameters[Owner <: Parameters[Owner]] extends Parameters[Owner]

  3. trait FilterParameters[Owner <: Parameters[Owner]] extends Parameters[Owner]

  4. case class FoldersQuery(parameterHolder: Map[String, Parameter] = ...) extends GeneralParameters[FoldersQuery] with FilterParameters[FoldersQuery] with Product with Serializable

  5. case class FrontsQuery(parameterHolder: Map[String, Parameter] = ...) extends GeneralParameters[FrontsQuery] with PaginationParameters[FrontsQuery] with Product with Serializable

  6. trait GeneralParameters[Owner <: Parameters[Owner]] extends Parameters[Owner]

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

  8. trait PaginationParameters[Owner <: Parameters[Owner]] extends Parameters[Owner]

  9. trait RefererenceParameters[Owner <: Parameters[Owner]] extends Parameters[Owner]

  10. trait RefinementParameters[Owner <: Parameters[Owner]] extends Parameters[Owner]

  11. case class SearchQuery(parameterHolder: Map[String, Parameter] = ...) extends GeneralParameters[SearchQuery] with PaginationParameters[SearchQuery] with ShowParameters[SearchQuery] with RefinementParameters[SearchQuery] with FilterParameters[SearchQuery] with ContentFilterParameters[SearchQuery] with RefererenceParameters[SearchQuery] with ShowReferenceParameters[SearchQuery] with Product with Serializable

  12. case class SectionsQuery(parameterHolder: Map[String, Parameter] = ...) extends GeneralParameters[SectionsQuery] with FilterParameters[SectionsQuery] with Product with Serializable

  13. trait ShowParameters[Owner <: Parameters[Owner]] extends Parameters[Owner]

  14. trait ShowReferenceParameters[Owner <: Parameters[Owner]] extends Parameters[Owner]

  15. case class TagsQuery(parameterHolder: Map[String, Parameter] = ...) extends GeneralParameters[TagsQuery] with PaginationParameters[TagsQuery] with FilterParameters[TagsQuery] with RefererenceParameters[TagsQuery] with ShowReferenceParameters[TagsQuery] with Product with Serializable

Abstract Value Members

  1. abstract def GET(url: String, headers: Iterable[(String, String)] = Nil): F[HttpResponse]

    Definition Classes
    Http

  2. implicit abstract def M: Monad[F]

    Proof that we can call point, map, flatMap and error for type F

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. object CollectionQuery extends Serializable

  7. object FoldersQuery extends Serializable

  8. object FrontsQuery extends Serializable

  9. object ItemQuery extends Serializable

  10. object SearchQuery extends Serializable

  11. object SectionsQuery extends Serializable

  12. object TagsQuery extends Serializable

  13. var apiKey: Option[String]

  14. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  15. def clone(): AnyRef

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

  16. implicit val codec: Codec

    Definition Classes
    Http

  17. def collection: CollectionQuery

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

    Definition Classes
    AnyRef

  19. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  20. def fetch(url: String, parameters: Map[String, String]): F[String]

    Attributes
    protected

  21. def finalize(): Unit

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

  22. def folders: FoldersQuery

  23. implicit val formats: Formats

    Definition Classes
    JsonParser

  24. def fronts: FrontsQuery

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

    Definition Classes
    AnyRef → Any

  26. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  27. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  28. def item: ItemQuery

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

    Definition Classes
    AnyRef

  30. final def notify(): Unit

    Definition Classes
    AnyRef

  31. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  32. def parseCollection(json: String): CollectionResponse

    Definition Classes
    JsonParser

  33. def parseFolders(json: String): FoldersResponse

    Definition Classes
    JsonParser

  34. def parseFronts(json: String): FrontsResponse

    Definition Classes
    JsonParser

  35. def parseItem(json: String): ItemResponse

    Definition Classes
    JsonParser

  36. def parseSearch(json: String): SearchResponse

    Definition Classes
    JsonParser

  37. def parseSections(json: String): SectionsResponse

    Definition Classes
    JsonParser

  38. def parseTags(json: String): TagsResponse

    Definition Classes
    JsonParser

  39. def search: SearchQuery

  40. def sections: SectionsQuery

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

    Definition Classes
    AnyRef

  42. def tags: TagsQuery

  43. val targetUrl: String

  44. def toString(): String

    Definition Classes
    AnyRef → Any

  45. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from JsonParser

Inherited from Http[F]

Inherited from AnyRef

Inherited from Any

Ungrouped