extensionAlternateVersionsArray object

The extensions.alternates property is used to hide or prioritize specific in-market add-ins when you've published multiple add-ins with overlapping functionality.

Properties that reference this object type:

Syntax

{
  "requirements": {
    "capabilities": [
      {
        capabilities object
      }
    ],
    "scopes": [
      "mail | workbook | document | presentation"
    ],
    "formFactors": [
      "desktop | mobile"
    ]
  },
  "prefer": {
    "comAddin": {
      comAddin object
    },
    "xllCustomFunctions": {
      extensionXllCustomFunctions object
    }
  },
  "hide": {
    "storeOfficeAddin": {
      storeOfficeAddin object
    },
    "customOfficeAddin": {
      customOfficeAddin object
    },
    "windowsExtensions": {
      windowsExtensions object
    }
  },
  "alternateIcons": {
    "icon": {
      extensionCommonIcon object
    },
    "highResolutionIcon": {
      extensionCommonIcon object
    }
  }
}

{
  "requirements": {
    "capabilities": [
      {
        capabilities object
      }
    ],
    "scopes": [
      "mail | workbook | document | presentation"
    ],
    "formFactors": [
      "desktop | mobile"
    ]
  },
  "prefer": {
    "comAddin": {
      comAddin object
    },
    "xllCustomFunctions": {
      extensionXllCustomFunctions object
    }
  },
  "hide": {
    "storeOfficeAddin": {
      storeOfficeAddin object
    },
    "customOfficeAddin": {
      customOfficeAddin object
    },
    "windowsExtensions": {
      windowsExtensions object
    }
  },
  "alternateIcons": {
    "icon": {
      extensionCommonIcon object
    },
    "highResolutionIcon": {
      extensionCommonIcon object
    }
  }
}

{
  "requirements": {
    "capabilities": [
      {
        capabilities object
      }
    ],
    "scopes": [
      "mail | workbook | document | presentation"
    ],
    "formFactors": [
      "desktop | mobile"
    ]
  },
  "prefer": {
    "comAddin": {
      comAddin object
    },
    "xllCustomFunctions": {
      extensionXllCustomFunctions object
    }
  },
  "hide": {
    "storeOfficeAddin": {
      storeOfficeAddin object
    },
    "customOfficeAddin": {
      customOfficeAddin object
    }
  },
  "alternateIcons": {
    "icon": {
      extensionCommonIcon object
    },
    "highResolutionIcon": {
      extensionCommonIcon object
    }
  }
}

{
  "requirements": {
    "capabilities": [
      {
        capabilities object
      }
    ],
    "scopes": [
      "mail | workbook | document | presentation"
    ],
    "formFactors": [
      "desktop | mobile"
    ]
  },
  "prefer": {
    "comAddin": {
      comAddin object
    }
  },
  "hide": {
    "storeOfficeAddin": {
      storeOfficeAddin object
    },
    "customOfficeAddin": {
      customOfficeAddin object
    }
  },
  "alternateIcons": {
    "icon": {
      extensionCommonIcon object
    },
    "highResolutionIcon": {
      extensionCommonIcon object
    }
  }
}

Properties

requirements

Specifies the scopes, formFactors, and Office JavaScript library requirement sets that must be supported on the Office client in order for the hide, prefer, or alternateIcons properties to take effect. For more information, see Specify Office Add-in requirements in the unified manifest for Microsoft 365.

Type
requirementsExtensionElement

Required
—

Constraints

Supported values

prefer

Specifies an equivalent COM add-in or VSTO add-in that should be used in Office on Windows instead of the Office Web Add-in.

Type
prefer

Required
—

Constraints

Supported values

hide

Configures how to hide another add-in that you've published whenever the add-in is installed, so users don't see both in the Microsoft 365 UI. For example, use this property when you've previously published an add-in that uses the old XML app manifest and you're replacing it with a version that uses the new JSON app manifest.

Type
hide

Required
—

Constraints

Supported values

alternateIcons

For future use. We are working on a system that will enable Office Add-ins that use the unified manifest for Microsoft 365 to be installable on older or non-subscription Office versions or platforms that do not directly support the unified manifest. That system will use this object to specify the icons that represent the add-in Office Add-in in the add-in insertion UX and the vertical task pane tab bar. For more information, see Office Add-ins with the unified app manifest for Microsoft 365 - Client and platform support.

Type
alternateIcons

Required
✅

Constraints

Supported values

alternateIcons

For future use. We are working on a system that will make Office Add-ins that use the unified manifest for Microsoft 365 installable on older or non-subscription Office versions or platforms that do not directly support the unified manifest. That system will use this object to specify the icons that represent the add-in Office Add-in in the add-in insertion UX and the vertical task pane tab bar. For more information, see Office Add-ins with the unified app manifest for Microsoft 365 - Client and platform support.

Type
alternateIcons

Required
—

Constraints

Supported values

Examples

{
  "alternates": [
    {
      "requirements": {
        "scopes": [ "mail" ]
      },
      "prefer": {
        "comAddin": {
          "progId": "ContosoExtension"
        }
      },
      "hide": {
        "storeOfficeAddin": {
          "officeAddinId": "00000000-0000-0000-0000-000000000000",
          "assetId": "WA000000000"
        }
      },
      "alternateIcons": {
        "icon": {
          "size": 64,
          "url": "https://contoso.com/assets/icon64x64.jpg"
        },
        "highResolutionIcon": {
          "size": 64,
          "url": "https://contoso.com/assets/icon128x128.jpg"
        }
      }
    }
  ]
}

See also

  • Last updated on