Public Method Author API

setActivityStatus()

Sets the status of the Activity being edited.

You would want to use this method so that you can programatically set the default Activity status for all Activities, for example.

Examples

var status = authorApp.setActivityStatus('published');

Arguments

  • status string

    The new status for the Activity.

    Possible values:
    • "published"
    • "unpublished"
    • "archived"

Return value

  • string

    Returns the status string when successful.

  • boolean

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

Related articles