Public Method Author API

getActivityDescription()

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".

Examples

var activityDescription = authorApp.getActivityDescription();
console.log(activityDescription);

Arguments

None.

Return value

  • string

    Returns the description from the current Activity.

  • boolean

    Returns false if not in the Activity editor view.

Related articles

Was this article helpful?