AppDefinition complexType

Article
06/29/2022

(SharePoint Add-in Manifest)

Applies to: SharePoint Add-ins | SharePoint Foundation 2013 | SharePoint Server 2013

Note

The string app appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed.

Type information

Information	Location
Namespace	`http://schemas.microsoft.com/sharepoint/2012/app/manifest`
Schema file	appmanifest.xsd
Extension base	None

Definition

    <xs:complexType name="AppDefinition">
      <xs:all>
        <xs:element name="AppPrincipal"  type="AppPrincipalDefinition"
         minOccurs="1"
         maxOccurs="1"
        >
        </xs:element>

        <xs:element name="AppPermissionRequests"  type="AppPermissionRequestsDefinition"
         minOccurs="0"
         maxOccurs="1"
        >
        </xs:element>

        <xs:element name="Properties"  type="PropertiesDefinition"
         minOccurs="1"
         maxOccurs="1"
        >
        </xs:element>

        <xs:element name="RemoteEndpoints"  type="RemoteEndpointsDefinition"
         minOccurs="0"
         maxOccurs="1"
        >
        </xs:element>

        <xs:element name="AppPrerequisites"  type="AppPrerequisiteCollection"
         minOccurs="0"
         maxOccurs="1"
        >
        </xs:element>
      </xs:all>

        <xs:attribute name="ProductID"
         type="GUID"
         use="required"
        />
        <xs:attribute name="Type"
         type="TypeDefinition"
         use="optional"
        />
        <xs:attribute name="Version"
         type="VersionDefinition"
         use="required"
        />
        <xs:attribute name="SharePointMinVersion"
         type="VersionDefinition"
         use="required"
        />
        <xs:attribute name="SharePointMaxVersion"
         type="VersionDefinition"
         use="optional"
        />
        <xs:attribute name="Name"
         type="NameDefinition"
         use="required"
        />
    </xs:complexType>

Elements and attributes

If the schema defines specific requirements, such as sequence, minOccurs, maxOccurs, and choice, see the definition section.

Child elements

Element	Type	Description
AppPermissionRequests	AppPermissionRequestsDefinition	A list of resources that a SharePoint Add-in needs access to.
AppPrerequisites	AppPrerequisiteCollection	A list of prerequisites that a SharePoint Add-in depends on.
AppPrincipal	AppPrincipalDefinition	The add-in principal information.
Properties	PropertiesDefinition	Contains information that is global to the add-in.
RemoteEndpoints	RemoteEndpointsDefinition	(Optional) A list of remote endpoints that the SharePoint Add-in may access through SP.WebProxy.invoke(). If this list is empty or not provided, the SharePoint Add-in will not be able to use any remote endpoint through SP.WebProxy.invoke().

Attributes

Attribute	Type	Required	Description	Possible values
Name	NameDefinition	required	The name of the SharePoint Add-in. Name is not localized, and is used in Urls that address add-in artifacts.	Values of the NameDefinition type.
ProductID	GUID	required	The unique identifier of the SharePoint Add-in. ProductID does not change between versions.	Values of the GUID type.
SharePointMaxVersion	VersionDefinition	optional	Optional. The maximum version of SharePoint that the add-in is compatible with.	Values of the VersionDefinition type.
SharePointMinVersion	VersionDefinition	required	The minimum version of SharePoint that the add-in is compatible with.	Values of the VersionDefinition type.
Type	TypeDefinition	optional	The type of the SharePoint Add-in.	Values of the TypeDefinition type.
Version	VersionDefinition	required	The version of the SharePoint Add-in.	Values of the VersionDefinition type.

Share via