This is a lower-level API. Lower-level APIs are not recommended for most projects, and may not be available on all plans. See our page on recommended deployment patterns for more information.
Public Method Assess API


Allows access to a list of dialogs available in the player.



Return value

Value object

A list of modal dialogs used in the Assess player. Methods on each DialogObject can be used to show or hide the corresponding modal dialog.

Allows selection of an accessible color scheme, adjustment of font size, and provides instructions on how to adjust zoom.
Displays an error when there has been an issue uploading a media asset as a response.
Also known as the Administration Panel, this dialog allows an administrator to save and quit a session; exit and discard a session; and extend session time.

See administration panel knowledge base article for more information.

Custom dialogs can be used to display messages to users during their assessment.

See custom dialogs knowledge base article for more information.

Displays messages for errors that may occur during a session.
When enabled, this dialog will be shown after a number of seconds of inactivity. Once shown, the user has limited time to close the dialog to continue with the Activity. Failing to close the dialog in time, the current progress will be saved and the Activity will be discarded.

See idle_timeout configuration for more information.

At smaller widths, such as on phone screens, this dialog represents the "hamburger" style menu and contains the various navigation elements that have been configured.

See navigation configuration for more information.

Displays an error when parts of the Learnosity app have failed to load due to connectivity issues, and provides an option for the user to reload the page to try again.
Displays a message when the Activity is paused and allows the user to resume an Activity / unpause.
The review screen that is usually presented at the of an Activity. Allows filtered display of unattempted, partially attempted, and/or flagged items; and navigation to these items. Also allows save and submit of an Activity.

Type definitions

DialogObject object

An object containing public methods for an instance of a dialog in the player.
  • hide function
    Hides the dialog.
  • show function
    Shows the dialog.
Was this article helpful?