Initialization Option Author API

idle_timeout

Configuration options for the "trigger inactivity timeout warning" functionality.

Values

Request object key config.activity_edit.player.time.idle_timeout

Type object

This object has the following properties which can be configured.

  • show boolean

    Controls whether the "trigger inactivity timeout warning" option is shown.

    You would want to use this to hide the option in the assessment player settings.

    Default: true

    var initializationOptions = {
        "config": {
            "activity_edit": {
                "player": {
                    "time": {
                        "idle_timeout": {
                            "show": false
                        }
                    }
                }
            }
        }
    };
  • edit boolean

    Controls whether the "trigger inactivity timeout warning" option can be changed.

    You would want to use this so that you can prevent authors from changing the option in the assessment player settings. The option will be shown but cannot be changed.

    Default: true

    var initializationOptions = {
        "config": {
            "activity_edit": {
                "player": {
                    "time": {
                        "idle_timeout": {
                            "edit": false
                        }
                    }
                }
            }
        }
    };
  • countdown_time object

    Configuration options for the "allow student to dismiss timeout warning" functionality.

    • show boolean

      Controls whether the "allow student to dismiss timeout warning" option is shown.

      You would want to use this to hide the option in the assessment player settings.

      Default: true

      var initializationOptions = {
          "config": {
              "activity_edit": {
                  "player": {
                      "time": {
                          "idle_timeout": {
                              "countdown_time": {
                                  "show": false
                              }
                          }
                      }
                  }
              }
          }
      };
    • edit boolean

      Controls whether the "allow student to dismiss timeout warning" option can be changed.

      You would want to use this so that you can prevent authors from changing the option in the assessment player settings. The option will be shown but cannot be changed.

      Default: true

      var initializationOptions = {
          "config": {
              "activity_edit": {
                  "player": {
                      "time": {
                          "idle_timeout": {
                              "countdown_time": {
                                  "edit": false
                              }
                          }
                      }
                  }
              }
          }
      };
Was this article helpful?