Options
All
  • Public
  • Public/Protected
  • All
Menu

Type parameters

Hierarchy

  • SDK

Index

Constructors

constructor

  • The SDK instance is the central place for all SDK methods. It takes an optional options object.

    Parameters

    Returns SDK

Properties

connection

connection: ClientConnection

message-event-channel [[ClientConnection]] instance. Use to listen to any of the message-event-channel lifecycle events.

contentItem

contentItem: ContentItem

Content Item - The model of the Content Item that is being edited.

contentLink

contentLink: ContentLink

Content Link - Use to open a content browser.

contentReference

contentReference: ContentReference

Content Reference - Use to open a content browser.

field

field: Field<FieldType, ParamType>

Field - Allows you to get and set the value of the field the extension is control of.

form

form: Form

Form - controls over the form such as readonly change handlers.

frame

frame: Frame

Frame - Use to control the height sizing behaviour of your extension.

locales

locales: LocalesModel

Locales - The locales you currently have available.

mediaLink

mediaLink: MediaLink

Media Link - Use to open a media browser.

Protected options

options: Options

params

params: ParamType

Params - optional paramaters for your extension.

stagingEnvironment

stagingEnvironment: string

stagingEnvironment - Used for accessing staged assets.

visualisation

visualisation: string

Visualisation - URL of the visualisation

Methods

init

  • init(): Promise<SDK<FieldType, ParamType>>
  • Initialiser. Returns a promise that resolves to an instance of the SDK.

    Returns Promise<SDK<FieldType, ParamType>>

Private requestContext

Private setupContext

  • setupContext(): Promise<void>

Object literals

Protected defaultOptions

defaultOptions: object

connectionTimeout

connectionTimeout: false = false

debug

debug: false = false

timeout

timeout: false = false

window

window: Window = window

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc