Initialization Option Author API

comments

Configuration options for Item review workflow comments.

Values

Request object key config.global.workflow.item.comments

Type object

This object has the following properties which can be configured.

  • show boolean

    Controls whether Item review workflow comments are shown.

    You would want to use this to hide workflow comments on Items.

    Default: true

    // Hide Item workflow comments
    var initializationOptions = {
        "config": {
            "global": {
                "workflow": {
                    "item": {
                        "comments": {
                            "show": false
                        }
                    }
                }
            }
        }
    };
  • add boolean

    Controls whether Item review workflow comments can be added.

    You would want to use this to prevent authors from adding workflow comments.

    Default: true

    // Disable workflow comments
    var initializationOptions = {
        "config": {
            "global": {
                "workflow": {
                    "item": {
                        "comments": {
                            "add": false
                        }
                    }
                }
            }
        }
    };
Was this article helpful?