extensionAlternateVersionsArray.hide object

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.

Properties that reference this object type:

• root.extensions.alternates.hide

Syntax

Syntax

{
  "storeOfficeAddin": {
    "officeAddinId": "{string}",
    "assetId": "{string}"
  },
  "customOfficeAddin": {
    "officeAddinId": "{string}"
  }
}

Schema

{
  "type": "object",
  "properties": {
    "storeOfficeAddin": {
      "type": "object",
      "properties": {
        "officeAddinId": {
          "type": "string",
          "description": "Solution ID of an in-market add-in to hide. Maximum length is 64 characters.",
          "maxLength": 64
        },
        "assetId": {
          "type": "string",
          "description": "Asset ID of the in-market add-in to hide. Maximum length is 64 characters.",
          "maxLength": 64
        }
      },
      "additionalProperties": false,
      "required": [
        "officeAddinId",
        "assetId"
      ]
    },
    "customOfficeAddin": {
      "type": "object",
      "properties": {
        "officeAddinId": {
          "type": "string",
          "description": "Solution ID of the in-market add-in to hide. Maximum length is 64 characters.",
          "maxLength": 64
        }
      },
      "additionalProperties": false,
      "required": [
        "officeAddinId"
      ]
    }
  },
  "minProperties": 1
}

Properties

storeOfficeAddin

Specifies a Microsoft 365 Add-in available in Microsoft AppSource.

Type
storeOfficeAddin

Required
—

Constraints

Supported values

customOfficeAddin

Configures how to hide an in-market add-in that isn't distributed through AppSource.

Type
customOfficeAddin

Required
—

Constraints

Supported values

Examples

{
  "hide": {
    "storeOfficeAddin": {
      "officeAddinId": "00000000-0000-0000-0000-000000000000",
      "assetId": "WA000000000"
    }
  }
}