requirementsExtensionElement object

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 child properties of extensions objects to selectively filter out some features of the add-in.

Important

Configuring requirements can be error prone. We strongly recommend that you familiarize yourself with Specify Office Add-in requirements in the unified manifest for Microsoft 365 and Understand the logic of API requirement configuration.

Properties that reference this object type:

Properties that reference this object type:

Properties that reference this object type:

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"
  ]
}

{
  "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.

Important

Configuring requirements can be error prone. We strongly recommend that you familiarize yourself with Specify Office Add-in requirements in the unified manifest for Microsoft 365 and Understand the logic of API requirement configuration.

Type
Array of capabilities

Required
—

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

Supported values

scopes

Identifies the Microsoft 365 applications in which the extension can run, or in which the feature is accessible. This property should be used only to restrict the add-in or feature to a proper subset of the possible applications; document (Word), mail (Outlook), presentation (PowerPoint), and workbook(Excel). Including all the possible values in the array has the same effect as having no scopes property at all: the add-in will be installable (or the feature will be accessible) on all Office applications.

Important

Configuring requirements can be error prone. We strongly recommend that you familiarize yourself with Specify Office Add-in requirements in the unified manifest for Microsoft 365 and Understand the logic of API requirement configuration.

Type
Array of string

Required
—

Constraints
Maximum array items: 4.

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

scopes

Identifies the Microsoft 365 applications in which the extension can run, or in which the feature is accessible. This property should be used only to restrict the add-in or feature to a proper subset of the possible applications; document (Word), mail (Outlook), presentation (PowerPoint), and workbook(Excel). Including all the possible values in the array has the same effect as having no scopes property at all: the add-in will be installable (or the feature will be accessible) on all Office applications.

Important

Configuring requirements can be error prone. We strongly recommend that you familiarize yourself with Specify Office Add-in requirements in the unified manifest for Microsoft 365 and Understand the logic of API requirement configuration.

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.

Important

Configuring requirements can be error prone. We strongly recommend that you familiarize yourself with Specify Office Add-in requirements in the unified manifest for Microsoft 365 and Understand the logic of API requirement configuration.

Type
Array of string

Required
—

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

Supported values
Allowed values: desktop, mobile.

  • Last updated on