Share via

requirementsExtensionElement object

  • Article

The extensions.requirements object specifies the scopes, form factors, and Office JavaScript library requirement sets that must be supported on the Office client in order for the add-in to be installed. Requirements are also supported on the ribbon, runtime, alternates, and autoRunEvents child properties to selectively filter out some features of the add-in. For more information, see Specify Office Add-in requirements in the unified manifest for Microsoft 365.

Syntax

{
  "capabilities": [
    {
      "name": "{string}",
      "minVersion": "{string}",
      "maxVersion": "{string}"
    }
  ],
  "scopes": [
    "mail | workbook | document | presentation"
  ],
  "formFactors": [
    "desktop | mobile"
  ]
}

{
  "capabilities": [
    {
      "name": "{string}",
      "minVersion": "{string}",
      "maxVersion": "{string}"
    }
  ],
  "scopes": [
    "mail | workbook | document | presentation"
  ],
  "formFactors": [
    "desktop | mobile"
  ]
}

Properties

capabilities

Identifies the requirement sets.

Type
Array of capabilities

Required
—

Constraints
Minimum array items: 1. Maximum array items: 100.

Supported values

scopes

Identifies the scopes in which the add-in can run and defines the Microsoft 365 applications in which the extension can run.

Type
Array of string

Required
—

Constraints
Maximum array items: 4.

Supported values
Allowed values: mail, workbook, document, presentation.

scopes

Identifies the scopes in which the add-in can run and defines the Microsoft 365 applications in which the extension can run.

Type
Array of string

Required
—

Constraints
Minimum array items: 1. Maximum array items: 4.

Supported values
Allowed values: mail, workbook, document, presentation.

formFactors

Identifies the form factors that support the add-in.

Type
Array of string

Required
—

Constraints
Minimum array items: 1. Maximum array items: 2.

Supported values
Allowed values: desktop, mobile.