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.
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"
]
}
{
"type": "object",
"description": "Specifies limitations on which clients the add-in can be installed on, including limitations on the Office host application, the form factors, and the requirement sets that the client must support.",
"minProperties": 1,
"properties": {
"capabilities": {
"type": "array",
"minItems": 1,
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Identifies the name of the requirement sets that the add-in needs to run.",
"maxLength": 128
},
"minVersion": {
"type": "string",
"description": "Identifies the minimum version for the requirement sets that the add-in needs to run."
},
"maxVersion": {
"type": "string",
"description": "Identifies the maximum version for the requirement sets that the add-in needs to run."
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"scopes": {
"type": "array",
"description": "Identifies the scopes in which the add-in can run. For example, mail means Outlook.",
"maxItems": 4,
"items": {
"type": "string",
"enum": [
"mail",
"workbook",
"document",
"presentation"
]
}
},
"formFactors": {
"type": "array",
"description": "Identifies the form factors that support the add-in. Supported values: mobile, desktop.",
"minItems": 1,
"maxItems": 2,
"items": {
"type": "string",
"enum": [
"desktop",
"mobile"
]
}
}
},
"additionalProperties": false
}
{
"capabilities": [
{
"name": "{string}",
"minVersion": "{string}",
"maxVersion": "{string}"
}
],
"scopes": [
"mail | workbook | document | presentation"
],
"formFactors": [
"desktop | mobile"
]
}
{
"type": "object",
"minProperties": 1,
"properties": {
"capabilities": {
"type": "array",
"minItems": 1,
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Identifies the name of the requirement sets that the add-in needs to run.",
"maxLength": 128
},
"minVersion": {
"type": "string",
"description": "Identifies the minimum version for the requirement sets that the add-in needs to run."
},
"maxVersion": {
"type": "string",
"description": "Identifies the maximum version for the requirement sets that the add-in needs to run."
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"scopes": {
"type": "array",
"description": "Identifies the scopes in which the add-in can run.",
"minItems": 1,
"maxItems": 4,
"items": {
"type": "string",
"enum": [
"mail",
"workbook",
"document",
"presentation"
]
}
},
"formFactors": {
"type": "array",
"description": "Identifies the form factors that support the add-in. Supported values: mobile, desktop.",
"minItems": 1,
"maxItems": 2,
"items": {
"type": "string",
"enum": [
"desktop",
"mobile"
]
}
}
},
"additionalProperties": false
}
Properties
capabilities
Identifies the requirement sets.
Constraints
Minimum array items: 1. Maximum array items: 100.
scopes
Identifies the scopes in which the add-in can run and defines the Microsoft 365 applications in which the extension can run.
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.
Constraints
Minimum array items: 1. Maximum array items: 4.
Supported values
Allowed values: mail, workbook, document, presentation.
Identifies the form factors that support the add-in.
Constraints
Minimum array items: 1. Maximum array items: 2.
Supported values
Allowed values: desktop, mobile.