config.global.items.read_only.filter - Initialization - Author API

Author API Initialization

filter

Configuration options for working with read-only Items.

Values

Attribute path config.global.items.read_only.filter

Type object

Properties

  • either array[TagsV2]

    Controls whether Items containing any of the specified Tags will be shown as read-only.

    You would want to use this to specify tagged groups of Items to be read-only.

    Default: []

    var initializationOptions = {
                    "config": {
                        "global": {
                            "items": {
                                "read_only": {
                                    "filter": {
                                        "either": [
                                            { "type": "TYPE1", "name": "NAME1" },
                                            { "type": "TYPE2", "name": "NAME2" },
                                            // ...
                                        ]
                                    }
                                }
                            }
                        }
                    }
                };
                
  • duplicate boolean

    Controls whether filtered read-only Items can be duplicated. The duplicated Item can be edited by authors.

    You would want to use this to allow authors to make new copies of read-only Items.

    Default: false

    var initializationOptions = {
                    "config": {
                        "global": {
                            "items": {
                                "read_only": {
                                    "filter": {
                                        "duplicate": true
                                    }
                                }
                            }
                        }
                    }
                };
                

Type definitions

  • tagsV2 object

    Tags are used to improve searching for content while authoring and for reporting and analytics purposes.

    See Understanding Tag Formats for Content Creation and Filtering for more information.

    • name string

      The Tag name.

      Maximum length is 255 characters.

    • type string

      The Tag type.

      Maximum length is 255 characters.

Was this article helpful?

Did you arrive here by accident? If so, learn more about Learnosity.