dialogs - Methods - Assess API

Assess API Methods


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



Return value

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

  • accessibility DialogObject

    Allows selection of an accessible color scheme, adjustment of font size, and provides instructions on how to adjust zoom.

  • assetUploadError DialogObject

    Displays an error when there has been an issue uploading a media asset as a response.

  • configuration DialogObject

    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.

  • custom DialogObject

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

  • error DialogObject

    Displays messages for errors that may occur during a session.

  • idleTimeout DialogObject

    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.

  • menu DialogObject

    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.

  • moduleLoadError DialogObject

    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.

  • pause DialogObject

    Displays a message when the Activity is paused and allows the user to resume an Activity / unpause.

  • reviewScreen DialogObject

    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?

Did you arrive here by accident? If so, learn more about Learnosity.