Stack

Stack

Class representing the current stack in Contentstack UI.

Classes

Asset
ContentType

Methods

getContentType(uid, params) → {Object}

Source:
This API allows you to retrieve data of a content type of a stack using the Content Type API requests. This method returns a Promise object.
Parameters:
Name Type Description
uid string Uid of the desired content type
params Object Optional parameters for the GET call
Returns:
A promise object which will be resolved with content type details.
Type
Object

getContentTypes(query, params) → {Object}

Source:
This API allows you to retrieve data of a content types of a stack using the Content Types API requests. This method returns a Promise object.
Parameters:
Name Type Description
query Object Query for the GET call
params Object Optional parameters for the GET call
Returns:
A promise object which will be resolved with details of the content type.
Type
Object

getData() → {Object}

Source:
This method returns the data of the current stack.
Returns:
Returns stack data.
Type
Object

getEnvironment(name, params) → {Object}

Source:
This API allows you to retrieve environment details of a stack using the Environment API requests. This method returns a Promise object.
Parameters:
Name Type Description
name string Name of the desired environment
params Object Optional parameters for the GET call
Returns:
A promise object which will be resolved with environment details.
Type
Object

getEnvironments(query, params) → {Object}

Source:
This API allows you to retrieve details of environments of a stack using the Environments API requests. This method returns a Promise object.
Parameters:
Name Type Description
query Object Query for the GET call
params Object Optional parameters for the GET call
Returns:
A Promise object which will be resolved with details of the environments.
Type
Object

getLocale(code, params) → {Object}

Source:
This API allows you to retrive a locale of a stack using the Language API requests. Method returns a Promise object.
Parameters:
Name Type Description
code string Code of the desired locale
params Object Optional parameters for the GET call
Returns:
A promise object which will be resolved with locale details.
Type
Object

getLocales(query, params) → {Object}

Source:
This API allows you to retrive the locales of a stack using the Languages API requests. Method returns a Promise object.
Parameters:
Name Type Description
query Object Query for the GET call
params Object Optional parameters for the GET call
Returns:
A Promise object which will be resolved with details of the locales.
Type
Object