com.contentstack.sdk

Class Group

java.lang.Object

com.contentstack.sdk.Group

public class Group
extends java.lang.Object

Group class is represent group field uid value.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Group(Stack stack, org.json.JSONObject jsonObject)

Method Summary

Modifier and Type	Method and Description
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 group
java.util.List<Asset>	getAssets(java.lang.String key) Get an assets from the group.
java.lang.Boolean	getBoolean(java.lang.String key) Get boolean value for key.
java.util.Calendar	getDate(java.lang.String key) Get Calendar value for key
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 the group.
java.util.List<Group>	getGroups(java.lang.String key) Get a list of group from the group.
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
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
short	getShort(java.lang.String key) Get short value for key
java.lang.String	getString(java.lang.String key) Get string value for key.
org.json.JSONObject	toJSON() Get group representation in json

Methods inherited from class java.lang.Object

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

Constructor Detail

Group

protected Group(Stack stack,
                org.json.JSONObject jsonObject)

Method Detail

toJSON

public org.json.JSONObject toJSON()

Get group representation in json

Example :

 JSONObject json = group.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 = group.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 = group.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 = group.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 = group.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 = group.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 = group.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 = group.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 = group.getJSONObject("key");
 

getInt

public int getInt(java.lang.String key)

Get integer value for key

Parameters:

key - field_uid as key.

Example :

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

getFloat

public float getFloat(java.lang.String key)

Get integer value for key

Parameters:

key - field_uid as key.

Example :

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

getDouble

public double getDouble(java.lang.String key)

Get double value for key

Parameters:

key - field_uid as key.

Example :

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

getLong

public long getLong(java.lang.String key)

Get long value for key

Parameters:

key - field_uid as key.

Example :

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

getShort

public short getShort(java.lang.String key)

Get short value for key

Parameters:

key - field_uid as key.

Example :

 short value = group.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 = group.getDate("key");
 

getAsset

public Asset getAsset(java.lang.String key)

Get an asset from the group

Parameters:

key - field_uid as key.

Example :

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

getAssets

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

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

Parameters:

key - field_uid as key.

Example :

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

getGroup

public Group getGroup(java.lang.String key)

Get a group from the group.

Parameters:

key - field_uid as key.

Example :

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

getGroups

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

Get a list of group from the group.

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

Parameters:

key - field_uid as key.

Example :

 Group innerGroup = group.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);
                           Group   group   = entry.getGroup("fieldUid");
                           Entry taskEntry = entry.getAllEntries("for_task", "task");
                   }
              }

          }
      });