com.contentstack.sdk

Class Query

java.lang.Object

com.contentstack.sdk.Query

All Implemented Interfaces:

com.contentstack.sdk.INotifyClass

public class Query
extends java.lang.Object
implements com.contentstack.sdk.INotifyClass

A class that defines a query that is used to query for Entry instance.

Field Summary

Fields

Modifier and Type	Field and Description
protected ContentType	contentTypeInstance
protected android.util.ArrayMap<java.lang.String,java.lang.Object>	formHeader

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Query(java.lang.String formName)

Method Summary

Modifier and Type	Method and Description
Query	addParam(java.lang.String key, java.lang.String value) This method adds key and value to an Entry.
Query	addQuery(java.lang.String key, java.lang.String value) Add a custom query against specified key.
Query	and(java.util.ArrayList<Query> queryObjects) Combines all the queries together using AND operator
Query	ascending(java.lang.String key) Sort the results in ascending order with the given key.
void	cancelRequest() To cancel all Query network requests.
Query	containedIn(java.lang.String key, java.lang.Object[] values) Add a constraint to the query that requires a particular key's entry to be contained in the provided array.
Query	count() Retrieve only count of entries in result.
Query	descending(java.lang.String key) Sort the results in descending order with the given key.
Query	except(java.util.ArrayList<java.lang.String> fieldUid) Specifies list of field uids that would be 'excluded' from the response.
Query	except(java.lang.String[] fieldUids) Specifies list of field uids that would be 'excluded' from the response.
Query	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.
protected void	execQuery(com.contentstack.sdk.SingleQueryResultCallback callBack, com.contentstack.sdk.QueryResultsCallBack callback, boolean isFromLocal)
Query	exists(java.lang.String key) Add a constraint that requires, a specified key exists in response.
Query	find(com.contentstack.sdk.QueryResultsCallBack callback) Execute a Query and Caches its result (Optional)
Query	findOne(com.contentstack.sdk.SingleQueryResultCallback callBack) Execute a Query and Caches its result (Optional)
java.lang.String	getContentType()
void	getResult(java.lang.Object object, java.lang.String controller)
void	getResultObject(java.util.List<java.lang.Object> objects, org.json.JSONObject jsonObject, boolean isSingleEntry)
Query	greaterThan(java.lang.String key, java.lang.Object value) Add a constraint to the query that requires a particular key entry to be greater than the provided value.
Query	greaterThanOrEqualTo(java.lang.String key, java.lang.Object value) Add a constraint to the query that requires a particular key entry to be greater than or equal to the provided value.
Query	includeContentType() Include Content Type of all returned objects along with objects themselves.
Query	includeCount() Retrieve count and data of objects in result.
Query	includeFallback() Retrieve the published content of the fallback locale if an entry is not localized in specified locale.
Query	includeOwner() Include object owner's profile in the objects data.
Query	includeReference(java.lang.String key) Add a constraint that requires a particular reference key details.
Query	includeReference(java.lang.String[] keys) Add a constraint that requires a particular reference key details.
Query	includeReferenceContentTypUid() This method also includes the content type UIDs of the referenced entries returned in the response
Query	language(com.contentstack.sdk.Language language) Deprecated.
Query	lessThan(java.lang.String key, java.lang.Object value) Add a constraint to the query that requires a particular key entry to be less than the provided value.
Query	lessThanOrEqualTo(java.lang.String key, java.lang.Object value) Add a constraint to the query that requires a particular key entry to be less than or equal to the provided value.
Query	limit(int number) A limit on the number of objects to return.
Query	locale(java.lang.String locale)
Query	notContainedIn(java.lang.String key, java.lang.Object[] values) Add a constraint to the query that requires a particular key entry's value not be contained in the provided array.
Query	notEqualTo(java.lang.String key, java.lang.Object value) Add a constraint to the query that requires a particular key's entry to be not equal to the provided value.
Query	notExists(java.lang.String key) Add a constraint that requires, a specified key does not exists in response.
Query	only(java.lang.String[] fieldUid) Specifies an array of 'only' keys in BASE object that would be 'included' in the response.
Query	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.
Query	or(java.util.ArrayList<Query> queryObjects) Add a constraint to fetch all entries which satisfy any queries.
Query	regex(java.lang.String key, java.lang.String regex) Add a regular expression constraint for finding string values that match the provided regular expression.
Query	regex(java.lang.String key, java.lang.String regex, java.lang.String modifiers) Add a regular expression constraint for finding string values that match the provided regular expression.
void	removeHeader(java.lang.String key) Remove header key.
Query	removeQuery(java.lang.String key) Remove provided query key from custom query if exist.
Query	search(java.lang.String value) This method provides only the entries matching the specified value.
Query	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) To set headers for Built.io Contentstack rest calls.
protected void	setQueryJson(com.contentstack.sdk.QueryResultsCallBack callback)
Query	skip(int number) The number of objects to skip before returning any.
Query	tags(java.lang.String[] tags) Include tags with which to search entries.
Query	where(java.lang.String key, java.lang.Object value) Add a constraint to fetch all entries that contains given value against specified key.
Query	whereIn(java.lang.String key, Query queryObject) Get entries having values based on referenced fields.
Query	whereNotIn(java.lang.String key, Query queryObject) Get entries having values based on referenced fields.

Methods inherited from class java.lang.Object

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

Field Detail

contentTypeInstance

protected ContentType contentTypeInstance

formHeader

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

Constructor Detail

Query

protected Query(java.lang.String formName)

Method Detail

setContentTypeInstance

protected void setContentTypeInstance(ContentType contentTypeInstance)

setHeader

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

To set headers for Built.io Contentstack rest calls.
Scope is limited to this object and followed classes.

Parameters:

key - header name.

value - header value against given header name.

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.setHeader("custom_key", "custom_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);
  Query csQuery = stack.contentType("contentType_name").query();

  csQuery.removeHeader("custom_key");
 

getContentType

public java.lang.String getContentType()

where

public Query where(java.lang.String key,
                   java.lang.Object value)

Add a constraint to fetch all entries that contains given value against specified key.

Parameters:

key - field uid.

value - field value which get 'included' from the response.

Returns:

Query object, so you can chain this call.

Note : for group field provide key in a "key.groupFieldUid" format.

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.where("uid", "bltf4fbsample851db");
 

addQuery

public Query addQuery(java.lang.String key,
                      java.lang.String value)

Add a custom query against specified key.

Parameters:

key - key.

value - value.

Returns:

Query 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);
    Query csQuery = stack.contentType("contentType_name").query();

    csQuery.addQuery("query_param_key", "query_param_value");
 

removeQuery

public Query removeQuery(java.lang.String key)

Remove provided query key from custom query if exist.

Parameters:

key - Query name to remove.

Returns:

Query object, so you can chain this call.

Example :

      projectQuery.removeQuery("Query_Key");
 

and

public Query and(java.util.ArrayList<Query> queryObjects)

Combines all the queries together using AND operator

Parameters:

queryObjects - list of Query instances on which AND query executes.

Returns:

Query 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);
    Query csQuery = stack.contentType("contentType_name").query();

    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);

    projectQuery.and(array);
 

or

public Query or(java.util.ArrayList<Query> queryObjects)

Add a constraint to fetch all entries which satisfy any queries.

Parameters:

queryObjects - list of Query instances on which OR query executes.

Returns:

Query 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);
     Query csQuery = stack.contentType("contentType_name").query();

     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);

     csQuery.or(array);
 

lessThan

public Query lessThan(java.lang.String key,
                      java.lang.Object value)

Add a constraint to the query that requires a particular key entry to be less than the provided value.

Parameters:

key - the key to be constrained.

value - the value that provides an upper bound.

Returns:

Query 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);
     Query csQuery = stack.contentType("contentType_name").query();

     csQuery.lessThan("due_date", "2013-06-25T00:00:00+05:30");
 

lessThanOrEqualTo

public Query lessThanOrEqualTo(java.lang.String key,
                               java.lang.Object value)

Add a constraint to the query that requires a particular key entry to be less than or equal to the provided value.

Parameters:

key - The key to be constrained

value - The value that must be equalled.

Returns:

Query 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);
     Query csQuery = stack.contentType("contentType_name").query();

     csQuery.lessThanOrEqualTo("due_date", "2013-06-25T00:00:00+05:30");
 

greaterThan

public Query greaterThan(java.lang.String key,
                         java.lang.Object value)

Add a constraint to the query that requires a particular key entry to be greater than the provided value.

Parameters:

key - The key to be constrained.

value - The value that provides an lower bound.

Returns:

Query 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);
     Query csQuery = stack.contentType("contentType_name").query();

     csQuery.greaterThan("due_date", "2013-06-25T00:00:00+05:30");
 

greaterThanOrEqualTo

public Query greaterThanOrEqualTo(java.lang.String key,
                                  java.lang.Object value)

Add a constraint to the query that requires a particular key entry to be greater than or equal to the provided value.

Parameters:

key - The key to be constrained.

value - The value that provides an lower bound.

Returns:

Query 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);
     Query csQuery = stack.contentType("contentType_name").query();

     csQuery.greaterThanOrEqualTo("due_date", "2013-06-25T00:00:00+05:30");
 

notEqualTo

public Query notEqualTo(java.lang.String key,
                        java.lang.Object value)

Add a constraint to the query that requires a particular key's entry to be not equal to the provided value.

Parameters:

key - The key to be constrained.

value - The object that must not be equaled.

Returns:

Query 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);
     Query csQuery = stack.contentType("contentType_name").query();

     csQuery.notEqualTo("due_date", "2013-06-25T00:00:00+05:30");
 

containedIn

public Query containedIn(java.lang.String key,
                         java.lang.Object[] values)

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

Parameters:

key - The key to be constrained.

values - The possible values for the key's object.

Returns:

Query 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);
     Query csQuery = stack.contentType("contentType_name").query();

     csQuery.containedIn("severity", new Object[]{"Show Stopper", "Critical"});
 

notContainedIn

public Query notContainedIn(java.lang.String key,
                            java.lang.Object[] values)

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

Parameters:

key - The key to be constrained.

values - The list of values the key object should not be.

Returns:

Query 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);
     Query csQuery = stack.contentType("contentType_name").query();

     csQuery.notContainedIn("severity", new Object[]{"Show Stopper", "Critical"});
 

exists

public Query exists(java.lang.String key)

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

Parameters:

key - The key to be constrained.

Returns:

Query 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);
     Query csQuery = stack.contentType("contentType_name").query();

     csQuery.exists("status");
 

notExists

public Query notExists(java.lang.String key)

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

Parameters:

key - The key to be constrained.

Returns:

Query 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);
     Query csQuery = stack.contentType("contentType_name").query();

     csQuery.notExists("status");
 

includeReference

public Query includeReference(java.lang.String key)

Add a constraint that requires a particular reference key details.

Parameters:

key - key that to be constrained.

Returns:

Query 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);
     Query csQuery = stack.contentType("contentType_name").query();

     csQuery.includeReference("for_bug");
 

includeReference

public Query includeReference(java.lang.String[] keys)

Add a constraint that requires a particular reference key details.

Parameters:

keys - array keys that to be constrained.

Returns:

Query 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);
     Query csQuery = stack.contentType("contentType_name").query();

     csQuery.includeReference(new String[]{"for_bug"});
 

tags

public Query tags(java.lang.String[] tags)

Include tags with which to search entries.

Parameters:

tags - Comma separated array of tags with which to search entries.

Returns:

Query 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);
     Query csQuery = stack.contentType("contentType_name").query();

     csQuery.tags(new String[]{"tag1","tag2"});
 

ascending

public Query ascending(java.lang.String key)

Sort the results in ascending order with the given key.
Sort the returned entries in ascending order of the provided key.

Parameters:

key - The key to order by.

Returns:

Query 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);
     Query csQuery = stack.contentType("contentType_name").query();

     csQuery.ascending("name");
 

descending

public Query descending(java.lang.String key)

Sort the results in descending order with the given key.
Sort the returned entries in descending order of the provided key.

Parameters:

key - The key to order by.

Returns:

Query 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);
     Query csQuery = stack.contentType("contentType_name").query();

     csQuery.descending("name");
 

except

public Query except(java.util.ArrayList<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:

Query 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);
     Query csQuery = stack.contentType("contentType_name").query();


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


     csQuery.except(array);
 

except

public Query except(java.lang.String[] fieldUids)

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

Parameters:

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

Returns:

Query 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);
     Query csQuery = stack.contentType("contentType_name").query();


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

only

public Query 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:

Query 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);
     Query csQuery = stack.contentType("contentType_name").query();

     csQuery.only(new String[]{"name"});
 

onlyWithReferenceUid

public Query 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:

Query 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);
     Query csQuery = stack.contentType("contentType_name").query();

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

     csQuery.onlyWithReferenceUid(array, "for_bug");
 

exceptWithReferenceUid

public Query 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:

Query 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);
     Query csQuery = stack.contentType("contentType_name").query();

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

     csQuery.exceptWithReferenceUid(array, "for_bug");
 

count

public Query count()

Retrieve only count of entries in result.

Returns:

Query object, so you can chain this call. Note :-

Call QueryResult.getCount() method in the success to get count of objects.

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.count();
 

includeCount

public Query includeCount()

Retrieve count and data of objects in result.

Returns:

Query object, so you can chain this call. Note :-

Call QueryResult.getCount() method in the success to get count of objects.

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.includeCount();
 

includeContentType

public Query includeContentType()

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

Returns:

Query 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);
     Query csQuery = stack.contentType("contentType_name").query();

     csQuery.includeContentType();
 

includeOwner

public Query includeOwner()

Include object owner's profile in the objects data.

Returns:

Query 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);
     Query csQuery = stack.contentType("contentType_name").query();

     csQuery.includeOwner();
 

skip

public Query skip(int number)

The number of objects to skip before returning any.

Parameters:

number - No of objects to skip from returned objects.

Returns:

Query object, so you can chain this call.

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

Example :

      //'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.skip(2);
 

limit

public Query limit(int number)

A limit on the number of objects to return.

Parameters:

number - No of objects to limit.

Returns:

Query object, so you can chain this call.

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

Example :

      //'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.limit(2);
 

regex

public Query regex(java.lang.String key,
                   java.lang.String regex)

Add a regular expression constraint for finding string values that match the provided regular expression. This may be slow for large data sets.

Parameters:

key - The key to be constrained.

regex - The regular expression pattern to match.

Returns:

Query 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);
      Query csQuery = stack.contentType("contentType_name").query();


      csQuery.regex("name", "^browser");
 

regex

public Query regex(java.lang.String key,
                   java.lang.String regex,
                   java.lang.String modifiers)

Add a regular expression constraint for finding string values that match the provided regular expression. This may be slow for large data sets.

Parameters:

key - The key to be constrained.

regex - 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

Returns:

Query 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);
      Query csQuery = stack.contentType("contentType_name").query();


      csQuery.regex("name", "^browser", "i");
 

language

@Deprecated
public Query language(com.contentstack.sdk.Language language)

Deprecated.

Set Language instance.

Parameters:

language - Language value

Returns:

Query 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);
      Query csQuery = stack.contentType("contentType_name").query();


      csQuery.language(Language.ENGLISH_UNITED_STATES);
 

locale

public Query locale(java.lang.String locale)

Parameters:

locale - String value

Returns:

Query 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);
      Query csQuery = stack.contentType("contentType_name").query();

      csQuery.locale("en-hi");
 

search

public Query search(java.lang.String value)

This method provides only the entries matching the specified value.

Parameters:

value - value used to match or compare

Returns:

Query 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);
      Query csQuery = stack.contentType("contentType_name").query();


      csQuery.search("header");
 

setCachePolicy

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

To set cache policy using Query instance.

Parameters:

cachePolicy - CachePolicy instance.

Returns:

Query 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);
      Query csQuery = stack.contentType("contentType_name").query();


      csQuery.setCachePolicy(NETWORK_ELSE_CACHE);
 

find

public Query find(com.contentstack.sdk.QueryResultsCallBack callback)

Execute a Query and Caches its result (Optional)

Parameters:

callback - QueryResultsCallBack object to notify the application when the request has completed.

Returns:

Query 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);
      Query csQuery = stack.contentType("contentType_name").query();


      csQuery.find(new QueryResultsCallBack() {

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


          }
      });

 

findOne

public Query findOne(com.contentstack.sdk.SingleQueryResultCallback callBack)

Execute a Query and Caches its result (Optional)

Parameters:

callBack - QueryResultsCallBack object to notify the application when the request has completed.

Returns:

Query 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);
      Query csQuery = stack.contentType("contentType_name").query();


      csQuery.findOne(new QueryResultsCallBack() {

          @Override
          public void onCompletion(ResponseType responseType, ENTRY entry, Error error) {


          }
      });

 

cancelRequest

public void cancelRequest()

To cancel all Query network requests.

Example :

      csQuery.cancelRequest();
 

setQueryJson

protected void setQueryJson(com.contentstack.sdk.QueryResultsCallBack callback)

execQuery

protected void execQuery(com.contentstack.sdk.SingleQueryResultCallback callBack,
                         com.contentstack.sdk.QueryResultsCallBack callback,
                         boolean isFromLocal)

getResult

public void getResult(java.lang.Object object,
                      java.lang.String controller)

Specified by:

getResult in interface com.contentstack.sdk.INotifyClass

getResultObject

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

Specified by:

getResultObject in interface com.contentstack.sdk.INotifyClass

addParam

public Query 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 the Query

value - The value as string which needs to be added to the Query

Returns:

Query

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.addParam("key", "some_value");
      csQuery.findOne(new QueryResultsCallBack() {

          @Override
          public void onCompletion(ResponseType responseType, ENTRY entry, Error error) {


          }
      });

 

includeReferenceContentTypUid

public Query includeReferenceContentTypUid()

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

Returns:

Query

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.addParam("key", "some_value");
      csQuery.findOne(new QueryResultsCallBack() {

          @Override
          public void onCompletion(ResponseType responseType, ENTRY entry, Error error) {


          }
      });

 

whereIn

public Query whereIn(java.lang.String key,
                     Query queryObject)

Get entries having values based on referenced fields. This query retrieves all entries that satisfy the query conditions made on referenced fields.

Parameters:

key - The key to be constrained

Returns:

Query 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);
     Query csQuery = stack.contentType("contentType_name").query();
     csQuery.whereIn("due_date");
 

whereNotIn

public Query whereNotIn(java.lang.String key,
                        Query queryObject)

Get entries having values based on referenced fields. This query works the opposite of $in_query and retrieves all entries that does not satisfy query conditions made on referenced fields.

Parameters:

key - The key to be constrained

Returns:

Query 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);
     Query csQuery = stack.contentType("contentType_name").query();
     csQuery.whereNotIn("due_date");
 

includeFallback

public Query includeFallback()

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

Returns:

Query object, so you can chain this call.

Example :

     Stack stack = Contentstack.stack(context, "ApiKey", "deliveryToken",  environment_name);
     Query csQuery = stack.contentType("contentType_name").query();
     csQuery.includeFallback();