getActivityStatus()
The current workflow state for the Activity, for example, published, unpublished, or archived.
You would want to use this method so that you can show the Activity status in your custom authoring UI, for example.
Important
This method can only be used when in the Activity editor view, when the mode
initialization option is set to "activity_edit"
.
Examples
var activityStatus = authorApp.getActivityStatus();
console.log(activityStatus);
Arguments
None.
Return value
- string
Returns the status of the current Activity which can either:
"published"
,"unpublished"
, or"archived"
.
- boolean
Returns
false
if not in the Activity editor view.
Related articles
- Changing The Activity Status In The Activity Editor
- The
setActivityStatus()
method, which allows you to set the Activity status.