| Interface | Description |
|---|---|
| AsyncCacheManager |
Cache responses against the Kontent.ai Delivery API.
|
| BrokenLinkUrlResolver |
Interface to provide for rendering broken content item links in rich text.
|
| CacheManager |
Interface to provide caching to the
DeliveryClient. |
| ContentLinkUrlResolver |
Interface to provide for rendering content item links in rich text.
|
| KontentException | |
| RichTextElementResolver |
RichTextElementResolvers added to the
DeliveryClient will be invoked when resolving any
RichTextElement. |
| Class | Description |
|---|---|
| Asset |
Object model for Asset elements
|
| Asset.AssetBuilder | |
| AssetRendition |
Object model for asset rendition
|
| AssetRendition.AssetRenditionBuilder | |
| AssetsElement |
Object model for Assets elements.
|
| ContentItem |
Object model description of a single content item object.
|
| ContentItem.ContentItemBuilder | |
| ContentItemResponse |
Content item listing response from an invocation of
DeliveryClient.getItem(String), or
DeliveryClient.getItem(String, List). |
| ContentItemResponse.ContentItemResponseBuilder | |
| ContentItemsListingResponse |
Content item listing response from an invocation of
DeliveryClient.getItems(), or
DeliveryClient.getItems(List). |
| ContentItemsListingResponse.ContentItemsListingResponseBuilder | |
| ContentType |
Object model description of a single content type object.
|
| ContentType.ContentTypeBuilder | |
| ContentTypesListingResponse |
Content type listing response from an invocation of
DeliveryClient.getTypes(), or
DeliveryClient.getTypes(List). |
| ContentTypesListingResponse.ContentTypesListingResponseBuilder | |
| CustomElement |
Object model for custom elements
|
| DateTimeElement |
Object model for Date & time elements.
|
| DelegatingRichTextElementResolver |
Implementation of
RichTextElementResolver that iterates over a list of resolvers sequentially. |
| DeliveryClient |
Executes requests against the Kontent.ai Delivery API.
|
| DeliveryOptions |
Keeps settings which are provided by customer or have default values, used in
DeliveryClient. |
| DeliveryOptions.DeliveryOptionsBuilder | |
| DeliveryParameterBuilder |
Convenience class to help construct query parameters for any Listing
Response.
|
| Element<T> |
Parent object model of individual elements
|
| Header | |
| Image |
Object model for Image elements
|
| InlineContentItemsResolver<T> |
Concrete implementations of this can resolve strongly typed content types included inline rich text.
|
| KontentError |
Kontent.ai error response
|
| Link |
Object model for Link elements
|
| LinkedItem |
Object model for Linked Item elements
|
| MultipleChoiceElement |
Object model for Multiple choice elements
|
| NameValuePair | |
| NumberElement |
Object model for Number elements
|
| Option |
Object model for option values in a
MultipleChoiceElement |
| Page<T> |
Represents a page of results from the Kontent.ai API.
|
| Pagination |
Pagination object
|
| RichTextElement |
Object model for Rich text elements.
|
| RichTextElementConverter | |
| SimpleInMemoryCacheManager |
Uses the JVM memory to cache results.
|
| SimpleInMemoryCacheManager.CacheTag | |
| StringUtils | |
| StronglyTypedContentItemConverter | |
| System |
Content item system attributes
|
| Taxonomy |
Object model for a Taxonomy element
|
| TaxonomyElement |
Object model for a Taxonomy group element
|
| TaxonomyGroup |
Object model for a single Taxonomy group
|
| TaxonomyGroupListingResponse |
Content type listing response from an invocation of
DeliveryClient.getTypes(), or
DeliveryClient.getTypes(List). |
| TaxonomyGroupListingResponse.TaxonomyGroupListingResponseBuilder | |
| TextElement |
Object model for text elements
|
| UrlSlugElement |
Object model for URL slug elements
|
| Exception | Description |
|---|---|
| KontentErrorException |
Thrown to indicate failure of a Kontent.ai request.
|
| KontentIOException |
Thrown when an
IOException is thrown when executing against the Kontent.ai API. |
| KontentRetryException |
Thrown when retry attempts are is thrown when executing against the Kontent.ai API.
|
| Annotation Type | Description |
|---|---|
| ContentItemMapping |
This annotation is used by the
StronglyTypedContentItemConverter to convert ContentItems into any
plain old Java object of your choosing. |
| ElementMapping |
Can be placed on fields of POJOs to indicate that it should be mapped to an element in a
ContentItem. |
Production vs Preview
You can work with the Delivery API in two ways. Either retrieve published versions of content items or preview their
yet unpublished versions. In both cases, you use the same methods to request data with the
DeliveryClient.
If you want to preview unpublished content in your project, you need to include the Preview API key in your
construction of the DeliveryClient.