Skip to content

Commit 22c85c1

Browse files
[All Hosts] (devx) clarify feature filtering on older versions (#5127)
* [All Hosts] (devx) clarify feature filtering on older versions * clarify * typo * add section for contentRuntimes * fix * replace pronoun * Apply suggestions from code review Co-authored-by: Elizabeth Samuel <[email protected]> --------- Co-authored-by: Elizabeth Samuel <[email protected]>
1 parent bb8919c commit 22c85c1

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

docs/develop/requirements-property-unified-manifest.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Specify Office Add-in requirements in the unified manifest for Microsoft 365
33
description: Learn how to use requirements to configure on which host and platforms an add-in can be installed and which features are available.
4-
ms.date: 02/12/2025
4+
ms.date: 04/18/2025
55
ms.topic: how-to
66
ms.localizationpriority: medium
77
---
@@ -53,6 +53,13 @@ The "requirements" properties in descendant objects of "extensions" are used to
5353
> [!TIP]
5454
> Don't include a capability, formFactor, or scope requirement in a descendant object of "extensions" that's *less* restrictive than the corresponding capability, formFactor, or scope requirement in the ancestor "extensions.requirements" property, if there is one. Since the add-in can't be installed on clients that don't meet the ancestor requirement, no feature filtering would occur anyway. For example, if an "extensions.requirements.capabilities" property requires **Mailbox 1.10**, there's no point in requiring **Mailbox 1.9** in any descendant objects.
5555
56+
> [!NOTE]
57+
> Office Add-ins that use the unified manifest for Microsoft 365 are *directly* supported in Office on the web, in [new Outlook on Windows](https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627), and in Office on Windows connected to a Microsoft 365 subscription, Version 2304 (Build 16320.00000) or later.
58+
>
59+
> When the app package that contains the unified manifest is deployed in [AppSource](https://appsource.microsoft.com/) or the [Microsoft 365 Admin Center](/office/dev/add-ins/publish/publish) then an add-in only manifest is generated from the unified manifest and stored. This add-in only manifest enables the add-in to be installed on platforms that don't directly support the unified manifest, including Office on Mac, Office on mobile, subscription versions of Office on Windows earlier than 2304 (Build 16320.00000), and perpetual versions of Office on Windows.
60+
>
61+
> Feature filtering is less fine-grained in the add-in only manifest. As a result, on platforms that don't directly support the unified manifest, adding a "requirements" subproperty to *any* child of "extensions" is effectively the same as adding that same "requirements" subproperty to *all* the children of "extensions" with one possible exception. So, on these platforms *none* of the features that are configured in these child properties of "extensions" will be available on platform and version combinations that don't meet the specified requirements. The exception is the "extensions.alternates" property. If this property is present, the alternates feature will be filtered in or out based only on its own "requirements" subproperty (if any), not on the "requirements" subproperties of any other child properties of "extensions".
62+
5663
### extensions.alternates.requirements
5764

5865
The "extensions.alternates" property enables add-in developers to do the following:
@@ -61,14 +68,9 @@ The "extensions.alternates" property enables add-in developers to do the followi
6168
- Either hide or give preference to the version that uses the older technology.
6269
- Specify icons that are needed to make the unified manifest version of the add-in installable on Office versions that don't directly support the unified manifest.
6370

64-
> [!NOTE]
65-
> Office Add-ins that use the unified manifest for Microsoft 365 are *directly* supported in Office on the web, in [new Outlook on Windows](https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627), and in Office on Windows connected to a Microsoft 365 subscription, Version 2304 (Build 16320.00000) or later.
66-
>
67-
> When the app package that contains the unified manifest is deployed in [AppSource](https://appsource.microsoft.com/) or the [Microsoft 365 Admin Center](/office/dev/add-ins/publish/publish) then an add-in only manifest is generated from the unified manifest and stored. This add-in only manifest enables the add-in to be installed on platforms that don't directly support the unified manifest, including Office on Mac, Office on mobile, subscription versions of Office on Windows earlier than 2304 (Build 16320.00000), and perpetual versions of Office on Windows.
68-
6971
For more information, see [Manage both a unified manifest and an add-in only manifest version of your Office Add-in](/office/dev/add-ins/concepts/duplicate-legacy-metaos-add-ins).
7072

71-
The "requirements" subproperty of "extensions.alternates" to selectively apply the "hide" or "prefer" subproperties only when certain requirements are met.
73+
Use the "requirements" subproperty of "extensions.alternates" to selectively apply the "hide" or "prefer" subproperties only when certain requirements are met.
7274

7375
For example, suppose that you want to hide (from the Office UI for installing add-ins) an older version of your add-in, but only in Office versions that support the **Mailbox 1.10** requirement set. You could do that with markup similar to the following:
7476

@@ -137,6 +139,10 @@ For example, suppose an Outlook add-in is configured to autolaunch in response t
137139
]
138140
```
139141

142+
### extensions.contentRuntimes.requirements
143+
144+
The "extensions.contentRuntimes" property can't be combined with any other child property of "extensions" (except "extensions.requirements"). This means that the content is the *only* feature of the add-in, so it makes no sense to filter out the feature's availability on some combinations of platform and Office version while allowing add-in to be installable on those same combinations. Accordingly, don't use the "requirements" property in "contentRuntimes". To control the installability of the content add-in, use the "extensions.requirements" property of the parent "extensions".
145+
140146
### extensions.contextMenus.requirements
141147

142148
The "extensions.contextMenus" property configures the add-in's context menus. A context menu is a shortcut menu that appears when you right-click (or select and hold) in the Office UI. The "requirements" subproperty can be used to allow context menus only when certain requirements are met.

0 commit comments

Comments
 (0)