ContentApiClient

Abstract Value Members

abstract def apiKey: String

Your API key
abstract def get(url: String, headers: Map[String, String])(implicit context: ExecutionContext): Future[HttpResponse]

Queries CAPI.
Queries CAPI.
This method must make a GET request to the CAPI endpoint and streamline the response into an HttpResponse object.
It is a design decision that this method is virtual. Any implementation would have to rely on a specific technology stack, e.g. an HTTP client. Fundamentally, the responsibility of making these implementation choices should be pushed out to the end of the world.
url
The CAPI REST url
headers
Custom HTTP parameters
returns
an HttpResponse holding the response in the form of an array of bytes

Concrete 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
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getResponse[Q <: ContentApiQuery](query: Q)(implicit decoder: Decoder[Q], context: ExecutionContext): Future[Response]

Runs the query against the Content API.
Runs the query against the Content API.
Q
the type of a Content API query
query
the query
returns
a future resolving to an unmarshalled response
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def paginate[Q <: PaginatedApiQuery[Q], R, M](query: Q)(f: (R) ⇒ M)(implicit decoder: Aux[Q, R], pager: PaginatedApiResponse[R], context: ExecutionContext): Future[List[M]]

Unfolds a query to its results, page by page
Unfolds a query to its results, page by page
Q
the type of a Content API query with pagination parameters
R
the type of response expected for Q
query
the initial query
f
a result-processing function
returns
a future of a list of result-processed results
def paginateAccum[Q <: PaginatedApiQuery[Q], R, M](query: Q)(f: (R) ⇒ M, g: (M, M) ⇒ M)(implicit decoder: Aux[Q, R], pager: PaginatedApiResponse[R], context: ExecutionContext): Future[M]

Unfolds a query by accumulating its results
Unfolds a query by accumulating its results
Q
the type of a Content API query with pagination parameters
R
the type of response expected for Q
query
the initial query
f
a result-processing function
returns
a future of an accumulated value
def paginateFold[Q <: PaginatedApiQuery[Q], R, M](query: Q)(m: M)(f: (R, M) ⇒ M)(implicit decoder: Aux[Q, R], decoderNext: Aux[NextQuery[Q], R], pager: PaginatedApiResponse[R], context: ExecutionContext): Future[M]

Unfolds a query by accumulating its results
Unfolds a query by accumulating its results
Q
the type of a Content API query with pagination parameters
R
the type of response expected for Q
query
the initial query
f
a result-processing function
returns
a future of an accumulated value
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def targetUrl: String

The url of the CAPI endpoint
def toString(): String

Definition Classes
AnyRef → Any
def url(contentApiQuery: ContentApiQuery): String
def userAgent: String

The user-agent identifier
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
Deprecated
(Since version ) see corresponding Javadoc for more information.

Related Docs: object ContentApiClient | package client

trait ContentApiClient extends AnyRef

Abstract Value Members

abstract def apiKey: String

abstract def get(url: String, headers: Map[String, String])(implicit context: ExecutionContext): Future[HttpResponse]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

final def getClass(): Class[_]

def getResponse[Q <: ContentApiQuery](query: Q)(implicit decoder: Decoder[Q], context: ExecutionContext): Future[Response]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def paginate[Q <: PaginatedApiQuery[Q], R, M](query: Q)(f: (R) ⇒ M)(implicit decoder: Aux[Q, R], pager: PaginatedApiResponse[R], context: ExecutionContext): Future[List[M]]

def paginateAccum[Q <: PaginatedApiQuery[Q], R, M](query: Q)(f: (R) ⇒ M, g: (M, M) ⇒ M)(implicit decoder: Aux[Q, R], pager: PaginatedApiResponse[R], context: ExecutionContext): Future[M]

def paginateFold[Q <: PaginatedApiQuery[Q], R, M](query: Q)(m: M)(f: (R, M) ⇒ M)(implicit decoder: Aux[Q, R], decoderNext: Aux[NextQuery[Q], R], pager: PaginatedApiResponse[R], context: ExecutionContext): Future[M]

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

def targetUrl: String

def toString(): String

def url(contentApiQuery: ContentApiQuery): String

def userAgent: String

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

final def wait(arg0: Long): Unit

final def wait(): Unit

Deprecated Value Members

def finalize(): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped