elementActions.handlers.supportedObjects object

The supported object types that can trigger this Action.

Properties that reference this object type:

• root.actions.handlers.supportedObjects

Syntax

Syntax

{
  "file": {
    "extensions": [
      "{string}"
    ]
  },
  "folder": object | null
}

Schema

{
  "type": "object",
  "properties": {
    "file": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "extensions": {
          "type": "array",
          "items": {
            "type": "string",
            "description": "File extension, e.g. .pdf, .docx."
          }
        }
      }
    },
    "folder": {
      "type": [
        "object",
        "null"
      ],
      "description": "A null value indicates that the file handler is not available when a folder is selected. An object with no parameters indicates that the file handler is available when a folder is selected or when no files are selected."
    }
  }
}

Properties

file

Supported file types.

Type
file

Required
—

Constraints

Supported values

folder

A null value indicates that the file handler is not available when a folder is selected. An object with no parameters indicates that the file handler is available when a folder is selected or when no files are selected.

Type
object | null

Required
—

Constraints

Supported values

Examples

{
"actions": [
    {
      "handlers": [
        {
          "supportedObjects": {
            "file": {
              "extensions": [
                "doc",
                "pdf"
              ]
            }
          }
        }
      ]
    },
  ]
}