getActivityDescription - Methods - Author API

Author API Methods


Returns the description from the current Activity being edited.

You would want to use this method so that you can show the Activity description 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".


var activityDescription = authorApp.getActivityDescription();



Return value

Type string

Returns the description from the current Activity.

Type boolean

Returns false if not in the Activity editor view.

Related articles

Was this article helpful?

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