Author API Initialization

Configuration options for reading mode related options.

Values

Attribute path config.activity_edit.player.time.reading_mode

Type object

Properties

• goto_first_item_on_reading_time_completion object

  Configuration options for the "go to first item on reading time completion" functionality.

  • show boolean

    Controls whether the "go to first item on reading time completion" 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": {
                                                            "reading_mode": {
                                                                "goto_first_item_on_reading_time_completion": {
                                                                    "show": false
                                                                }
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        };
                                        

  • edit boolean

    Controls whether the "go to first item on reading time completion" 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": {
                                                            "reading_mode": {
                                                                "goto_first_item_on_reading_time_completion": {
                                                                    "edit": false
                                                                }
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        };
                                        

• warning_time object

  Configuration options for the "warn when approaching end of reading time" functionality.

  • show boolean

    Controls whether the "warn when approaching end of reading time" 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": {
                                                            "reading_mode": {
                                                                "warning_time": {
                                                                    "show": false
                                                                }
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        };
                                        

  • edit boolean

    Controls whether the "warn when approaching end of reading time" 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": {
                                                            "reading_mode": {
                                                                "warning_time": {
                                                                    "edit": false
                                                                }
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        };