Changelog

Contentstack - Android Delivery SDK

Android Delivery SDK for Contentstack

Contentstack is a headless CMS with an API-first approach. It is a CMS that developers can use to build powerful cross-platform applications in their favorite languages. Build your application front end, and Contentstack will take care of the rest. Read More.

Contentstack provides Android Delivery SDK to build applications on top of Android. Given below is the detailed guide and helpful resources to get started with our Android Delivery SDK.

Prerequisite

To get started with Android SDK, you will the following:

Android Studio IDE
Android API SDK support 19 and above
Java SDK version 1.8 or later

SDK Installation and Setup

Using Android Studio, you can easily add dependencies by opening the app's build.gradle file, under the dependencies section in the project:

dependencies{
    implementation 'com.contentstack.sdk:android:{version}'
}

You can download the latest dependency version here

Quickstart in 5 mins

Initializing your SDK

For setting the Region refer to the code below:

import com.contentstack.sdk.*;
Config config = Config();
config.region = ContentstackRegion.EU;
Stack stack = Contentstack.stack(context, "apiKey", "deliveryToken", "environment", config);

For setting the Branch refer to the code below:

import com.contentstack.sdk.*;

Config config = Config();
config.setBranch("branch");
Stack stack = Contentstack.stack(context, "apiKey", "deliveryToken", "environment", config);

Note: For Europe, set the region as EU, for Azure North America, Azure Europe, set the region as AZURE_NA and AZURE_EU respectively, for GCP North America, set the region as GCP_NA, and for GCP Europe, set the region as GCP_EU.

Basic Queries

Contentstack SDKs let you interact with the Content Delivery APIs and retrieve content from Contentstack. They are read-only in nature. The SDKs fetch and deliver content from the nearest server via Fastly, our powerful and robust CDN.

Get a Single Entry

To retrieve a single entry from a content type, use the code snippet given below:

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(context, "apiKey", "deliveryToken", "environment");
ContentType contentType = stack.contentType("contentTypeUid");
Entry entry = contentType.entry("entryUid");
entry.fetch(new EntryResultCallBack(){	
@Override public void onCompletion(ResponseType responseType, Error error) {
   if (error == null) {
    System.out.println("response: "+entry.title);
 }}
});

Get Multiple Entries

To retrieve multiple entries of a particular content type, use the code snippet given below:

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(context, "apiKey", "deliveryToken", "environment");
Query query = stack.contentType("contentTypeUid").query();
query.find(new QueryResultsCallBack(){
@Override public void onCompletion(ResponseType responseType, QueryResult queryResult, Error error){       
  if(error == null) { 
     System.out.println("response: "+entry.title);
  }
}
});

Note:

Currently, the Android SDK does not support multiple content types referencing in a single query. For more information on how to query entries and assets, refer to the Queries section of our Content Delivery API documentation
By default, the limit for response details per request is 100, with the maximum limit set at 250.

Pagination

In a single instance, the Get Multiple Entries query will retrieve only the first 100 items of the specified content type. You can paginate and retrieve the rest of the items in batches using the skip and limit parameters in subsequent requests.

import com.contentstack.sdk.*;
 
Stack stack = Contentstack.stack(context,"apiKey","deliveryToken","environment"); 
Query query = stack.contentType("contentTypeUid").query();  
query.skip(20).limit(20).find(new QueryResultsCallBack(){  
  @Override  public void onCompletion(ResponseType responseType, QueryResult queryResult, Error error){ 
   if(error == null){
     System.out.println("response: "+queryResult);
   }}  
});

Contentstack

Contentstack class that exposes Stack instance

stack

The stack method provides access to the stack of your site, allowing users to retrieve and manage content within a single space.

Returns:

Type

Stack

Name	Type	Description
context (required)	ApplicationContext	The application context
apiKey (required)	String	API Key of your application on Contentstack
deliveryToken (required)	String	Delivery Tokens retrieves only the published entries of the environment with which it is associated
environment (required)	String	A publishing environment refers to one or more deployment servers or a content delivery destination (Webpage’s address) where you will publish your content (entries or assets).
config	Config	Config instance to set environment and other configuration details.

import com.contentstack.sdk.*;
 
Stack stack = Contentstack.stack(context, "apiKey", "deliveryToken", "environment");

Example with Config:

import com.contentstack.sdk.*; 

Config config = new Config().setHost("api.contentstack.io");
Stack stack = Contentstack.stack(context, "apiKey", "deliveryToken", "environment");

Config

Config class that exposes config instance, Where the user can provide other configurations on the stack

setBranch

The setBranch method sets the target branch for the stack to retrieve content from a specific development or release branch.

Returns:

Type

void

Name	Type	Description
branch (required)	String	branch you want to set

import com.contentstack.sdk.*;

Config config = new Config();
config.setBranch("branchName");
Stack stack = Contentstack.stack(context, "apiKey", "deliveryToken", "environment", config);

getBranch

The getBranch method retrieves the branch currently set on the stack.

Returns:

Type

String

import com.contentstack.sdk.*;

Config config = new Config();
config.getBranch();
Stack stack = Contentstack.stack("apiKey", "deliveryToken", "environment", config);

setProxy

The setProxy method sets a custom proxy to route SDK network requests through a specified HTTP proxy server.

Returns:

Type

void

Name	Type	Description
proxy (required)	Proxy	Proxy setting, typically a type (http, socks) and a socket address. A Proxy is an immutable object

import com.contentstack.sdk.*;

java.net.Proxy proxy = new Proxy(Proxy.Type.HTTP, new InetSocketAddress("proxyHost", "proxyPort"));
java.net.Proxy proxy = new Proxy(Proxy.Type.HTTP, new InetSocketAddress("sl.theproxyvpn.io", 80));
Config config = new Config();
config.setProxy(proxy);

getProxy

Returns the Proxy instance

Returns:

Type

ConnectionPool

import com.contentstack.sdk.*;

Config config = new Config()
config.getProxy()
Stack stack = Contentstack.stack("apiKey", "deliveryToken", "environment", config);

getRegion

The getRegion method retrieves the region associated with the request URL.

Returns:

Type

ContentstackRegion

import com.contentstack.sdk.*;

Config config = new Config();
config.getRegion();
Stack stack = Contentstack.stack(<span>context,</span>"apiKey", "deliveryToken", "environment", config);

setRegion()

DB region for your stack. You can choose from six regions namely, NA, EU, Azure NA, Azure EU, GCP NA, and GCP EU.

Returns:

Type

ContentstackRegion

Name	Type	Description
region (required)	ContentstackRegion	DB region for your stack. You can choose from six regions namely, NA, EU, Azure NA, Azure EU, GCP NA, and GCP EU. Default: ContentstackRegion. US

import com.contentstack.sdk.*;
Config config = new Config()
config.setRegion(ContentstackRegion.EU)
Stack stack = Contentstack.stack("apiKey", "deliveryToken", "environment", config);

getHost()

The getHost method retrieves the host associated with the request URL.

Returns:

Type

String

import com.contentstack.sdk.*;

Config config = new Config();
config.getHost();
Stack stack = Contentstack.stack(<span>context,</span>"apiKey", "deliveryToken", "environment", config);

setHost()

The setHost method sets a custom host for the request URL to direct API calls to a specified endpoint.

Returns:

Type

String

Name	Type	Description
hostname (required)	String	The host

import com.contentstack.sdk.*;

Config config = new Config();
config.sethost(hostname);
Stack stack = Contentstack.stack(<span>context,</span>"apiKey", "deliveryToken", "environment", config);

getVersion()

The getVersion method retrieves the version of the request path.

Returns:

Type

String

import com.contentstack.sdk.*;

Config config = new Config();
config.getVersion();
Stack stack = Contentstack.stack(<span>context,</span>"apiKey", "deliveryToken", "environment", config);

setManagementToken()

The setManagementToken method adds the management token to the stack header to authorize content management operations.

Returns:

Type

Config

Name	Type	Description
managementToken (required)	String	The Management Token

import com.contentstack.sdk.*;

Config config = new Config();
config.setManagementToken(managementToken);
Stack stack = Contentstack.stack(<span>context,</span>"apiKey", "deliveryToken", "environment", config);

earlyAccess

The earlyAccess method retrieves features by enabling the early access header, allowing access to functionalities that are part of the early access program.

Returns:

Type

Config

Example:

Config config = new Config();
String[] earlyAccess = {"Taxonomy", "Teams", "Terms", "LivePreview"};
config.earlyAccess(earlyAccess);
stack = Contentstack.stack("apiKey", "deliveryToken", "environment", config);

Asset

In Contentstack, any files (images, videos, PDFs, audio files, and so on) that you upload get stored in your repository for future use. This repository of uploaded files is called Assets.

fetch

The fetch method retrieves a particular asset by using its asset UID.

Returns:

Type

void

Name	Type	Description
callback (required)	FetchResultCallback	callback of the asset response

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(applicationContext, "apiKey", "deliveryToken", "environment");
Asset asset = stack.asset("assetUid");
asset.fetch(new FetchResultCallback() {
@Override 
public void onCompletion(ResponseType responseType, Error error){

}}

includeBranch

Includes Branch in the asset response

Returns:

Type

Asset

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(context, "apiKey", "deliveryToken", "environment");
Asset asset = stack.asset("assetUid");
asset.includeBranch();

includeFallback

The includeFallback method includes the fallback language content in the asset response when the specified locale content is unavailable.

Returns:

Type

Asset

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(context,"apiKey","deliveryToken","environment");
Asset asset = stack.asset("assetUid");
asset.includeFallback();

includeMetadata

The includeMetadata method includes the asset metadata along with the response body.

Returns:

Type

Asset

Stack stack = Contentstack.stack(context, "apiKey", "deliveryToken", "environment");
final Asset asset = stack.asset("assetUid");
asset.includeMetadata();

addParam

The addParam method adds a query parameter to the asset request to filter the response.

Returns:

Type

Asset

Name	Type	Description
key (required)	String	Key of the header you want to add
value (required)	String	Add value to the header against the header key

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(context,"apiKey","deliveryToken","environment");
Asset asset = stack.asset("assetUid");
asset.addParam();

includeDimension

The includeDimension method includes the dimension information such as height and width in the asset response.

Returns:

Type

Asset

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(context,"apiKey","deliveryToken","environment");
Asset asset = stack.asset("assetUid");
asset.includeDimension();

setTags

The setTags method includes the specified tags in the asset response to categorize the asset.

Returns:

Type

Asset

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(context,"apiKey","deliveryToken","environment");
Asset asset = stack.asset("assetUid");
asset.setTags()

getTags

Includes Array of tags in the asset response

Returns:

Type

String[]

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(context,"apiKey","deliveryToken","environment");
Asset asset = stack.asset("assetUid");
asset.getTags()

getDeletedBy

Gets Deleted by object from the asset response

Returns:

Type

String

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(context,"apiKey","deliveryToken","environment");
Asset asset = stack.asset("assetUid");
asset.getDeletedBy()

getDeleteAt

Gets Deleted At object from the asset response

Returns:

Type

String

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(context,"apiKey","deliveryToken","environment");
Asset asset = stack.asset("assetUid");
asset.getDeleteAt()

getUpdatedBy

Gets UpdatedBy object from the asset response

Returns:

Type

String

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(context,"apiKey","deliveryToken", "environment");
Asset asset = stack.asset("assetUid");
asset.getUpdatedBy();

getUpdateAt

The getUpdateAt method retrieves the updated at object from the asset response, indicating the timestamp when the asset was last updated.

Returns:

Type

String

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(<span>context, </span>apiKey, deliveryToken, environment);
Asset asset = stack.asset(assetUid);
asset.fetch(new FetchResultCallback() {
@Override
public void onCompletion(ResponseType responseType, Error error) {
 asset.getUpdateAt();
}
});

getCreatedBy

The getCreatedBy method retrieves the created by object from the asset response, indicating which user created the asset.

Returns:

Type

String

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(<span>context, </span>apiKey, deliveryToken, environment);
Asset asset = stack.asset(assetUid);
asset.fetch(new FetchResultCallback() {
@Override
public void onCompletion(ResponseType responseType, Error error) {
 asset.getCreatedBy();
}
});

getCreateAt

The getCreateAt method retrieves the created at object from the asset response, indicating the timestamp when the asset was created.

Returns:

Type

String

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(<span>context, </span>apiKey, deliveryToken, environment);
Asset asset = stack.asset(assetUid);
asset.fetch(new FetchResultCallback() {
@Override
public void onCompletion(ResponseType responseType, Error error) {
 asset.getCreateAt();
}
});

toJSON

The toJSON method retrieves the JSON object representation of the asset from the asset response.

Returns:

Type

JSONObject

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(<span>context, </span>apiKey, deliveryToken, environment);
Asset asset = stack.asset(assetUid);
asset.fetch(new FetchResultCallback() {
@Override
public void onCompletion(ResponseType responseType, Error error) {
 asset.toJSON();
}
});

getUrl

The getUrl method retrieves the URL of the asset from the asset response.

Returns:

Type

JSONObject

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(<span>context, </span>apiKey, deliveryToken, environment);
Asset asset = stack.asset(assetUid);
asset.fetch(new FetchResultCallback() {
@Override
public void onCompletion(ResponseType responseType, Error error) {
 asset.<span>getUrl()</span>;
}
});

getFileName

The getFileName method retrieves the file name of the asset from the asset response.

Returns:

Type

String

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(<span>context, </span>apiKey, deliveryToken, environment);
Asset asset = stack.asset(assetUid);
asset.fetch(new FetchResultCallback() {
@Override
public void onCompletion(ResponseType responseType, Error error) {
 asset.<span>getFileName()</span>;
}
});

getFileSize

The getFileSize method retrieves the file size of the asset from the asset response.

Returns:

Type

String

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(<span>context, </span>apiKey, deliveryToken, environment);
Asset asset = stack.asset(assetUid);
asset.fetch(new FetchResultCallback() {
@Override
public void onCompletion(ResponseType responseType, Error error) {
 asset.getFileSize();
}
});

getFileType

The getFileType method retrieves the file type of the asset from the asset response.

Returns:

Type

String

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(<span>context, </span>apiKey, deliveryToken, environment);
Asset asset = stack.asset(assetUid);
asset.fetch(new FetchResultCallback() {
@Override
public void onCompletion(ResponseType responseType, Error error) {
 asset.getFileType();
}
});

getAssetUid

The getAssetUid method retrieves the asset UID from the asset response.

Returns:

Type

String

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(<span>context, </span>apiKey, deliveryToken, environment);
Asset asset = stack.asset(assetUid);
asset.fetch(new FetchResultCallback() {
@Override
public void onCompletion(ResponseType responseType, Error error) {
 asset.getAssetUid();
}
});

removeHeader

The removeHeader method removes a header from the request by using the specified key.

Returns:

Type

void

Name	Type	Description
headerKey (required)	String	Key of the header you want to remove

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(<span>context, </span>apiKey, deliveryToken, environment);
Asset asset = stack.asset(assetUid);
asset.removeHeader(headerKey);

AssetLibrary

In Contentstack, any files (images, videos, PDFs, audio files, and so on) that you upload get stored in your repository for future use. This repository of uploaded files is called Assets.

sort

The sort method sorts the asset library based on order criteria.

Returns:

Type

AssetLibrary

Name	Type	Description
keyOrderBy (required)	String	the key order by
orderby (required)	ORDERBY	the orderby can be applied using ORDERBY enums

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
AssetLibrary assets = stack.assetLibrary()
assets.sort(keyOrderBy, ORDERBY.ASCENDING);

includeCount

The includeCount method includes the total count of assets in the asset library response.

Returns:

Type

AssetLibrary

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
AssetLibrary assets = stack.assetLibrary()
assets.includeCount();

includeRelativeUrl

The includeRelativeUrl method includes the relative URLs of assets in the asset library response.

Returns:

Type

AssetLibrary

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
AssetLibrary assets = stack.assetLibrary()
assets.includeRelativeUrl();

includeMetadata

The includeMetadata method includes the asset library metadata along with the response body.

Returns:

Type

AssetLibrary

Stack stack = Contentstack.stack(context, "apiKey", "deliveryToken", environment_name);
AssetLibrary assets = stack.assetLibrary();
assets.includeMetadata();

setHeader

The setHeader method adds a header to the request using the specified key and value.

Returns:

Type

AssetLibrary

Name	Type	Description
key (required)	String	The key you want to remove from the header
value (required)	String	Value of the header against the key

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
AssetLibrary assets = stack.assetLibrary()
assets.setHeader(key, value);

removeHeader

The removeHeader method removes a header associated with the specified key.

Returns:

Type

AssetLibrary

Name	Type	Description
key (required)	String	The key you want to remove from the header

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
AssetLibrary assets = stack.assetLibrary()
assets.removeHeader(key);

includeFallback

The includeFallback method includes the fallback language content in the asset response when the specified locale content is unavailable.

Returns:

Type

AssetLibrary

import com.contentstack.sdk.*;

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

getCount

The getCount method returns the total number of assets available in the stack.

Returns:

Type

int

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
AssetLibrary assets = stack.assetLibrary()
assets.getCount()

setHeader

Fetch all the assets

Returns:

Type

Query

Name	Type	Description
callback (required)	FetchAssetsCallback	The callback of type FetchAssetsCallback

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
AssetLibrary assets = stack.assetLibrary()
assets.fetchAll(new FetchAssetsCallback({

});

where

The where method retrieves assets from the stack by applying filter conditions on any field UID associated with the assets.

Returns:

Type

AssetLibrary

Name	Type	Description
field_name	String	Enter the field UID of the asset
value	String	Enter the value

Example:

   import com.contentstack.sdk.*;
   Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
   AssetLibrary assets = stack.assetLibrary().where("field_name","value");
   assets.fetchAll(new FetchAssetsCallback(){
    @Override
    public void onCompletion(ResponseType responseType,List<Asset> assets,Error 
    error)
{ 
  System.out.println(assets);
 }});

ContentType

Content type defines the structure or schema of a page or a section of your web or mobile property. To create content for your application, you are required to first create a content type, and then create entries using the content type.

removeHeader

The removeHeader method removes a header from the stack by using the specified header key.

Returns:

Type

void

Name	Type	Description
headerKey (required)	String	The key of the header

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(context, apiKey, deliveryToken, environment);
ContentType contentType = stack.contentType("contentTypeUid");
contentType.removeHeader(headerKey)

entry

The entry method retrieves a specific entry, which is an actual piece of content created using one of the defined content types.

Returns:

Type

Entry

Name	Type	Description
entryUid (required)	String	The entry unique ID of the entry that you want to fetch

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(context, apiKey, deliveryToken, environment);
ContentType contentType = stack.contentType("contentTypeUid");
contentType.entry("entryUid")

query

The query method returns a query instance for building and executing advanced entry queries on a specified content type.

Returns:

Type

void

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(context, apiKey, deliveryToken, environment);
ContentType contentType = stack.contentType("contentTypeUid");
contentType.query()

fetch

The fetch method retrieves all the content types available for the stack.

Returns:

Type

void

Name	Type	Description
params (required)	JSONObject	key value parameters of type JSONObject
callback (required)	ContentTypesCallback	The callback of type ContentTypesCallback

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(context, apiKey, deliveryToken, environment);
ContentType contentType = stack.contentType("contentTypeUid");
contentType.fetch(new JSONObject(), new ContentTypesCallback() {
 @Override
public void onCompletion(ContentTypesModel model, Error error) {
   JSONArray resp = model.getResultArray();
}
});

Entry

An entry is the actual piece of content created using one of the defined content types.

exceptWithReferenceUid()

The exceptWithReferenceUid method specifies an array of except keys that gets excluded from the response.

Returns:

Type

Entry

Name	Type	Description
fieldUid (required)	ArrayList<String>	Array of the except reference keys to be excluded in response
referenceFieldUid (required)	String	Key who has reference to some other class object

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
final Entry entry = stack.contentType("contentType").entry("entryUid");
entry.<span>exceptWithReferenceUid</span>()
ArrayList<String> array = new ArrayList<String>();
<span>array.add("description");</span>
<span>array.add("name");</span>
<span>entry.onlyWithReferenceUid(array, "referenceUid");</span>

onlyWithReferenceUid

The onlyWithReferenceUid method specifies an array of reference UIDs that should be included in the response.

Returns:

Type

Entry

Name	Type	Description
fieldUid (required)	ArrayList<String>	Array of the only reference keys to be included in response.
referenceFieldUid (required)	String	Key who has reference to some other class object

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
final Entry entry = stack.contentType("contentType").entry("entryUid");
ArrayList<String> array = new ArrayList<String>();
array.add("description");
array.add("name");
entry.onlyWithReferenceUid(array, "referenceUid");

only

The only method specifies an array of keys in the base object to include in the response.

Returns:

Type

Entry

Name	Type	Description
fieldUid (required)	ArrayList<String>	Array of the only reference keys to be included in response

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
final Entry entry = stack.contentType("contentType").entry("entryUid");
entry.only(new String[]{"name", "description"});

includeReference

The includeReference method adds a constraint that requires the details of a specified reference key.

Returns:

Type

Entry

Name	Type	Description
referenceFields (required)	String[]	referenceFields array key that to be constrained

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
final Entry entry = stack.contentType("contentType").entry("entryUid");
entry.includeReference(new String[]{"referenceUid_A", "referenceUid_B"});

except

The except method specifies an array of field UIDs that are excluded from the response.

Returns:

Type

Entry

Name	Type	Description
referenceField (required)	String	field uid which get excluded from the response.

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
final Entry entry = stack.contentType("contentType").entry("entryUid");
entry.except(new String[]{"name", "description"});

setLocale

The setLocale method sets the language of the entry.

Returns:

Type

Entry

Name	Type	Description
locale (required)	String	language code

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
final Entry entry = stack.contentType("contentType").entry("entryUid");
Entry entry = entry.setLocale();

getLocale

The getLocale method retrieves the locale of the entry, indicating the language of the content.

Returns:

Type

Entry

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
final Entry entry = stack.contentType("contentType").entry("entryUid");
Entry entry = entry.getLocale();

getUid

The getUid method retrieves the UID of the entry.

Returns:

Type

Entry

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
final Entry entry = stack.contentType("contentType").entry("entryUid");
Entry entry = entry.getUid()

getContentType

The getContentType method retrieves the content type of the entry.

Returns:

Type

Entry

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
final Entry entry = stack.contentType("contentType").entry("entryUid");
Entry entry = entry.getContentType()

getTags

The getTags method retrieves the tags associated with the entry.

Returns:

Type

String[]

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
final Entry entry = stack.contentType("contentType").entry("entryUid");
Entry entry = entry.<span>getTags</span>()

removeHeader

The removeHeader method removes a header associated with the specified key.

Returns:

Type

void

Name	Type	Description
key	String	key of the header you want to remove

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
final Entry entry = stack.contentType("contentType").entry("entryUid");
Entry entry = entry.removeHeader(key)

setHeader

The setHeader method adds a header using the specified key and value.

Returns:

Type

void

Name	Type	Description
key	String	key of the header you want to remove
value (required)	String	value of the header against the key

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
final Entry entry = stack.contentType("contentType").entry("entryUid");
Entry entry = entry.setHeader(key, value)

fetch

The fetch method retrieves the entry using its UID, and can optionally include query parameters to refine the response.

Returns:

Type

void

Name	Type	Description
callback (required)	EntryResultCallBack	EntryResultCallBack object to notify the application when the request has completed

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
final Entry entry = stack.contentType("contentType").entry("entryUid");
entry.fetch(new EntryResultCallBack() {
@Override public void onCompletion(ResponseType responseType, Error error) {
}
});}

addParam

The addParam method adds query parameters to the entry request to filter the response.

Returns:

Type

Entry

Name	Type	Description
key (required)	String	key of the header
value (required)	String	value of the header

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(<span>context, </span>apiKey, deliveryToken, environment);
final Entry entry = stack.contentType("contentType").entry("entryUid");
entry.addParam(key, value)

includeReferenceContentTypeUID

The includeReferenceContentTypeUID method includes the content type UIDs of referenced entries in the entry response.

Returns:

Type

Entry

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(<span>context, </span>apiKey, deliveryToken, environment);
final Entry entry = stack.contentType("contentType").entry("entryUid");
entry.includeReferenceContentTypeUID()

includeContentType

The includeContentType method includes the content type UID of the entry.

Returns:

Type

Entry

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(<span>context, </span>apiKey, deliveryToken, environment);
final Entry entry = stack.contentType("contentType").entry("entryUid");
entry.includeContentType()

includeFallback

The includeFallback method includes the fallback language content in the entry response when the specified locale content is unavailable.

Returns:

Type

Entry

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(<span>context, </span>apiKey, deliveryToken, environment);
final Entry entry = stack.contentType("contentType").entry("entryUid");
entry.includeFallback()

includeEmbeddedItems

The includeEmbeddedItems method includes embedded items in the entry response.

Returns:

Type

Entry

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(<span>context, </span>apiKey, deliveryToken, environment);
final Entry entry = stack.contentType("contentType").entry("entryUid");
entry.includeEmbeddedItems()

includeBranch

The includeBranch method includes the branch information in the entry response.

Returns:

Type

void

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(<span>context, </span>apiKey, deliveryToken, environment);
final Entry entry = stack.contentType("user").entry("entryUid");
entry.includeBranch();

includeMetadata

The includeMetadata method includes the entry metadata along with the response body.

Returns:

Type

Entry

Stack stack = Contentstack.stack(context, "apiKey", "deliveryToken", environment_name);
Entry entry = stack.contentType("contentTypeUid").entry("entryUid");
entry.includeMetadata();

variants

The variants method retrieves details of a specific entry variant or an array of entry variants based on the applied query.

When Personalize creates a variant in the CMS, it assigns a "Variant Alias" to identify that specific variant. When fetching entry variants using the Delivery API, you can pass variant aliases in place of variant UIDs in the x-cs-variant-uid header.

Returns:

Type

Entry

Name	Type	Description
variantUid/variantAlias (required)	String / String []	Enter the UID/Alias of the variant

Example 1:

import com.contentstack.sdk.*;
Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
final Entry entry = stack
                    .contentType("contentType")
                    .entry("entryUid")
                    .variants("variantUid/variantAlias");
 entry.fetch(new EntryResultCallBack() {
     @Override
     public void onCompletion(ResponseType responseType, Error error) {
              System.out.println(entry.toJSON());
         }
 });

Example 2:

import com.contentstack.sdk.*;
Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
final Entry entry = stack
                    .contentType("contentType")
                    .entry("entryUid")
                    .variants(new String[]{"variantUid1/variantAlias1","variantUid2/variantAlias2"});
 entry.fetch(new EntryResultCallBack() {
     @Override
     public void onCompletion(ResponseType responseType, Error error) {
              System.out.println(entry.toJSON());
         }
 });

Query

The Get all entries request fetches the list of all the entries of a particular content type. It returns the content of each entry in JSON format. You need to specify the environment and locale of which you want to get the entries. We can apply filters on query also.

removeHeader

The removeHeader method removes a header from the request using the specified header key.

Returns:

Type

Query

Name	Type	Description
key (required)	String	key of the header you want to remove

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.removeHeader(key)

getContentType

The getContentType method retrieves the content type associated with the request.

Returns:

Type

Query

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.getContentType()

where

The where method filters entries by applying a condition that matches a specified field key with the provided value.

Returns:

Type

Query

Name	Type	Description
key (required)	String	key of query parameter
value (required)	Object	value of query param

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.where("uid", "entry_uid");

addQuery

The addQuery method adds a custom key-value pair to the query URL, enabling support for extended or non-standard query parameters.

Returns:

Type

Query

Name	Type	Description
key (required)	String	key of query parameter
value (required)	String	value of query param

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.addQuery("key", "value");

removeQuery

Remove provided query key from custom query if exist.

Returns:

Type

Query

Name	Type	Description
key (required)	String	Query name to remove.

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.removeQuery(key);

and

The and method combines multiple queries using the AND operator to retrieve results that meet all specified conditions.

Returns:

Type

Query

Name	Type	Description
queryObjects (required)	ArrayList<Query>	List of Query instances on which AND query executes.

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.lessThan("due_date", "2013-06-25T00:00:00+05:30");
Query query = projectClass.query();
query.where('username','something');
Query subQuery = projectClass.query();
subQuery.where('email_address','something@email.com');
ArrayList<Query> array = new ArrayList<Query>();
array.add(query);
array.add(subQuery);
query.and(array);

or

The or method retrieves all entries that meet any of the specified queries by combining them using the OR operator.

Returns:

Type

Query

Name	Type	Description
queryObjects (required)	ArrayList<Query>	the value that provides an upper bound

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.lessThan("due_date", "2013-06-25T00:00:00+05:30");
Query query = projectClass.query();
query.where('username','something');
Query subQuery = projectClass.query();
subQuery.where('email_address','something@email.com');
ArrayList<Query> array = new ArrayList<Query>();
array.add(query);
array.add(subQuery);
query.or(array);

lessThan

The lessThan method applies a constraint that requires a specified key to have a value lower than the given value to retrieve entries.

Returns:

Type

Query

Name	Type	Description
key (required)	String	The key to be constrained
values (required)	Object	the value that provides an upper bound

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.lessThan("due_date", "2013-06-25T00:00:00+05:30");

lessThanOrEqualTo

The lessThanOrEqualTo method applies a constraint that requires a specified key to have a value less than or equal to the given value to retrieve entries.

Returns:

Type

Query

Name	Type	Description
key (required)	String	The key to be constrained
values (required)	Object	The value that must be equalled.

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.lessThanOrEqualTo("due_date", "2013-06-25T00:00:00+05:30");

greaterThan

The greaterThan method applies a constraint that requires a specified key to have a value greater than the given value to retrieve entries.

Returns:

Type

Query

Name	Type	Description
key (required)	String	The key to be constrained
values (required)	Object	The value that provides an lower bound.

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.greaterThan("due_date", "2013-06-25T00:00:00+05:30");

greaterThanOrEqualTo

The greaterThanOrEqualTo method applies a constraint that requires a specified key to have a value greater than or equal to the given value to retrieve entries.

Returns:

Type

Query

Name	Type	Description
key (required)	String	The key to be constrained
values (required)	Object	The list of values the key object should not be.

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.greaterThanOrEqualTo("due_date", "2013-06-25T00:00:00+05:30");

notEqualTo

The notEqualTo method applies a constraint that requires a specified key to have a value not equal to the given value to retrieve entries.

Returns:

Type

Query

Name	Type	Description
key (required)	String	The key to be constrained
values (required)	Object	The list of values the key object should not be.

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.notEqualTo("due_date", "2013-06-25T00:00:00+05:30");

notContainedIn

Add a constraint to the query that requires a particular key's entry to be contained in the provided array

Returns:

Type

Query

Name	Type	Description
key (required)	String	The key to be constrained
values (required)	Object[]	The list of values the key object should not be.

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.containedIn("severity", new Object[] { "Show Stopper", "Critical" });

notContainedIn

The notContainedIn method retrieves entries by applying a constraint that requires a specified key to have a value not contained within the provided array.

Returns:

Type

Query

Name	Type	Description
key (required)	String	The key to be constrained
values (required)	Object[]	The list of values the key object should not be.

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.notContainedIn("severity", new Object[] { "Show Stopper", "Critical" });

exists

The exists method applies a constraint that requires a specified key to be present in the response to retrieve entries.

Returns:

Type

Query

Name	Type	Description
key (required)	String	The key to be constrained

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.exists("status");

notExists

Add a constraint that requires, a specified key does not exists in response.

Returns:

Type

Query

Name	Type	Description
key (required)	String	The key to be constrained

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.notExists("status");

includeReference

The includeReference method adds a constraint that includes the details of a specified reference key in the response to retrieve entries.

Returns:

Type

Query

Name	Type	Description
key (required)	String	key that to be constraineda

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.includeReference(key);

Name	Type	Description
key (required)	String[]	Comma separated array of tags with which to search entries.

ascending

The ascending method sorts the results in ascending order based on the specified key to retrieve entries.

Returns:

Type

Query

Name	Type	Description
key (required)	String	The key to order by.

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.ascending(key);

descending

The descending method sorts the results in descending order based on the specified key to retrieve entries.

Returns:

Type

Query

Name	Type	Description
key (required)	String	The key to order by.

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.descending(key);

only

The only method retrieves entries by specifying an array of keys in the base object that should be included in the response.

Returns:

Type

Query

Name	Type	Description
fieldUid (required)	String[]

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
<span>query.only(new String[]{"name"});</span>

onlyWithReferenceUid

The onlyWithReferenceUid method retrieves entries by specifying an array of only keys that should be included in the response for referenced entries.

Returns:

Type

Query

Name	Type	Description
fieldUid (required)	ArrayList<String>	Array of the only reference keys to be included in response
referenceFieldUid (required)	String	Key who has reference to some other class object

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
ArrayList<String> array = new ArrayList<String>();
array.add("description");
query.onlyWithReferenceUid(array, "for_bug");

exceptWithReferenceUid

Specifies an array of except keys that would be excluded in the response.

Returns:

Type

Query

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
ArrayList<String> array = new ArrayList<String>();
array.add("description");
query.exceptWithReferenceUid(array, "for_bug");

count

The count method retrieves the total count along with the data objects that match the query criteria.

Returns:

Type

Query

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.count();

includeCount

The includeCount method retrieves the count of objects along with the data in the response that match the specified query conditions.

Returns:

Type

Query

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.includeCount();

includeContentType

The includeContentType method retrieves objects along with the content type details of all returned objects in the response.

Returns:

Type

Query

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.includeContentType();

includeOwner

The includeOwner method retrieves objects by including the owner’s profile information in each object’s data.

Returns:

Type

Query

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.<span>includeOwner</span>()

skip

The number of objects to skip before returning any.

Returns:

Type

Query

Name	Type	Description
number (required)	int	Number of objects to skip from returned objects

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.skip(3)

limit

The limit method retrieves entries by setting a limit on the number of objects to return.

Returns:

Type

Query

Name	Type	Description
number (required)	int	Number of objects to limit.

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
csQuery.limit(3)

regex

The regex method retrieves entries by applying a regular expression constraint that matches string values against the provided pattern, which may result in slower performance for large data sets.

Returns:

Type

Query

Name	Type	Description
key (required)	String	The key to be constrained.
regex (required)	String	The regular expression pattern to match
modifiers		Any of the following supported Regular expression modifiers. - use i for case-insensitive matching. - use m for making dot match newlines. - use x for ignoring whitespace in regex

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
csQuery.regex("name", "^browser", "i");

locale

Set Language using locale code.

Returns:

Type

Query

Name	Type	Description
locale (required)	String	language code

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.locale("locale-code");

search

The search method retrieves only the entries that match the specified search value.

Returns:

Type

Query

Name	Type	Description
value (required)	String	value used to match or compare

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.search("header");

findOne

The findOne method retrieves entries that match the query conditions and optionally caches the result to improve performance.

Returns:

Type

Query

Name	Type	Description
callBack (required)	SingleQueryResultCallback	The key as string which needs to be added to the Query

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.findOne(new QueryResultsCallBack() {
Override public void onCompletion(ResponseType responseType, ENTRY entry, Error error) {
}
});

addParam

The addParam method adds a key–value parameter to an entry request.

Returns:

Type

Query

Name	Type	Description
paramKey (required)	String	The key as string which needs to be added to the Query
paramValue (required)	String	The value as string which needs to be added to the Query

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.addParam(key, value);

includeReferenceContentTypUid

The includeReferenceContentTypeUid method retrieves entries by including the content type UIDs of referenced entries in the response.

Returns:

Type

Query

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
csQuery.includeReferenceContentTypUid()

whereIn

The whereIn method retrieves entries by applying conditions to referenced fields and returns those that match the specified values.

Returns:

Type

Query

Name	Type	Description
key (required)	String	The key to be constrained
queryObject (required)	Query	queryObject is Query object, so you can chain this call

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.whereIn("due_date", query);

whereNotIn

The whereNotIn method retrieves entries by applying conditions to referenced fields and returns those that do not match the specified values, functioning as the opposite of the $in query.

Returns:

Type

Query

Name	Type	Description
key (required)	String	The key to be constrained
queryObject (required)	Query	Query object, so you can chain this call

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.whereNotIn("due_date", query);

includeFallback

The includeFallback method retrieves entries by including fallback language content in the response when content for the specified locale is unavailable.

Returns:

Type

Query

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.includeFallback();

includeEmbeddedItems

The includeEmbeddedItems method retrieves entries by including embedded items in the query response.

Returns:

Type

Query

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.includeEmbeddedItems();

includeBranch

The includeBranch method retrieves entries by including branch information in the response.

Returns:

Type

Query

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(context,apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
<span>entry.includeBranch();</span>

includeMetadata

The includeMetadata method retrieves entries by including query metadata in the response body.

Returns:

Type

Query

Stack stack = Contentstack.stack(context, "apiKey", "deliveryToken", environment_name);
Query query = stack.contentType("contenTypeUid").query();
query.includeMetadata();

Taxonomy

Taxonomy helps you categorize pieces of content within your stack to facilitate easy navigation and retrieval of information.

Example:

import com.contentstack.sdk.*;
Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Taxonomy taxonomy = stack.taxonomy();

in

The in method retrieves all entries for a specific taxonomy that satisfy the given conditions provided in the $in query.

Returns:

Type

Instance of Taxonomy Object

Name	Type	Description
taxonomy(required) (required)	string	Enter the UID of the taxonomy
listOfItems	list<string>	Enter the list of taxonomy fields

Example:

Taxonomy taxonomy = stack.taxonomy();
List<string> listOfItems = new ArrayList<>();
listOfItems.add("maroon");
listOfItems.add("red");
taxonomy.in(taxonomy,listOfItems).find(new TaxonomyCallback() {
   @Override
   public void onResponse(JSONObject response, Error error) {
       Log.d("RESULT:",response.toString());
   }
});

or

The or method retrieves all entries for a specific taxonomy that satisfy at lease one of the given conditions provided in the $or query.

Returns:

Type

Instance of Taxonomy Object

Name	Type	Description
listOfItems	list<JSONObject>	Enter the list of taxonomy fields

Example:

Taxonomy taxonomy = stack.taxonomy();
List<jsonobject> listOfItems = new ArrayList<>();
JSONObject item1 = new JSONObject();
item1.put("taxonomies.color", "orange");
JSONObject item2 = new JSONObject();
item2.put("taxonomies.country", "zambia");
listOfItems.add(item1);
listOfItems.add(item2);
taxonomy.or(listOfItems).find(new TaxonomyCallback() {
   @Override
   public void onResponse(JSONObject response, Error error) {
       Log.d("RESULT:",response.toString());
   }
});

and

The and method retrieves all entries for a specific taxonomy that satisfy all the given conditions provided in the $and query.

Returns:

Type

Instance of Taxonomy Object

Name	Type	Description
listOfItems	list<JSONObject>	Enter the list of taxonomy fields

Example:

Taxonomy taxonomy = stack.taxonomy();
List<JSONObject> listOfItems = new ArrayList<>();
JSONObject items1 = new JSONObject();
items1.put("taxonomies.color", "green");
JSONObject items2 = new JSONObject();
items2.put("taxonomies.country", "india");
listOfItems.add(items1);
listOfItems.add(items2);
taxonomy.and(listOfItems).find(new TaxonomyCallback() {
   @Override
   public void onResponse(JSONObject response, Error error) {
       Log.d("RESULT:",response.toString());
   }
});

exists

The exists method retrieves all entries for a specific taxonomy if the value of the field, mentioned in the condition, exists.

Returns:

Type

Instance of Taxonomy Object

Name	Type	Description
taxonomy (required)	string	Enter the UID of the taxonomy
value	boolean	Enter true/false

Example:

Taxonomy taxonomy = stack.taxonomy().exists(taxonomy, Value);
taxonomy.find(new TaxonomyCallback() {
   @Override
   public void onResponse(JSONObject response, Error error) {
       Log.d("RESULT:",response.toString());
   }
});

equalAndBelow

The equalAndBelow method retrieves all entries for a specific taxonomy that match a specific term and all its descendant terms, requiring only the target term.

Returns:

Type

Instance of Taxonomy Object

Name	Type	Description
taxonomy (required)	string	Enter the UID of the taxonomy
termsUid	string	Enter the UID of the term

Example:

Taxonomy taxonomy = stack.taxonomy().equalAndBelow(taxonomy, termsUid);
taxonomy.find(new TaxonomyCallback() {
   @Override
   public void onResponse(JSONObject response, Error error) {
       Log.d("RESULT:",response.toString());
   }
});

below

The below method retrieves all entries for a specific taxonomy that match all of their descendant terms by specifying only the target term and a specific level.

Note: If you don't specify the level, the default behavior is to retrieve terms up to level 10.

Returns:

Type

Instance of Taxonomy Object

Name	Type	Description
taxonomy (required)	string	Enter the UID of the taxonomy
termsUid	string	Enter the UID of the term

Example:

Taxonomy taxonomy = stack.taxonomy().below(taxonomy, termsUid);
taxonomy.find(new TaxonomyCallback() {
   @Override
   public void onResponse(JSONObject response, Error error) {
       Log.d("RESULT:",response.toString());
   }
});

equalAbove

The equalAbove method retrieves all entries for a specific taxonomy that match a specific term and all its ancestor terms, requiring only the target term and a specified level.

Note: If you don't specify the level, the default behavior is to retrieve terms up to level 10.

Returns:

Type

Instance of Taxonomy Object

Name	Type	Description
taxonomy (required)	string	Enter the UID of the taxonomy
termsUid	string	Enter the UID of the term

Example:

Taxonomy taxonomy = stack.taxonomy().equalAbove(taxonomy, termsUid);
taxonomy.find(new TaxonomyCallback() {
   @Override
   public void onResponse(JSONObject response, Error error) {
       Log.d("RESULT:",response.toString());
   }
});

above

The above method retrieves all entries for a specific taxonomy that match only the parent term(s) of a specified target term, excluding the target term itself and a specified level.

Note: If you don't specify the level, the default behavior is to retrieve terms up to level 10.

Returns:

Type

Instance of Taxonomy Object

Name	Type	Description
taxonomy (required)	string	Enter the UID of the taxonomy
termsUid	string	Enter the UID of the term

Example:

Taxonomy taxonomy = stack.taxonomy().above(taxonomy, termsUid);
taxonomy.find(new TaxonomyCallback() {
   @Override
   public void onResponse(JSONObject response, Error error) {
       Log.d("RESULT:",response.toString());
   }
});

find

The find method is used to get API response.

Name	Type	Description
callback	TaxonomyCallback	The callback class that contains the API response

Example:

taxonomy.find(new TaxonomyCallback() {
   @Override
   public void onResponse(JSONObject response, Error error) {
       Log.d("Result:",response.toString());
   }
});

Contentstack basics

Quickstart in 5 mins

Starter apps

Content Delivery APIs

Content Management APIs

How-to guides

Contentstack basics

Quickstart in 5 mins

Starter apps

Content Delivery APIs

Content Management APIs

How-to guides

Contentstack - Android Delivery SDK

Android Delivery SDK for Contentstack

Prerequisite

SDK Installation and Setup

Quickstart in 5 mins

Initializing your SDK

Basic Queries

Pagination

Contentstack

stack

Config

setBranch

getBranch

setProxy

getProxy

getRegion

setRegion()

getHost()

setHost()

getVersion()

setManagementToken()

earlyAccess

Asset

fetch

includeBranch

includeFallback

includeMetadata

addParam

includeDimension

setTags

getTags

getDeletedBy

getDeleteAt

getUpdatedBy

getUpdateAt

getCreatedBy

getCreateAt

toJSON

getUrl

getFileName

getFileSize

getFileType

getAssetUid

removeHeader

AssetLibrary

sort

includeCount

includeRelativeUrl

includeMetadata

setHeader

removeHeader

includeFallback

getCount

setHeader

where

ContentType

removeHeader

entry

query

fetch

Entry

exceptWithReferenceUid()

onlyWithReferenceUid

only

includeReference

except

setLocale

getLocale

Contentstack
basics

Quickstart
in 5 mins

Starter
apps

Content Delivery
APIs

Content
Management APIs

How-to
guides

Contentstack
basics

Quickstart
in 5 mins

Starter
apps

Content Delivery
APIs

Content
Management APIs

How-to
guides