Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • ContentItem

Index

Constructors

Properties

Methods

Constructors

constructor

  • new ContentItem(connection: ClientConnection): ContentItem
  • Content Item - Used for retrieving Content Items.

    Parameters

    • connection: ClientConnection

      message-event-channel connection

    Returns ContentItem

Properties

Private connection

connection: ClientConnection

message-event-channel connection

Methods

getCurrent

  • type

    ContentItemBody defines the shape of the data that is expected to be returned in the Content Item body

    Use to fetch the Content Item that is currently being edited. Returns a promise which will resolve to a ContentItemModel

    Example

    try {
      const contentItem = await sdk.contentItem.getCurrent();
    
      console.log(contentItem)
    } catch (e) {
      // In a context where contentItem doesn't exist yet
    }
    

    Type parameters

    • ContentItemBody

    Returns Promise<ContentItemModel<ContentItemBody>>

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