Public Method Author API

getActivityReference()

Returns the current reference of the Activity being edited.

You would want to use this method so that you can show the Activity reference 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 activityReference = authorApp.getActivityReference();
console.log(activityReference);

Arguments

None.

Return value

  • string

    Returns the current reference of the Activity being edited.

  • boolean

    Returns false if not in the Activity editor view.

Was this article helpful?