save.success - Events - Author Aide API

Author Aide API Events

save:success

Fires when a save operation has completed successfully in the Author Aide API.

You would want to be notified about this event firing, because you might want to show a success message, update the UI, or perform additional actions after a successful save.

Examples

authorAideApp.on('save:success', function (event) {
    console.log('This code executes when a save operation has completed successfully.');
    console.log('Item reference(s):', event.itemReference);
    console.log('Current path:', event.currentPath);
    console.log('Save mode:', event.mode);
});

Callback arguments

  • itemReference string array[string]

    The reference of the Item that was saved.

    An array of Item references that were saved in bulk operations.

  • currentPath string

    The current path where save was initiated.

  • mode string

    The save mode indicating the type of operation being performed.

    Possible values

    • "generate" Content generation operation
    • "translate" Translation operation
    • "edit" Manual editing operation
    • "bulk" Bulk operation on multiple Items
Was this article helpful?

Did you arrive here by accident? If so, learn more about Learnosity.