Initialization Option Author API

auto_save

Configuration options for the "auto save at intervals of n seconds" functionality.

Values

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

Type object

This object has the following properties which can be configured.

  • show boolean

    Controls whether the "auto save at intervals of n seconds" 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": {
                        "auto_save": {
                            "show": false
                        }
                    }
                }
            }
        }
    };
  • edit boolean

    Controls whether the "auto save at intervals of n seconds" 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": {
                        "auto_save": {
                            "edit": false
                        }
                    }
                }
            }
        }
    };
  • ui object

    Configuration options for the "enable a visual indicator" functionality.

    • show boolean

      Controls whether the "enable a visual indicator" 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": {
                          "auto_save": {
                              "ui": {
                                  "show": false
                              }
                          }
                      }
                  }
              }
          }
      };
    • edit boolean

      Controls whether the "enable a visual indicator" 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": {
                          "auto_save": {
                              "ui": {
                                  "edit": false
                              }
                          }
                      }
                  }
              }
          }
      };
Was this article helpful?