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.
Initialization Option Assess API

idle_timeout

When enabled, a dialog box 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 session.

Failing to close the dialog in time, the current progress will be saved and the session will be discarded.

Note The default inactivity interval is 300 seconds and the default dialog count down time is 60 seconds.

Values

Request object key configuration.idle_timeout

Default: false

This option can be initialized as one of the following types: boolean object.

  • Type boolean

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

  • Type object
    • countdown_time number
      The dialog count down time in seconds before the session will be saved and discarded.
    • interval number
      The inactivity time period in seconds.
Was this article helpful?