Public Method Author API

getItemDescription()

Gets the current description of the Item being edited.

You would want to use this method so that you can display the Item description in your application, for example.

Important This method can only be used when in the Item editor view, when the mode initialization option is set to "item_edit".

Examples

var itemDescription = authorApp.getItemDescription();
console.log(itemDescription);

Arguments

None.

Return value

  • string

    The description for the current Item.

  • boolean

    Returns false if not in the Item editor view.

Related articles

Was this article helpful?