com.contentstack.sdk

Class Entry

java.lang.Object

com.contentstack.sdk.Entry

public class Entry
extends java.lang.Object

Entry is used to create, update and delete contentType's entries on the Contentstack.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.HashMap<java.lang.String,java.lang.Object>	_metadata
protected android.util.ArrayMap<java.lang.String,java.lang.Object>	formHeader
protected boolean	isDelete
protected java.lang.String	language
protected java.util.HashMap<java.lang.String,java.lang.Object>	owner
protected java.lang.String	ownerEmailId
protected java.lang.String	ownerUid
protected org.json.JSONObject	resultJson
protected java.lang.String	title
protected java.lang.String	uid
protected java.lang.String	url

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Entry(java.lang.String contentTypeName)

Method Summary

Modifier and Type	Method and Description
Entry	addParam(java.lang.String key, java.lang.String value) This method adds key and value to an Entry.
void	cancelRequest() To cancel all Entry network requests.
Entry	configure(org.json.JSONObject jsonObject)
Entry	except(java.lang.String[] fieldUid) Specifies list of field uids that would be 'excluded' from the response.
Entry	exceptWithReferenceUid(java.util.ArrayList<java.lang.String> fieldUid, java.lang.String referenceFieldUid) Specifies an array of 'except' keys that would be 'excluded' in the response.
void	fetch(com.contentstack.sdk.EntryResultCallBack callBack) Fetches the latest version of the entries from Built.io content stack
java.lang.Object	get(java.lang.String key) Get object value for key.
java.util.ArrayList<Entry>	getAllEntries(java.lang.String refKey, java.lang.String refContentType) Get value for the given reference key.
Asset	getAsset(java.lang.String key) Get an asset from the entry
java.util.List<Asset>	getAssets(java.lang.String key) Get an assets from the entry.
java.lang.Boolean	getBoolean(java.lang.String key) Get boolean value for key.
java.lang.String	getContentType() Get contentType name.
java.util.Calendar	getCreateAt() Get Calendar value of creation time of entry.
java.lang.String	getCreatedBy() Get uid who created this entry.
java.util.Calendar	getDate(java.lang.String key) Get Calendar value for key
java.util.Calendar	getDeleteAt() Get Calendar value of deletion time of entry.
java.lang.String	getDeletedBy() Get uid who deleted this entry.
double	getDouble(java.lang.String key) Get double value for key
float	getFloat(java.lang.String key) Get integer value for key
Group	getGroup(java.lang.String key) Get a group from entry.
java.util.List<Group>	getGroups(java.lang.String key) Get a list of group from entry.
java.lang.String	getHtmlText(java.lang.String markdownKey) Get html text for markdown data type
int	getInt(java.lang.String key) Get integer value for key
org.json.JSONArray	getJSONArray(java.lang.String key) Get JSONArray value for key
org.json.JSONObject	getJSONObject(java.lang.String key) Get JSONObject value for key
com.contentstack.sdk.Language	getLanguage() Deprecated.
java.lang.String	getLocale() Example : String local = entry.getLocale();
long	getLong(java.lang.String key) Get long value for key
java.util.ArrayList<java.lang.String>	getMultipleHtmlText(java.lang.String markdownKey) Get html text for markdown data type which is multiple true
java.lang.Number	getNumber(java.lang.String key) Get JSONObject value for key
java.util.HashMap<java.lang.String,java.lang.Object>	getOwner()
short	getShort(java.lang.String key) Get short value for key
java.lang.String	getString(java.lang.String key) Get string value for key.
java.lang.String[]	getTags() Get tags.
java.lang.String	getTitle() Get title string
java.lang.String	getUid() Get uid.
java.util.Calendar	getUpdateAt() Get Calendar value of updating time of entry.
java.lang.String	getUpdatedBy() Get uid who updated this entry.
java.lang.String	getURL() Get url string
Entry	includeContentType() Include Content Type of all returned objects along with objects themselves.
Entry	includeFallback() Retrieve the published content of the fallback locale if an entry is not localized in specified locale.
Entry	includeReference(java.lang.String referenceField) Add a constraint that requires a particular reference key details.
Entry	includeReference(java.lang.String[] referenceFields) Add a constraint that requires a particular reference key details.
Entry	includeReferenceContentTypeUID() This method also includes the content type UIDs of the referenced entries returned in the response
Entry	only(java.lang.String[] fieldUid) Specifies an array of 'only' keys in BASE object that would be 'included' in the response.
Entry	onlyWithReferenceUid(java.util.ArrayList<java.lang.String> fieldUid, java.lang.String referenceFieldUid) Specifies an array of 'only' keys that would be 'included' in the response.
void	removeHeader(java.lang.String key) Remove header key.
void	setCachePolicy(com.contentstack.sdk.CachePolicy cachePolicy) To set cache policy using Query instance.
protected void	setContentTypeInstance(ContentType contentTypeInstance)
void	setHeader(java.lang.String key, java.lang.String value) Set headers.
Entry	setLocale(java.lang.String locale) Example : Entry entry = entry.setLocale("en-hi");
protected void	setTags(java.lang.String[] tags)
protected void	setUid(java.lang.String uid)
org.json.JSONObject	toJSON() Get entry representation in json

Methods inherited from class java.lang.Object

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

Field Detail

formHeader

protected android.util.ArrayMap<java.lang.String,java.lang.Object> formHeader

uid

protected java.lang.String uid

resultJson

protected org.json.JSONObject resultJson

ownerEmailId

protected java.lang.String ownerEmailId

ownerUid

protected java.lang.String ownerUid

owner

protected java.util.HashMap<java.lang.String,java.lang.Object> owner

_metadata

protected java.util.HashMap<java.lang.String,java.lang.Object> _metadata

title

protected java.lang.String title

url

protected java.lang.String url

language

protected java.lang.String language

isDelete

protected boolean isDelete

Constructor Detail

Entry

protected Entry(java.lang.String contentTypeName)

Method Detail

setContentTypeInstance

protected void setContentTypeInstance(ContentType contentTypeInstance)

configure

public Entry configure(org.json.JSONObject jsonObject)

setHeader

public void setHeader(java.lang.String key,
                      java.lang.String value)

Set headers.

Parameters:

key - custom_header_key

value - custom_header_value

Example :

 //'blt5d4sample2633b' is a dummy Stack API key
 //'blt6d0240b5sample254090d' is dummy access token.
 Stack stack = Contentstack.stack(context, "blt5d4sample2633b", "blt6d0240b5sample254090d", "stag", false);
 Entry entry = stack.contentType("form_name").entry("entry_uid");
 entry.setHeader("custom_header_key", "custom_header_value");
 

removeHeader

public void removeHeader(java.lang.String key)

Remove header key.

Parameters:

key - custom_header_key

Example :

 //'blt5d4sample2633b' is a dummy Stack API key
 //'blt6d0240b5sample254090d' is dummy access token.
 Stack stack = Contentstack.stack(context, "blt5d4sample2633b", "blt6d0240b5sample254090d", "stag", false);
 Entry entry = stack.contentType("form_name").entry("entry_uid");
 entry.removeHeader("custom_header_key");
 

getTitle

public java.lang.String getTitle()

Get title string

Example :

 String title = entry.getTitle();
 

getURL

public java.lang.String getURL()

Get url string

Example :

 String url = entry.getURL();
 

getTags

public java.lang.String[] getTags()

Get tags.

Example :

 String[] tags = entry.getURL();
 

getContentType

public java.lang.String getContentType()

Get contentType name.

Example :

 String contentType = entry.getFileType();
 

getUid

public java.lang.String getUid()

Get uid.

Example :

 String uid = entry.getUid();
 

getLanguage

@Deprecated
public com.contentstack.sdk.Language getLanguage()

Deprecated.

Get Language instance

Example :

 Language local = entry.getLanguage();
 

getLocale

public java.lang.String getLocale()

Example :

 String local = entry.getLocale();
 

setLocale

public Entry setLocale(java.lang.String locale)

Example :

 Entry entry = entry.setLocale("en-hi");
 

getOwner

public java.util.HashMap<java.lang.String,java.lang.Object> getOwner()

toJSON

public org.json.JSONObject toJSON()

Get entry representation in json

Example :

 JSONObject json = entry.toJSON();
 

get

public java.lang.Object get(java.lang.String key)

Get object value for key.

Parameters:

key - field_uid as key.

Example :

 Object obj = entry.get("key");
 

getHtmlText

public java.lang.String getHtmlText(java.lang.String markdownKey)

Get html text for markdown data type

Parameters:

markdownKey - field_uid as key.

Returns:

html text in string format.

Example :

 String htmlText = entry.getHtmlText("markdownKey");
 

getMultipleHtmlText

public java.util.ArrayList<java.lang.String> getMultipleHtmlText(java.lang.String markdownKey)

Get html text for markdown data type which is multiple true

Parameters:

markdownKey - field_uid as key.

Returns:

html text in string format.

Example :

 ArrayList<String> htmlTexts = entry.getMultipleHtmlText("markdownKey");
 

getString

public java.lang.String getString(java.lang.String key)

Get string value for key.

Parameters:

key - field_uid as key.

Example :

 String value = entry.getString("key");
 

getBoolean

public java.lang.Boolean getBoolean(java.lang.String key)

Get boolean value for key.

Parameters:

key - field_uid as key.

Example :

 Boolean value = entry.getBoolean("key");
 

getJSONArray

public org.json.JSONArray getJSONArray(java.lang.String key)

Get JSONArray value for key

Parameters:

key - field_uid as key.

Example :

 JSONArray value = entry.getJSONArray("key");
 

getJSONObject

public org.json.JSONObject getJSONObject(java.lang.String key)

Get JSONObject value for key

Parameters:

key - field_uid as key.

Example :

 JSONObject value = entry.getJSONObject("key");
 

getNumber

public java.lang.Number getNumber(java.lang.String key)

Get JSONObject value for key

Parameters:

key - field_uid as key.

Example :

 JSONObject value = entry.getJSONObject("key");
 

getInt

public int getInt(java.lang.String key)

Get integer value for key

Parameters:

key - field_uid as key.

Example :

 int value = entry.getInt("key");
 

getFloat

public float getFloat(java.lang.String key)

Get integer value for key

Parameters:

key - field_uid as key.

Example :

 float value = entry.getFloat("key");
 

getDouble

public double getDouble(java.lang.String key)

Get double value for key

Parameters:

key - field_uid as key.

Example :

 double value = entry.getDouble("key");
 

getLong

public long getLong(java.lang.String key)

Get long value for key

Parameters:

key - field_uid as key.

Example :

 long value = entry.getLong("key");
 

getShort

public short getShort(java.lang.String key)

Get short value for key

Parameters:

key - field_uid as key.

Example :

 short value = entry.getShort("key");
 

getDate

public java.util.Calendar getDate(java.lang.String key)

Get Calendar value for key

Parameters:

key - field_uid as key.

Example :

 Calendar value = entry.getDate("key");
 

getCreateAt

public java.util.Calendar getCreateAt()

Get Calendar value of creation time of entry.

Example :

 Calendar createdAt = entry.getCreateAt("key");
 

getCreatedBy

public java.lang.String getCreatedBy()

Get uid who created this entry.

Example :

 String createdBy_uid = entry.getCreatedBy();
 

getUpdateAt

public java.util.Calendar getUpdateAt()

Get Calendar value of updating time of entry.

Example :

 Calendar updatedAt = entry.getUpdateAt("key");
 

getUpdatedBy

public java.lang.String getUpdatedBy()

Get uid who updated this entry.

Example :

 String updatedBy_uid = entry.getUpdatedBy();
 

getDeleteAt

public java.util.Calendar getDeleteAt()

Get Calendar value of deletion time of entry.

Example :

 Calendar updatedAt = entry.getUpdateAt("key");
 

getDeletedBy

public java.lang.String getDeletedBy()

Get uid who deleted this entry.

Example :

 String deletedBy_uid = entry.getDeletedBy();
 

getAsset

public Asset getAsset(java.lang.String key)

Get an asset from the entry

Parameters:

key - field_uid as key.

Example :

 Asset asset = entry.getAsset("key");
 

getAssets

public java.util.List<Asset> getAssets(java.lang.String key)

Get an assets from the entry. This works with multiple true fields

Parameters:

key - field_uid as key.

Example :

 List asset = entry.getAssets("key");
 

getGroup

public Group getGroup(java.lang.String key)

Get a group from entry.

Parameters:

key - field_uid as key.

Example :

 Group innerGroup = entry.getGroup("key");
 

getGroups

public java.util.List<Group> getGroups(java.lang.String key)

Get a list of group from entry.

Note :- This will work when group is multiple true.

Parameters:

key - field_uid as key.

Example :

 Group innerGroup = entry.getGroups("key");
 

getAllEntries

public java.util.ArrayList<Entry> getAllEntries(java.lang.String refKey,
                                                java.lang.String refContentType)

Get value for the given reference key.

Parameters:

refKey - key of a reference field.

refContentType - class uid.

Returns:

ArrayList of Entry instances. Also specified contentType value will be set as class uid for all Entry instance.

Example :

  //'blt5d4sample2633b' is a dummy Stack API key
  //'blt6d0240b5sample254090d' is dummy access token.
  Stack stack = Contentstack.stack(context, "blt5d4sample2633b", "blt6d0240b5sample254090d", "stag", false);
  Query csQuery = stack.contentType("contentType_name").query();

 csQuery.includeReference("for_bug");

 csQuery.find(new QueryResultsCallBack() {

          @Override
          public void onCompletion(ResponseType responseType, QueryResult queryResult, Error error) {


              if(error == null){
                  List<Entry> list = builtqueryresult.getResultObjects();
                   for (int i = 0; i < list.queueSize(); i++) {
                           Entry   entry   = list.get(i);
                           Entry taskEntry = entry.getAllEntries("for_task", "task");
                  }
              }

          }
      });


 

except

public Entry except(java.lang.String[] fieldUid)

Specifies list of field uids that would be 'excluded' from the response.

Parameters:

fieldUid - field uid which get 'excluded' from the response.

Returns:

Entry object, so you can chain this call.

Example :

     //'blt5d4sample2633b' is a dummy Stack API key
     //'blt6d0240b5sample254090d' is dummy access token.
     Stack stack = Contentstack.stack(context, "blt5d4sample2633b", "blt6d0240b5sample254090d", "stag", false);
     Entry entry = stack.contentType("form_name").entry("entry_uid");

     entry.except(new String[]{"name", "description"});
 

includeReference

public Entry includeReference(java.lang.String referenceField)

Add a constraint that requires a particular reference key details.

Parameters:

referenceField - key that to be constrained.

Returns:

Entry object, so you can chain this call.

Example :

    //'blt5d4sample2633b' is a dummy Stack API key
    //'blt6d0240b5sample254090d' is dummy access token.
    Stack stack = Contentstack.stack(context, "blt5d4sample2633b", "blt6d0240b5sample254090d", "stag", false);
    Entry entry = stack.contentType("form_name").entry("entry_uid");

    entry.includeReference("referenceUid");
 

includeReference

public Entry includeReference(java.lang.String[] referenceFields)

Add a constraint that requires a particular reference key details.

Parameters:

referenceFields - array key that to be constrained.

Returns:

Entry object, so you can chain this call.

Example :

    //'blt5d4sample2633b' is a dummy Stack API key
    //'blt6d0240b5sample254090d' is dummy access token.
    Stack stack = Contentstack.stack(context, "blt5d4sample2633b", "blt6d0240b5sample254090d", "stag", false);
    Entry entry = stack.contentType("form_name").entry("entry_uid");

    entry.includeReference(new String[]{"referenceUid_A", "referenceUid_B"});
 

only

public Entry only(java.lang.String[] fieldUid)

Specifies an array of 'only' keys in BASE object that would be 'included' in the response.

Parameters:

fieldUid - Array of the 'only' reference keys to be included in response.

Returns:

Entry object, so you can chain this call.

Example :

    //'blt5d4sample2633b' is a dummy Stack API key
    //'blt6d0240b5sample254090d' is dummy access token.
    Stack stack = Contentstack.stack(context, "blt5d4sample2633b", "blt6d0240b5sample254090d", "stag", false);
    Entry entry = stack.contentType("form_name").entry("entry_uid");

    entry.only(new String[]{"name", "description"});
 

onlyWithReferenceUid

public Entry onlyWithReferenceUid(java.util.ArrayList<java.lang.String> fieldUid,
                                  java.lang.String referenceFieldUid)

Specifies an array of 'only' keys that would be 'included' in the response.

Parameters:

fieldUid - Array of the 'only' reference keys to be included in response.

referenceFieldUid - Key who has reference to some other class object..

Returns:

Entry object, so you can chain this call.

Example :

    //'blt5d4sample2633b' is a dummy Stack API key
    //'blt6d0240b5sample254090d' is dummy access token.
    Stack stack = Contentstack.stack(context, "blt5d4sample2633b", "blt6d0240b5sample254090d", "stag", false);
    Entry entry = stack.contentType("form_name").entry("entry_uid");

    ArrayList<String> array = new ArrayList<String>();
    array.add("description");
    array.add("name");

    entry.onlyWithReferenceUid(array, "referenceUid");
 

exceptWithReferenceUid

public Entry exceptWithReferenceUid(java.util.ArrayList<java.lang.String> fieldUid,
                                    java.lang.String referenceFieldUid)

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

Parameters:

fieldUid - Array of the 'except' reference keys to be excluded in response.

referenceFieldUid - Key who has reference to some other class object.

Returns:

Entry object, so you can chain this call.

Example :

    //'blt5d4sample2633b' is a dummy Stack API key
    //'blt6d0240b5sample254090d' is dummy access token.
    Stack stack = Contentstack.stack(context, "blt5d4sample2633b", "blt6d0240b5sample254090d", "stag", false);
    Entry entry = stack.contentType("form_name").entry("entry_uid");

    ArrayList<String> array = new ArrayList<String>();
    array.add("description");
    array.add("name");

    entry.onlyWithReferenceUid(array, "referenceUid");
 

setTags

protected void setTags(java.lang.String[] tags)

setUid

protected void setUid(java.lang.String uid)

fetch

public void fetch(com.contentstack.sdk.EntryResultCallBack callBack)

Fetches the latest version of the entries from Built.io content stack

Parameters:

callBack - EntryResultCallBack object to notify the application when the request has completed. Entry object, so you can chain this call.

Example :

    //'blt5d4sample2633b' is a dummy Stack API key
    //'blt6d0240b5sample254090d' is dummy access token.
    Stack stack = Contentstack.stack(context, "blt5d4sample2633b", "blt6d0240b5sample254090d", "stag", false);
    Entry entry = stack.contentType("form_name").entry("entry_uid");

    entry.fetch(new BuiltResultCallBack() {

           @Override
           public void onCompletion(ResponseType responseType, BuiltError builtError) {

           }

    });

cancelRequest

public void cancelRequest()

To cancel all Entry network requests.

Example :

     entry.cancelRequest();
 

setCachePolicy

public void setCachePolicy(com.contentstack.sdk.CachePolicy cachePolicy)

To set cache policy using Query instance.

Parameters:

cachePolicy - CachePolicy instance.

addParam

public Entry addParam(java.lang.String key,
                      java.lang.String value)

This method adds key and value to an Entry.

Parameters:

key - The key as string which needs to be added to an Entry

value - The value as string which needs to be added to an Entry

Returns:

Entry

Example :

    //'blt5d4sample2633b' is a dummy Stack API key
    //'blt6d0240b5sample254090d' is dummy access token.
    Stack stack = Contentstack.stack(context, "blt5d4sample2633b", "blt6d0240b5sample254090d", "stag", false);
    final Entry entry = stack.contentType("user").entry("blt3b0aaebf6f1c3762"); <br>
    entry.addParam("include_dimensions", "true"); <br>
    entry.fetch(new BuiltResultCallBack() {<br>
           &#64;Override
           public void onCompletion(ResponseType responseType, BuiltError builtError) {

           }<br>
    });<br>

      
   

includeReferenceContentTypeUID

public Entry includeReferenceContentTypeUID()

This method also includes the content type UIDs of the referenced entries returned in the response

Returns:

Entry

Example :

 //'blt5d4sample2633b' is a dummy Stack API key
 //'blt6d0240b5sample254090d' is dummy access token.
 Stack stack = Contentstack.stack(context, "blt5d4sample2633b", "blt6d0240b5sample254090d", "stag", false);
 final Entry entry = stack.contentType("user").entry("blt3b0aaebf6f1c3762"); <br>
 entry.includeReferenceContentTypeUID; <br>
 entry.fetch(new BuiltResultCallBack() {
 <br>&#64;
 Override
 public void onCompletion(ResponseType responseType, BuiltError builtError) {
  }<br>
 });<br>
  
 

includeContentType

public Entry includeContentType()

Include Content Type of all returned objects along with objects themselves.

Returns:

Entry object, so you can chain this call.

Example :

     //'blt5d4sample2633b' is a dummy Stack API key
     //'blt6d0240b5sample254090d' is dummy access token.
     Stack stack = Contentstack.stack(context, "blt5d4sample2633b", "blt6d0240b5sample254090d", "stag", false);
     final Entry entry = stack.contentType("user").entry("blt3b0aaebf6f1c3762");
     entry.includeContentType();
 

includeFallback

public Entry includeFallback()

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

Returns:

Entry object, so you can chain this call.

Example :

     Stack stack = Contentstack.stack(context, "ApiKey", "deliveryToken", "environment");
     final Entry entry = stack.contentType("user").entry("entryUid");
     entry.includeFallback();