Package com.contentstack.sdk

Class AssetLibrary

java.lang.Object
com.contentstack.sdk.AssetLibrary
All Implemented Interfaces:
INotifyClass
public class AssetLibrary
extends Object
implements INotifyClass
Assets refer to all the media files (images, videos, PDFs, audio files, and so on) uploaded to Contentstack. These files can be used in multiple entries. Read more about [Assets](https://www.contentstack.com/docs/guide/content-management#working-with-assets)

  • Field Details

    • urlQueries

      public org.json.JSONObject urlQueries

  • Constructor Details

    • AssetLibrary

      protected AssetLibrary()

  • Method Details

    • setStackInstance

      protected void setStackInstance​(Stack stack)

    • setHeader

      public void setHeader​(String key, String value)
      To set headers for Contentstack rest calls.
      Scope is limited to this object only.
      Parameters:
      key - header name.
      value - header value against given header name.

      Example :
       //'blt5d4sample2633b' is a dummy Application API key
 AssetLibrary assetLibObject = Contentstack.stack("blt5d4sample2633b", "bltdtsample_accessToken767vv",  config).assetLibrary();
 assetLibObject.setHeader("custom_header_key", "custom_header_value");

    • removeHeader

      public void removeHeader​(String key)
      Remove a header for a given key from headers.
      Scope is limited to this object only.
      Parameters:
      key - header key.

      Example :
       //'blt5d4sample2633b' is a dummy Application API key
 AssetLibrary assetLibObject = Contentstack.stack("blt5d4sample2633b", "bltdtsample_accessToken767vv",  config).assetLibrary();

 assetLibObject.removeHeader("custom_header_key");

    • sort

      public AssetLibrary sort​(String key, AssetLibrary.ORDERBY orderby)
      Sort assets by fieldUid.
      Parameters:
      key - field Uid.
      orderby - AssetLibrary.ORDERBY value for ascending or descending.
      Returns:
      AssetLibrary object, so you can chain this call.

      Example :
       //'blt5d4sample2633b' is a dummy Application API key
 AssetLibrary assetLibObject = Contentstack.stack("blt5d4sample2633b", "bltdtsample_accessToken767vv",  config).assetLibrary();
 assetLibObject.sort("fieldUid", AssetLibrary.ORDERBY.ASCENDING);

    • includeCount

      public AssetLibrary includeCount()
      Retrieve count and data of assets in result.
      Returns:
      AssetLibrary object, so you can chain this call.

      Example :
       //'blt5d4sample2633b' is a dummy Stack API key
 //'bltdtsample_accessToken767vv' is dummy access token.
 AssetLibrary assetLibObject = Contentstack.stack( "blt5d4sample2633b", "bltdtsample_accessToken767vv",  config).assetLibrary();
 assetLibObject.includeCount();

    • includeRelativeUrl

      public AssetLibrary includeRelativeUrl()
      Retrieve relative urls objects in result.
      Returns:
      AssetLibrary object, so you can chain this call.

      Example :
       //'blt5d4sample2633b' is a dummy Stack API key
 //'bltdtsample_accessToken767vv' is dummy access token.
 AssetLibrary assetLibObject = Contentstack.stack( "blt5d4sample2633b", "bltdtsample_accessToken767vv",  config).assetLibrary();
 assetLibObject.includeRelativeUrl();

    • getCount

      public int getCount()
      Get a count of assets in success callback of FetchAssetsCallback.
      Returns:
      int @count

    • fetchAll

      public void fetchAll​(FetchAssetsCallback assetsCallback)
      Fetch a all asset.
      Parameters:
      assetsCallback - FetchAssetsCallback instance for success and failure result.

      Example :
         AssetLibrary assetLibObject = Contentstack.stack("blt5d4sample2633b", "bltdtsample_accessToken767vv",  config).assetLibrary();
   assetLibObject.fetchAll(new FetchAssetsCallback() {
   public void onCompletion(ResponseType responseType, List<Asset> assets, Error error) {
      if (error == null) {
         //Success Block.
      } else {
         //Error Block.
      }
   }
  });

    • 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

    • 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_name);
     AssetLibrary assetLibObject = stack.assetLibrary();
     assetLibObject.includeFallback();