extensionRuntimesActionsItem object

Specifies the set of actions supported by this runtime. An action is either running a JavaScript function or opening a view such as a task pane.

Properties that reference this object type:

• root.extensions.runtimes.actions

Syntax

Syntax

{
  "id": "{string}",
  "type": "executeFunction | openPage",
  "displayName": "{string}",
  "pinnable": {boolean},
  "view": "{string}",
  "multiselect": {boolean},
  "supportsNoItemContext": {boolean}
}

Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Identifier for this action. Maximum length is 64 characters. This value is passed to the code file.",
      "maxLength": 64
    },
    "type": {
      "type": "string",
      "enum": [
        "executeFunction",
        "openPage"
      ],
      "description": "executeFunction: Run a script function without waiting for it to finish. openPate: Open a page in a view."
    },
    "displayName": {
      "type": "string",
      "description": "Display name of the action. Maximum length is 64 characters.",
      "maxLength": 64
    },
    "pinnable": {
      "type": "boolean",
      "description": "Specifies that a task pane supports pinning, which keeps the task pane open when the user changes the selection."
    },
    "view": {
      "type": "string",
      "description": "View where the page should be opened. Maximum length is 64 characters.  ",
      "maxLength": 64
    },
    "multiselect": {
      "type": "boolean",
      "description": "Whether allows the action to have multiple selection.",
      "default": false
    },
    "supportsNoItemContext": {
      "type": "boolean",
      "description": "Whether allows task pane add-ins to activate without the Reading Pane enabled or a message selected. ",
      "default": false
    }
  },
  "additionalProperties": false,
  "required": [
    "id",
    "type"
  ]
}

Properties

id

Specifies the ID for the action, which is passed to the code file.

Type
string

Required
✅

Constraints
Maximum string length: 64.

Supported values

type

Specifies the type of action. The executeFunction type runs a JavaScript function without waiting for it to finish and the openPage type opens a page in a given view.

Type
string

Required
✅

Constraints

Supported values
Allowed values: executeFunction, openPage.

displayName

Specifies the display name of the action and it isn't the label of a button or a menu item that invokes the action (which is configured with tabs.groups.controls.label).

Type
string

Required
—

Constraints
Maximum string length: 64.

Supported values

pinnable

Specifies that a task pane supports pinning, which keeps the task pane open when the user changes the selection.

Type
boolean

Required
—

Constraints

Supported values

view

Specifies the view where the page must be opened. It's used only when actions.type is openPage.

Type
string

Required
—

Constraints
Maximum string length: 64.

Supported values

multiselect

Specifies whether the end user can select multiple items, such as multiple email messages, and apply the action to all of them.

Type
boolean

Required
—

Constraints

Supported values
Default value: False.

supportsNoItemContext

Allows task pane add-ins to activate without the reading pane enabled or a message selected.

Type
boolean

Required
—

Constraints

Supported values
Default value: False.

Examples

{
    "extensions": [
        {
          "runtimes": [
            {
              "actions": [
                {
                  "id": "action1",
                  "type": "executeFunction"
                },
                {
                  "id": "action2",
                  "type": "executeFunction"
                },
                {
                  "id": "action3",
                  "type": "executeFunction"
                }
              ]
            }
          ],
        }
    ]
}