kontent.ai.delivery

Class DeliveryClient

java.lang.Object

kontent.ai.delivery.DeliveryClient

public class DeliveryClient
extends java.lang.Object

Executes requests against the Kontent.ai Delivery API.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HEADER_ACCEPT
static java.lang.String	HEADER_AUTHORIZATION
static java.lang.String	HEADER_X_KC_SDK_ID
static java.lang.String	HEADER_X_KC_WAIT_FOR_LOADING_NEW_CONTENT

Constructor Summary

Constructors

Constructor and Description
DeliveryClient(DeliveryOptions deliveryOptions) Please use this constructor when you need to initialize client with default template configuration - so when you are using template engine.
DeliveryClient(DeliveryOptions deliveryOptions, TemplateEngineConfig templateEngineConfig)
DeliveryClient(java.lang.String projectId)
DeliveryClient(java.lang.String projectId, java.lang.String previewApiKey)

Method Summary

Modifier and Type	Method and Description
void	addRichTextElementResolver(RichTextElementResolver richTextElementResolver)
BrokenLinkUrlResolver	getBrokenLinkUrlResolver()
ContentLinkUrlResolver	getContentLinkUrlResolver()
java.util.concurrent.CompletionStage<Element>	getContentTypeElement(java.lang.String contentTypeCodeName, java.lang.String elementCodeName)
java.util.concurrent.CompletionStage<Element>	getContentTypeElement(java.lang.String contentTypeCodeName, java.lang.String elementCodeName, java.util.List<NameValuePair> params)
java.util.concurrent.CompletionStage<ContentItemResponse>	getItem(java.lang.String contentItemCodename)
<T> java.util.concurrent.CompletionStage<T>	getItem(java.lang.String contentItemCodename, java.lang.Class<T> tClass)
<T> java.util.concurrent.CompletionStage<T>	getItem(java.lang.String contentItemCodename, java.lang.Class<T> tClass, java.util.List<NameValuePair> params)
java.util.concurrent.CompletionStage<ContentItemResponse>	getItem(java.lang.String contentItemCodename, java.util.List<NameValuePair> params)
java.util.concurrent.CompletionStage<ContentItemsListingResponse>	getItems()
<T> java.util.concurrent.CompletionStage<java.util.List<T>>	getItems(java.lang.Class<T> tClass)
<T> java.util.concurrent.CompletionStage<java.util.List<T>>	getItems(java.lang.Class<T> tClass, java.util.List<NameValuePair> params)
java.util.concurrent.CompletionStage<ContentItemsListingResponse>	getItems(java.util.List<NameValuePair> params)
<T> java.util.concurrent.CompletionStage<Page<T>>	getNextPage(Page<T> currentPage)
<T> java.util.concurrent.CompletionStage<Page<T>>	getPageOfItems(java.lang.Class<T> tClass, java.util.List<NameValuePair> params)
RichTextElementResolver	getRichTextElementResolver()
java.util.concurrent.CompletionStage<TaxonomyGroup>	getTaxonomyGroup(java.lang.String taxonomyGroupCodename)
java.util.concurrent.CompletionStage<TaxonomyGroup>	getTaxonomyGroup(java.lang.String taxonomyGroupCodename, java.util.List<NameValuePair> params)
java.util.concurrent.CompletionStage<TaxonomyGroupListingResponse>	getTaxonomyGroups()
java.util.concurrent.CompletionStage<TaxonomyGroupListingResponse>	getTaxonomyGroups(java.util.List<NameValuePair> params)
java.util.concurrent.CompletionStage<ContentType>	getType(java.lang.String contentTypeCodeName)
java.util.concurrent.CompletionStage<ContentTypesListingResponse>	getTypes()
java.util.concurrent.CompletionStage<ContentTypesListingResponse>	getTypes(java.util.List<NameValuePair> params)
void	registerInlineContentItemsResolver(InlineContentItemsResolver resolver)
void	registerType(java.lang.Class<?> clazz)
void	registerType(java.lang.String contentType, java.lang.Class<?> clazz)
void	scanClasspathForMappings(java.lang.String basePackage) Not working on Android platform because of JVM and Dalvik differences, please use registerType(Class) instead Register by scanning the classpath for annotated classes by ContentItemMapping annotation.
void	setBrokenLinkUrlResolver(BrokenLinkUrlResolver brokenLinkUrlResolver)
void	setCacheManager(AsyncCacheManager cacheManager)
void	setCacheManager(CacheManager cacheManager) Sets the CacheManager for this client.
void	setContentLinkUrlResolver(ContentLinkUrlResolver contentLinkUrlResolver)
void	setRichTextElementResolver(RichTextElementResolver richTextElementResolver)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HEADER_X_KC_WAIT_FOR_LOADING_NEW_CONTENT

public static final java.lang.String HEADER_X_KC_WAIT_FOR_LOADING_NEW_CONTENT

See Also:

Constant Field Values

HEADER_X_KC_SDK_ID

public static final java.lang.String HEADER_X_KC_SDK_ID

See Also:

Constant Field Values

HEADER_AUTHORIZATION

public static final java.lang.String HEADER_AUTHORIZATION

See Also:

Constant Field Values

HEADER_ACCEPT

public static final java.lang.String HEADER_ACCEPT

See Also:

Constant Field Values

Constructor Detail

DeliveryClient

public DeliveryClient(DeliveryOptions deliveryOptions)

Please use this constructor when you need to initialize client with default template configuration - so when you are using template engine. For i.e. Android platform use DeliveryClient(DeliveryOptions, TemplateEngineConfig) and set second parameter to null.

Parameters:

deliveryOptions - delivery options DeliveryOptions

DeliveryClient

public DeliveryClient(DeliveryOptions deliveryOptions,
                      TemplateEngineConfig templateEngineConfig)

DeliveryClient

public DeliveryClient(java.lang.String projectId)

DeliveryClient

public DeliveryClient(java.lang.String projectId,
                      java.lang.String previewApiKey)

Method Detail

getItems

public java.util.concurrent.CompletionStage<ContentItemsListingResponse> getItems()

getItems

public java.util.concurrent.CompletionStage<ContentItemsListingResponse> getItems(java.util.List<NameValuePair> params)

getItems

public <T> java.util.concurrent.CompletionStage<java.util.List<T>> getItems(java.lang.Class<T> tClass,
                                                                            java.util.List<NameValuePair> params)

getItem

public java.util.concurrent.CompletionStage<ContentItemResponse> getItem(java.lang.String contentItemCodename)

getItems

public <T> java.util.concurrent.CompletionStage<java.util.List<T>> getItems(java.lang.Class<T> tClass)

getPageOfItems

public <T> java.util.concurrent.CompletionStage<Page<T>> getPageOfItems(java.lang.Class<T> tClass,
                                                                        java.util.List<NameValuePair> params)

getNextPage

public <T> java.util.concurrent.CompletionStage<Page<T>> getNextPage(Page<T> currentPage)

getItem

public <T> java.util.concurrent.CompletionStage<T> getItem(java.lang.String contentItemCodename,
                                                           java.lang.Class<T> tClass)

getItem

public java.util.concurrent.CompletionStage<ContentItemResponse> getItem(java.lang.String contentItemCodename,
                                                                         java.util.List<NameValuePair> params)

getItem

public <T> java.util.concurrent.CompletionStage<T> getItem(java.lang.String contentItemCodename,
                                                           java.lang.Class<T> tClass,
                                                           java.util.List<NameValuePair> params)

getTypes

public java.util.concurrent.CompletionStage<ContentTypesListingResponse> getTypes()

getTypes

public java.util.concurrent.CompletionStage<ContentTypesListingResponse> getTypes(java.util.List<NameValuePair> params)

getType

public java.util.concurrent.CompletionStage<ContentType> getType(java.lang.String contentTypeCodeName)

getContentTypeElement

public java.util.concurrent.CompletionStage<Element> getContentTypeElement(java.lang.String contentTypeCodeName,
                                                                           java.lang.String elementCodeName)

getContentTypeElement

public java.util.concurrent.CompletionStage<Element> getContentTypeElement(java.lang.String contentTypeCodeName,
                                                                           java.lang.String elementCodeName,
                                                                           java.util.List<NameValuePair> params)

getTaxonomyGroups

public java.util.concurrent.CompletionStage<TaxonomyGroupListingResponse> getTaxonomyGroups()

getTaxonomyGroups

public java.util.concurrent.CompletionStage<TaxonomyGroupListingResponse> getTaxonomyGroups(java.util.List<NameValuePair> params)

getTaxonomyGroup

public java.util.concurrent.CompletionStage<TaxonomyGroup> getTaxonomyGroup(java.lang.String taxonomyGroupCodename)

getTaxonomyGroup

public java.util.concurrent.CompletionStage<TaxonomyGroup> getTaxonomyGroup(java.lang.String taxonomyGroupCodename,
                                                                            java.util.List<NameValuePair> params)

getContentLinkUrlResolver

public ContentLinkUrlResolver getContentLinkUrlResolver()

setContentLinkUrlResolver

public void setContentLinkUrlResolver(ContentLinkUrlResolver contentLinkUrlResolver)

getBrokenLinkUrlResolver

public BrokenLinkUrlResolver getBrokenLinkUrlResolver()

setBrokenLinkUrlResolver

public void setBrokenLinkUrlResolver(BrokenLinkUrlResolver brokenLinkUrlResolver)

getRichTextElementResolver

public RichTextElementResolver getRichTextElementResolver()

setRichTextElementResolver

public void setRichTextElementResolver(RichTextElementResolver richTextElementResolver)

addRichTextElementResolver

public void addRichTextElementResolver(RichTextElementResolver richTextElementResolver)

registerType

public void registerType(java.lang.String contentType,
                         java.lang.Class<?> clazz)

registerType

public void registerType(java.lang.Class<?> clazz)

registerInlineContentItemsResolver

public void registerInlineContentItemsResolver(InlineContentItemsResolver resolver)

scanClasspathForMappings

public void scanClasspathForMappings(java.lang.String basePackage)

Not working on Android platform because of JVM and Dalvik differences, please use registerType(Class) instead Register by scanning the classpath for annotated classes by ContentItemMapping annotation.

Parameters:

basePackage - name of the base package

setCacheManager

public void setCacheManager(AsyncCacheManager cacheManager)

setCacheManager

public void setCacheManager(CacheManager cacheManager)

Sets the CacheManager for this client.

Parameters:

cacheManager - A CacheManager implementation for this client to use.

See Also:

CacheManager