com.contentstack.sdk

Class Stack

java.lang.Object

com.contentstack.sdk.Stack

All Implemented Interfaces:

com.contentstack.sdk.INotifyClass

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

To fetch stack level information of your application from Contentstack server. Created by Shailesh Mishra. Contentstack pvt Ltd

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Stack.PublishType

Field Summary

Fields

Modifier and Type	Field and Description
protected Config	config
protected java.lang.String	contentType
protected android.util.ArrayMap<java.lang.String,java.lang.Object>	headerGroup_app
protected java.lang.String	limit
protected java.lang.String	localeCode
protected android.util.ArrayMap<java.lang.String,java.lang.Object>	localHeader
protected java.lang.String	pagination_token
protected Stack.PublishType	publishType
protected java.lang.String	skip
protected java.lang.String	start_from_date
protected java.lang.String	SYNC_KEY
protected java.lang.String	sync_token
protected java.lang.String	URL
protected java.lang.String	URLSCHEMA
protected java.lang.String	VERSION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Stack(java.lang.String stackApiKey)

Method Summary

Modifier and Type	Method and Description
protected Asset	asset() Create Asset instance.
Asset	asset(java.lang.String uid) Create Asset instance.
AssetLibrary	assetLibrary() Create AssetLibrary instance.
ContentType	contentType(java.lang.String contentTypeName) Represents a ContentType. Create ContentType instance.
java.lang.String	getAccessToken() Get stack access token
java.lang.String	getApplicationKey() Get stack application key
void	getContentTypes(org.json.JSONObject params, com.contentstack.sdk.ContentTypesCallback callback)
void	getResult(java.lang.Object object, java.lang.String controller)
void	getResultObject(java.util.List<java.lang.Object> object, org.json.JSONObject jsonObject, boolean isSingleEntry)
java.lang.String	ImageTransform(java.lang.String image_url, java.util.LinkedHashMap<java.lang.String,java.lang.Object> parameters)
void	removeHeader(java.lang.String key) Remove header key.
protected void	setConfig(Config config)
void	setHeader(java.lang.String key, java.lang.String value) To set headers for Built.io Contentstack rest calls.
void	sync(java.lang.String contentType, java.util.Date from_date, com.contentstack.sdk.Language language, Stack.PublishType type, com.contentstack.sdk.SyncResultCallBack syncCallBack)
void	sync(com.contentstack.sdk.SyncResultCallBack syncCallBack)
void	syncContentType(java.lang.String content_type, com.contentstack.sdk.SyncResultCallBack syncCallBack)
void	syncFromDate(java.util.Date from_date, com.contentstack.sdk.SyncResultCallBack syncCallBack)
void	syncLocale(com.contentstack.sdk.Language language, com.contentstack.sdk.SyncResultCallBack syncCallBack)
void	syncPaginationToken(java.lang.String pagination_token, com.contentstack.sdk.SyncResultCallBack syncCallBack)
void	syncPublishType(Stack.PublishType type, com.contentstack.sdk.SyncResultCallBack syncCallBack)
void	syncToken(java.lang.String sync_token, com.contentstack.sdk.SyncResultCallBack syncCallBack)

Methods inherited from class java.lang.Object

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

Field Detail

localHeader

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

URLSCHEMA

protected java.lang.String URLSCHEMA

URL

protected java.lang.String URL

VERSION

protected java.lang.String VERSION

SYNC_KEY

protected java.lang.String SYNC_KEY

config

protected Config config

headerGroup_app

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

skip

protected java.lang.String skip

limit

protected java.lang.String limit

sync_token

protected java.lang.String sync_token

pagination_token

protected java.lang.String pagination_token

contentType

protected java.lang.String contentType

localeCode

protected java.lang.String localeCode

publishType

protected Stack.PublishType publishType

start_from_date

protected java.lang.String start_from_date

Constructor Detail

Stack

protected Stack(java.lang.String stackApiKey)

Method Detail

setConfig

protected void setConfig(Config config)

contentType

public ContentType contentType(java.lang.String contentTypeName)

Represents a ContentType.
Create ContentType instance.

Parameters:

contentTypeName - contentType name.

Returns:

ContentType instance.

Example :

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

 ContentType contentType = stack.contentType("blog");
 

asset

public Asset asset(java.lang.String uid)

Create Asset instance.

Returns:

ContentType instance.

Example :

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

 Asset asset = stack.asset("assetUid");
 

asset

protected Asset asset()

Create Asset instance.

Returns:

ContentType instance.

Example :

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

 Asset asset = stack.asset();
 

assetLibrary

public AssetLibrary assetLibrary()

Create AssetLibrary instance.

Returns:

ContentType instance.

Example :

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

 AssetLibrary assetLib = stack.assetLibrary();
 

getApplicationKey

public java.lang.String getApplicationKey()

Get stack application key

Example :

 String stackApiKey = stack.getApplicationKey();
 

getAccessToken

public java.lang.String getAccessToken()

Get stack access token

Example :

 String accessToken = stack.getAccessToken();
 

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

  stack.removeHeader("custom_header_key");
 

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

  stack.setHeader("custom_key", "custom_value");
  

ImageTransform

public java.lang.String ImageTransform(java.lang.String image_url,
                                       java.util.LinkedHashMap<java.lang.String,java.lang.Object> parameters)

Parameters:

image_url - on which we want to manipulate.

parameters - It is an second parameter in which we want to place different manipulation key and value in array form

Returns:

String ImageTransform function is define for image manipulation with different parameters in second parameter in array form

Example :

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

  // resize the image by specifying width and height
  LinkedHashMap imageParams = new LinkedHashMap();
  imageParams.put("width", 100);
  imageParams.put("height",100);
  imageUrl = Stack.ImageTransform(image_url, parameters);
  stack.ImageTransform(image_url, parameters);



  

getContentTypes

public void getContentTypes(org.json.JSONObject params,
                            com.contentstack.sdk.ContentTypesCallback callback)

Parameters:

params - query parameters

callback - ContentTypesCallback This call returns comprehensive information of all the content types available in a particular stack in your account.

Example :

 JSONObject params = new JSONObject();
 params.put("include_snippet_schema", true);
 params.put("limit", 3);
 stack.getContentTypes(params, new ContentTypesCallback() {

sync

public void sync(com.contentstack.sdk.SyncResultCallBack syncCallBack)

Parameters:

syncCallBack - returns callback for sync result. The Sync request performs a complete sync of your app data. It returns all the published entries and assets of the specified stack in response. The response also contains a sync token, which you need to store, since this token is used to get subsequent delta updates later.

Example :

 stack.sync(SyncResultCallBack syncCallBack){  }

 

syncPaginationToken

public void syncPaginationToken(java.lang.String pagination_token,
                                com.contentstack.sdk.SyncResultCallBack syncCallBack)

Parameters:

pagination_token - If the response is paginated, use the pagination token under this parameter.

syncCallBack - returns callback for sync result If the result of the initial sync (or subsequent sync) contains more than 100 records, the response would be paginated. It provides pagination token in the response. However, you do not have to use the pagination token manually to get the next batch, the SDK does that automatically until the sync is complete. Pagination token can be used in case you want to fetch only selected batches. It is especially useful if the sync process is interrupted midway (due to network issues, etc.). In such cases, this token can be used to restart the sync process from where it was interrupted.

Example :

 // dummy pagination_token = "blt7f35951d259183fba680e1";
   stack.syncPaginationToken(pagination_token, new SyncResultCallBack()) {}


 

syncToken

public void syncToken(java.lang.String sync_token,
                      com.contentstack.sdk.SyncResultCallBack syncCallBack)

Parameters:

sync_token - Use the sync token that you received in the previous/initial sync under this parameter.

syncCallBack - returns callback for sync result You can use the sync token (that you receive after initial sync) to get the updated content next time. The sync token fetches only the content that was added after your last sync, and the details of the content that was deleted or updated.

Example :

  //dummy sync_token = "blt28937206743728463";
  stack.syncToken(sync_token, new SyncResultCallBack() ){ }

 

syncFromDate

public void syncFromDate(java.util.Date from_date,
                         com.contentstack.sdk.SyncResultCallBack syncCallBack)

Parameters:

from_date - Enter the start date for initial sync.

syncCallBack - Returns callback for sync result. You can also initialize sync with entries published after a specific date. To do this, use syncWithDate and specify the start date as its value.

Example :

   // dummy date final Date start_date = sdf.parse("2018-10-07");
   stack.syncFromDate(start_date, new SyncResultCallBack()) { }


  

syncContentType

public void syncContentType(java.lang.String content_type,
                            com.contentstack.sdk.SyncResultCallBack syncCallBack)

Parameters:

content_type - Provide uid of your content_type

syncCallBack - Returns callback for sync result. You can also initialize sync with entries of only specific content_type. To do this, use syncContentType and specify the content type uid as its value. However, if you do this, the subsequent syncs will only include the entries of the specified content_type.

Example :

 // dummy content_type like "session"
 stack.syncContentType(String content_type, new SyncResultCallBack()){  }

  

syncLocale

public void syncLocale(com.contentstack.sdk.Language language,
                       com.contentstack.sdk.SyncResultCallBack syncCallBack)

Parameters:

language - Select the required locale from the Language class.

syncCallBack - Returns callback for sync result. You can also initialize sync with entries of only specific locales. To do this, use syncLocale and specify the locale code as its value. However, if you do this, the subsequent syncs will only include the entries of the specified locales.

Example :

 // dummy language- Language.ENGLISH_UNITED_STATES
 stackInstance.syncLocale(Language.ENGLISH_UNITED_STATES, new SyncResultCallBack() ) { }

 

syncPublishType

public void syncPublishType(Stack.PublishType type,
                            com.contentstack.sdk.SyncResultCallBack syncCallBack)

Parameters:

type - - Use the type parameter to get a specific type of content like ( asset_published, entry_published, asset_unpublished, asset_deleted, entry_unpublished, entry_deleted, content_type_deleted.)

syncCallBack - returns callback for sync result. Use the type parameter to get a specific type of content. You can pass one of the following values: asset_published, entry_published, asset_unpublished, asset_deleted, entry_unpublished, entry_deleted, content_type_deleted. If you do not specify any value, it will bring all published entries and published assets.

Example :

   stackInstance.syncPublishType(Stack.PublishType.entry_published, new SyncResultCallBack()) { }

  

sync

public void sync(java.lang.String contentType,
                 java.util.Date from_date,
                 com.contentstack.sdk.Language language,
                 Stack.PublishType type,
                 com.contentstack.sdk.SyncResultCallBack syncCallBack)

Parameters:

contentType -

from_date -

language -

type -

syncCallBack - You can also initialize sync with entries that satisfy multiple parameters. To do this, use syncWith and specify the parameters. However, if you do this, the subsequent syncs will only include the entries of the specified parameters

Example :

  stackInstance.sync(String contentType, Date from_date, Language language, PublishType type,  SyncResultCallBack syncCallBack) { }


 

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> object,
                            org.json.JSONObject jsonObject,
                            boolean isSingleEntry)

Specified by:

getResultObject in interface com.contentstack.sdk.INotifyClass