Author API Initialization

Configuration for Tag filters which are applied by default to the search criteria for the Activity list results.

Values

Attribute path config.activity_list.filter.restricted.tags

Type object

Properties

• allow_filtered_tags_overwrite boolean

  Controls whether the author can save Activities which do not meet the specified tags filters. By default, authors cannot save Activities which do not match the specified Tag filters.

  You would want to use this to allow authors to save any Activity regardless of filtered Tags.

  Default: false

  // Allow authors to save any Activity regardless of Tag filters
              var initializationOptions = {
                  "config": {
                      "activity_list": {
                          "filter": {
                              "restricted": {
                                  "tags": {
                                      "allow_filtered_tags_overwrite": true
                                  }
                              }
                          }
                      }
                  }
              };
              

• all array[TagsV2]

  Show Activities that contain all of the specified Tags.

  You would want to use this to show Activities with a particular combination of Tags.

  See Understanding Tag Formats for Content Creation and Filtering for more information on the TagsV2 format.

  Default: []

  // Show Activities that contain all four Tags listed
              var initializationOptions = {
                  "config": {
                      "activity_list": {
                          "filter": {
                              "restricted": {
                                  "tags": {
                                      "all": [
                                          { "type": "TYPE1", "name": "NAME1" },
                                          { "type": "TYPE1", "name": "NAME2" },
                                          { "type": "TYPE2", "name": "NAME3" },
                                          { "type": "TYPE2", "name": "NAME4" }
                                      ]
                                  }
                              }
                          }
                      }
                  }
              };
              

• either array[TagsV2]

  Show Activities that contain at least one of the specified Tags.

  You would want to use this to show Activities with a particular combination of Tags.

  See Understanding Tag Formats for Content Creation and Filtering for more information on the TagsV2 format.

  Default: []

  var initializationOptions = {
                  "config": {
                      "activity_list": {
                          "filter": {
                              "restricted": {
                                  "tags": {
                                      "either": [
                                          { "type": "TYPE1", "name": "NAME1" },
                                          { "type": "TYPE1", "name": "NAME2" },
                                          { "type": "TYPE2", "name": "NAME3" }
                                      ]
                                  }
                              }
                          }
                      }
                  }
              };
              

• none array[TagsV2]

  Show Activities which do not contain any of the listed Tags.

  You would want to use this to exclude Activities with particular Tags.

  Important This initialization option requires either tags.all or tags.either to also be set. The tags.none initialization option cannot be set on its own.

  See Understanding Tag Formats for Content Creation and Filtering for more information on the TagsV2 format.

  Default: []

  var initializationOptions = {
                  "config": {
                      "activity_list": {
                          "filter": {
                              "restricted": {
                                  "tags": {
                                      "all": [
                                          { "type": "TYPE1", "name": "NAME1" }
                                      ],
                                      "none": [
                                          { "type": "TYPE2", "name": "NAME3" },
                                          { "type": "TYPE2", "name": "NAME4" }
                                      ]
                                  }
                              }
                          }
                      }
                  }
              };
              

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.