App element (SharePoint Add-in Manifest)

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

The top level node of the manifest of a SharePoint Add-in.

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.

Element information

Element type AppDefinition
Namespace http://schemas.microsoft.com/sharepoint/2012/app/manifest
Schema file appmanifest.xsd

Definition

    <xs:element name="App" type="AppDefinition" >
    </xs:element>     

Elements and attributes

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

Parent elements

None.


Child elements

Element

Type

Description

AppPermissionRequests

AppPermissionRequestsDefinition

A list of resources that a SharePoint Add-in needs to access.

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 internal name of the SharePoint Add-in. This value is not localized, and is used in URLs that address add-in artifacts. It must contain only ASCII characters with no spaces and cannot exceed 64 characters. See the **NameDefinition** type specification for more information about the restrictions.

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.