Items API Initialization

Specifies whether a dialog will be shown to the learner after a period of inactivity. Once shown, the learner has limited (configurable) time to close the dialog and continue with the session.

You would want to specify this option so that you can automatically close sessions where the learner has become inactive, for example.

If the learner fails to respond to the dialog in time, the current progress will be automatically saved and the session will be exited.

Note This functionality only applies when the type initialization option is set to "submit_practice".

Examples

// Enable the idle detection with defaults
var initializationOptions = {
    "config": {
        "configuration": {
            "idle_timeout": true
        }
    }
};

// Custom idle detection options
var initializationOptions = {
    "config": {
        "configuration": {
            "idle_timeout": {
                "countdown_time": 30,
                "interval": 60
            }
        }
    }
};

Values

Attribute path config.configuration.idle_timeout

Default false

• Type boolean

  Set to true to enable the idle timeout feature with the default timing values.

• Type object

  • countdown_time integer

    The dialog countdown time in seconds before the session will be saved and exited.

    Default: 300 seconds

  • interval integer

    The inactivity time period in seconds.

    Default: 60 seconds

Related articles

• The dialogs() method, the method used to show and hide the idle timeout dialog. See the idleTimeout property.