Public Method Author API

setItemNotes()

Sets the notes of the Item being edited. The notes attribute can be used to provide notes to other authors on the Item's content when Items are being created and reviewed between multiple authors.

You would want to use this method so that you can set a default note for authors, signalling that the Item is newly created, for example.

Examples

authorApp.setItemNotes("My notes for the Item.");

Arguments

  • notes string
    The notes content for the Item.

Return value

boolean

Returns true if successful.

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