setStatus - Methods - Author API

Author API Methods

setStatus()

Set the status of the Item being edited.

You would want to use this method so that you can set the Item status with custom elements in your application, for example.

Examples

var updatedStatus = authorApp.setStatus("published");
console.log(updatedStatus);

Arguments

  • status string

    The Item status.

Return value

Type string

Returns the new Item status if successful.

Type boolean

Returns false if unable to set the Item status, for example, when not in the Item editor view, the passed status is not valid, or is the same as the current status.

Related articles

  • The getStatus() method, which allows you to get the Activity status.
Was this article helpful?

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