Class

Extension

Extension

Class representing an extension from Contentstack App SDK.

Members

# appUID

This value represents the current app's unique ID.

View Source extension.ts, line 27

string

# appUID

This value represents the current app's unique ID.

View Source extension.ts, line 312

# config

The configuration set for an app.

View Source extension.ts, line 43

# currentUser

This object holds details of the current user.

View Source extension.ts, line 35

User

# currentUser

This object holds details of the current user.

View Source extension.ts, line 322

# getConfig

Method used to retrieve the configuration set for an app.

View Source extension.ts, line 249

# getConfig

Method used to retrieve the configuration set for an app.

View Source extension.ts, line 379

# getCurrentLocation

Method used to get the type of currently running UI location of the app.

View Source extension.ts, line 261

# getCurrentLocation

Method used to get the type of currently running UI location of the app.

View Source extension.ts, line 383

# getCurrentRegion

Method used to get the Contentstack Region on which the app is running.

View Source extension.ts, line 267

# getCurrentRegion

Method used to get the Contentstack Region on which the app is running.

View Source extension.ts, line 387

# installationUID

This holds the app's installation ID.

View Source extension.ts, line 31

string

# installationUID

This holds the app's installation ID.

View Source extension.ts, line 317

# location

This holds the information of the currently running location of an App.

View Source extension.ts, line 76

object

# location

This holds the information of the currently running location of an App.

View Source extension.ts, line 375

# locationUID

This value represents the current location's unique ID. One App may contain multiple locations

View Source extension.ts, line 64

string

# locationUID

This value represents the current location's unique ID. One App may contain multiple locations

View Source extension.ts, line 360

# metadata

This holds the instance of the Metadata class used to manage metadata.

View Source extension.ts, line 60

Metadata

# metadata

This holds the instance of the Metadata class used to manage metadata.

View Source extension.ts, line 355

This holds the instance of a helper class used to manage modals in an App.

View Source extension.ts, line 68

Modal
This holds the instance of a helper class used to manage modals in an App.

View Source extension.ts, line 365

# postRobot

This holds the instance of Cross-domain communication library for posting messages between windows.

View Source extension.ts, line 47

# postRobot

This holds the instance of Cross-domain communication library for posting messages between windows.

View Source extension.ts, line 339

# region

The Contentstack Region on which the app is running.

View Source extension.ts, line 72

Region

# region

The Contentstack Region on which the app is running.

View Source extension.ts, line 370

# stack

This holds the stack instance that allows users to read and manipulate a range of objects in a stack.

View Source extension.ts, line 51

Stack

# stack

This holds the stack instance that allows users to read and manipulate a range of objects in a stack.

View Source extension.ts, line 344

# store

Store to persist data for extension. Note: Data is stored in the browser's external:localStorage and will be lost if the external:localStorage is cleared in the browser.

View Source extension.ts, line 56

Store

# store

Store to persist data for extension. Note: Data is stored in the browser's external:localStorage and will be lost if the external:localStorage is cleared in the browser.

View Source extension.ts, line 350

# type

The type of UI Location being rendered.

View Source extension.ts, line 39

Methods

# async static initialize(version) → {Promise.<InitializationData>}

Method used to initialize the App SDK.
Parameters:
Name Type Description
version Version of the app SDK in use.

View Source extension.ts, line 395

Promise.<InitializationData>