Public Method Author API

setActivityDescription()

Sets the description of the Activity being edited.

You would want to use this method so that you can programatically set a default value for the description in all Activities, for example.

Examples

var hasUpdatedActivityDescription = authorApp.setActivityDescription("My activity description.");
console.log(hasUpdatedActivityDescription);

Arguments

  • description string

    The description for the Activity.

Return value

boolean

Returns true if successful.

Returns false if unable to set the Activity description. For example, when not in the Activity editor view or the passed value is not valid.

Related articles

Was this article helpful?