Public Method Author API


Sets the description of the Item being edited.

You would want to use this method so that you can programatically set a default value for the description in all Items, for example.


var hasUpdatedDescription = authorApp.setItemDescription("My new description for the Item.");


  • description string
    The description content of the Item.

Return value

  • string

    Returns the description content if successful.

  • boolean

    Returns false if unable to set the Item description. For example, when not in the Item editor view.

Related articles

Was this article helpful?