setItemDescription()
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.
Examples
var hasUpdatedDescription = authorApp.setItemDescription("My new description for the Item.");
console.log(hasUpdatedDescription);
Arguments
-
description stringThe 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
- The
getItemDescription()
method, which allows you to get the Item description.