trait ContentApiClient extends AnyRef
- Alphabetic
- By Inheritance
- ContentApiClient
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
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[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
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
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
getResponse[R <: ThriftStruct](query: ContentApiQuery[R])(implicit decoder: Decoder[R], context: ExecutionContext): Future[R]
Runs the query against the Content API.
Runs the query against the Content API.
- query
the query
- returns
a future resolving to an unmarshalled response
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
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
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
paginate[R <: ThriftStruct, E, M](query: PaginatedApiQuery[R, E])(f: (R) ⇒ M)(implicit arg0: Decoder[R], context: ExecutionContext): Future[List[M]]
Unfolds a query to its results, page by page
Unfolds a query to its results, page by page
- R
the response type expected for this query
- E
the 'element' type for the list of elements returned in the response - eg 'Tag' for 'TagsResponse'
- M
a type specified by the caller to summarise the results of each response. Eg, might be
Seq[E]- query
the initial query
- f
a result-processing function that converts the standard response type to the
Mtype- returns
a future of a list of result-processed results (eg, if
M=Seq[E], the final result isList[Seq[E]])
-
def
paginateAccum[R <: ThriftStruct, E, M](query: PaginatedApiQuery[R, E])(f: (R) ⇒ M, g: (M, M) ⇒ M)(implicit arg0: Decoder[R], context: ExecutionContext): Future[M]
Unfolds a query by accumulating its results - each response is transformed (by function
f) and then combined (with functiong) into a single accumulated result object.Unfolds a query by accumulating its results - each response is transformed (by function
f) and then combined (with functiong) into a single accumulated result object.- R
the response type expected for this query
- E
the 'element' type for the list of elements returned in the response - eg 'Tag' for 'TagsResponse'
- M
a type specified by the caller to summarise the results of each response. Eg, might be
Seq[E]- query
the initial query
- f
a result-processing function that converts the standard response type to the
Mtype- g
a function that squashes together ('reduces') two
Mtypes - eg concatenates twoSeq[E]- returns
a future of the accumulated value
-
def
paginateFold[R <: ThriftStruct, E, M](query: PaginatedApiQuery[R, E])(m: M)(f: (R, M) ⇒ M)(implicit arg0: Decoder[R], context: ExecutionContext): Future[M]
Unfolds a query by accumulating its results - each response is transformed and added to an accumulator value by a single folding function
f.Unfolds a query by accumulating its results - each response is transformed and added to an accumulator value by a single folding function
f.- R
the response type expected for this query
- E
the 'element' type for the list of elements returned in the response - eg 'Tag' for 'TagsResponse'
- M
a type specified by the caller to summarise the results the responses. Eg, might be
Int- query
the initial query
- m
an initial 'empty' starting value to begin the accumulation with. Eg, might be
0- f
a result-processing function that adds the result of a response to the summary value accumulated so far
- returns
a future of the 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( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
Deprecated Value Members
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
- Deprecated
(Since version ) see corresponding Javadoc for more information.