Package com.contentstack.sdk

Class AssetLibrary

java.lang.Object

com.contentstack.sdk.AssetLibrary

All Implemented Interfaces:

INotifyClass

public class AssetLibrary
extends Object
implements INotifyClass

The Asset library is used to get list of assets available in the stack, We can apply filters on the assets also. The Get all assets request fetches the list of all the assets of a particular stack. It returns the content of each asset in JSON format.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AssetLibrary.ORDERBY	The enum Orderby.

Method Summary

Modifier and Type	Method	Description
AssetLibrary	addParam(@NotNull String paramKey, @NotNull Object paramValue)	Add param assetlibrary.
void	fetchAll(FetchAssetsCallback callback)	Fetch all.
int	getCount()	Gets count.
void	getResult(Object object, String controller)
void	getResultObject(List<Object> objects, org.json.JSONObject jsonObject, boolean isSingleEntry)
AssetLibrary	includeCount()	Include count asset library.
AssetLibrary	includeFallback()	Retrieve the published content of the fallback locale if an entry is not localized in specified locale
AssetLibrary	includeMetadata()	Retrieve Metadata in the response
AssetLibrary	includeRelativeUrl()	Include relative url asset library.
AssetLibrary	limit(@org.jetbrains.annotations.NotNull int number)	A limit on the number of objects to return.
void	removeHeader(@NotNull String headerKey)	Remove header.
AssetLibrary	removeParam(@NotNull String paramKey)	Remove param key assetlibrary.
void	setHeader(@NotNull String headerKey, @NotNull String headerValue)	Sets header.
AssetLibrary	skip(@org.jetbrains.annotations.NotNull int number)	The number of objects to skip before returning any.
AssetLibrary	sort(String keyOrderBy, AssetLibrary.ORDERBY orderby)	Sort asset library.
AssetLibrary	where(String key, String value)

Methods inherited from class java.lang.Object

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

Method Detail

setHeader

public void setHeader(@NotNull
                      @NotNull String headerKey,
                      @NotNull
                      @NotNull String headerValue)

Sets header.

Parameters:

headerKey - the header key

headerValue - the header value

removeHeader

public void removeHeader(@NotNull
                         @NotNull String headerKey)

Remove header.

Parameters:

headerKey - the header key

sort

public AssetLibrary sort(String keyOrderBy,
                         AssetLibrary.ORDERBY orderby)

Sort asset library.

Parameters:

keyOrderBy - the key order by

orderby - the orderby

Returns:

the asset library

includeCount

public AssetLibrary includeCount()

Include count asset library.

Returns:

the asset library

includeRelativeUrl

public AssetLibrary includeRelativeUrl()

Include relative url asset library.

Returns:

the asset library

includeFallback

public AssetLibrary includeFallback()

Retrieve the published content of the fallback locale if an entry is not localized in specified locale

Returns:

AssetLibrary object, so you can chain this call.

Example :

         Stack stack = Contentstack.stack("apiKey", "deliveryToken", "environment");
         AssetLibrary assetLibObject = stack.assetLibrary();
         AssetLibrary.includeFallback();
         

includeMetadata

public AssetLibrary includeMetadata()

Retrieve Metadata in the response

Returns:

AssetLibrary object, so you can chain this call.

Example :

         Stack stack = Contentstack.stack("apiKey", "deliveryToken", "environment");
         AssetLibrary assetLibObject = stack.includeOwner();
         AssetLibrary.includeMetadata();
         

getCount

public int getCount()

Gets count.

Returns:

the count

addParam

public AssetLibrary addParam(@NotNull
                             @NotNull String paramKey,
                             @NotNull
                             @NotNull Object paramValue)

Add param assetlibrary.

Parameters:

paramKey - the param key

paramValue - the param value

Returns:

the assetlibrary

Example :

         Stack stack = Contentstack.stack("apiKey", "deliveryToken", "environment");
         AssetLibrary assetLibObject = stack.assetlibrary();
         assetLibObject.addParam();
         

removeParam

public AssetLibrary removeParam(@NotNull
                                @NotNull String paramKey)

Remove param key assetlibrary.

Parameters:

paramKey - the param key

Returns:

the assetlibrary

Example :

         Stack stack = Contentstack.stack("apiKey", "deliveryToken", "environment");
         AssetLibrary assetLibObject = stack.assetlibrary();
         assetLibObject.removeParam(paramKey);
         

skip

public AssetLibrary skip(@NotNull
                         @org.jetbrains.annotations.NotNull int number)

The number of objects to skip before returning any.

Parameters:

number - No of objects to skip from returned objects

Returns:

Query object, so you can chain this call.

Note: The skip parameter can be used for pagination, "skip" specifies the number of objects to skip in the response.


Example :

          Stack stack = Contentstack.stack( "apiKey", "deliveryToken", "environment");
          AssetLibrary assetLibObject = stack.assetlibrary.skip(4);

         

limit

public AssetLibrary limit(@NotNull
                          @org.jetbrains.annotations.NotNull int number)

A limit on the number of objects to return.

Parameters:

number - No of objects to limit.

Returns:

Query object, so you can chain this call.

Note: The limit parameter can be used for pagination, " limit" specifies the number of objects to limit to in the response.


Example :

          Stack stack = Contentstack.stack( "apiKey", "deliveryToken", "environment");
           AssetLibrary assetLibObject = stack.assetlibrary.limit(4);

         

fetchAll

public void fetchAll(FetchAssetsCallback callback)

Fetch all.

Parameters:

callback - the callback

getResult

public void getResult(Object object,
                      String controller)

Specified by:

getResult in interface INotifyClass

getResultObject

public void getResultObject(List<Object> objects,
                            org.json.JSONObject jsonObject,
                            boolean isSingleEntry)

Specified by:

getResultObject in interface INotifyClass

where

public AssetLibrary where(String key,
                          String value)