com.contentstack.sdk

Class Contentstack

java.lang.Object

com.contentstack.sdk.Contentstack

public class Contentstack
extends java.lang.Object

Contains all Contentstack API classes and functions.

Field Summary

Fields

Modifier and Type	Field and Description
protected static android.content.Context	context
protected static com.android.volley.RequestQueue	requestQueue

Constructor Summary

Constructors

Constructor and Description
Contentstack(android.content.Context applicationContext)

Method Summary

Modifier and Type	Method and Description
<T> void	addToRequestQueue(com.android.volley.Request<T> req)
protected static <T> void	addToRequestQueue(java.lang.String protocol, com.android.volley.Request<T> req, java.lang.String tag)
static Contentstack	getInstance(android.content.Context context) // Private Functionality
com.android.volley.RequestQueue	getRequestQueue()
protected static com.android.volley.RequestQueue	getRequestQueue(java.lang.String protocol)
protected static void	isNetworkAvailable(android.content.Context context) To check network availability.
static Stack	stack(android.content.Context context, java.lang.String stackApiKey, java.lang.String accessToken, java.lang.String environment) Authenticates the stack api key of your stack.
static Stack	stack(android.content.Context context, java.lang.String stackApiKey, java.lang.String accessToken, java.lang.String environment, Config config) Authenticates the stack api key of your stack.

Methods inherited from class java.lang.Object

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

Field Detail

requestQueue

protected static com.android.volley.RequestQueue requestQueue

context

protected static android.content.Context context

Constructor Detail

Contentstack

public Contentstack(android.content.Context applicationContext)

Method Detail

stack

public static Stack stack(android.content.Context context,
                          java.lang.String stackApiKey,
                          java.lang.String accessToken,
                          java.lang.String environment)
                   throws java.lang.Exception

Authenticates the stack api key of your stack. This must be called before your stack uses Built.io Contentstack sdk.
You can find your stack api key from web.

Parameters:

context - application context.

stackApiKey - application api Key of your application on Built.io Contentstack.

accessToken - access token

environment - environment name

Returns:

Stack instance.

Example :

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

Throws:

java.lang.Exception

stack

public static Stack stack(android.content.Context context,
                          java.lang.String stackApiKey,
                          java.lang.String accessToken,
                          java.lang.String environment,
                          Config config)
                   throws java.lang.Exception

Authenticates the stack api key of your stack. This must be called before your stack uses Built.io Contentstack sdk.
You can find your stack api key from web.

Parameters:

context - application context.

stackApiKey - application api Key of your application on Built.io Contentstack.

accessToken - access token

config - Config instance to set environment and other configuration details.

Returns:

Stack instance.

Example :

 //'blt5d4sample2633b' is a dummy Stack API key
 //'blt6d0240b5sample254090d' is dummy access token.
 Config config = new Config();
 config.setEnvironment("stag");

 Stack stack = Contentstack.stack(context, "blt5d4sample2633b", "blt6d0240b5sample254090d", config);

Throws:

java.lang.Exception

getInstance

public static Contentstack getInstance(android.content.Context context)

// Private Functionality

getRequestQueue

public com.android.volley.RequestQueue getRequestQueue()

addToRequestQueue

public <T> void addToRequestQueue(com.android.volley.Request<T> req)

getRequestQueue

protected static com.android.volley.RequestQueue getRequestQueue(java.lang.String protocol)

addToRequestQueue

protected static <T> void addToRequestQueue(java.lang.String protocol,
                                            com.android.volley.Request<T> req,
                                            java.lang.String tag)

isNetworkAvailable

protected static void isNetworkAvailable(android.content.Context context)

To check network availability.