Author API Methods

Sets the reference of the Activity being edited.

You would want to use this method so that you can set a common Activity reference from your own database and the Learnosity Item bank, for example.

Examples

var activityReference = authorApp.setActivityReference("my-new-activity-reference");
console.log(activityReference);

Arguments

• activityReference string

  The Activity reference used to identify the Activity.

  Maximum length is 150 characters.

Return value

Type boolean

Returns true if successful.

Returns false if unable to set the Activity reference, for example, when not in the Activity editor view, or the new reference is the same as the current reference.

Versioning

Version added: v2025.1.LTS

Related articles

• The getActivityReference() method, which allows you to get the Activity reference.