Export (0) Print
Expand All
Expand Minimize

Permissions element (TaskPaneApp complexType) (app manifest schema v1.1)

Controls the subset of the API that may be available to this task pane app at runtime; the developer should request permissions based on "least privilege".

Last modified: March 12, 2014

Task pane app

Element type

xs:string

Namespace

http://schemas.microsoft.com/office/appforoffice/1.0

Schema file

offappmanifest.xsd

<xs:element name="Permissions" minOccurs="1" maxOccurs="1">
    <xs:simpleType>
        <xs:restriction base="xs:string">
            <xs:enumeration value="Restricted" />
            <xs:enumeration value="ReadDocument" />
            <xs:enumeration value="ReadAllDocument" />
            <xs:enumeration value="WriteDocument" />
            <xs:enumeration value="ReadWriteDocument" />
        </xs:restriction>
    </xs:simpleType>
</xs:element>

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

Parent elements

None.

Child elements

None.

Attributes

None.

Value

Description

Restricted

Permission that applies to all task pane apps, enables activation and allows use of the Settings object.

ReadDocument

Includes the Restricted permission, and also enables the task pane app to use the getSelectedDataAsync method to read from the document.

ReadAllDocument

Includes the Restricted and ReadDocument permission, and also enables the task pane app to use the getFileAsync method to obtain a copy of the entire document.

WriteDocument

Includes the Restricted permission, and also enables the task pane app to use the setSelectedDataAsync method to write to the document.

ReadWriteDocument

Includes the ReadAllDocument and WriteDocument permissions, and also enables the task pane app to use all write methods, manage bindings, and subscribe to events.

  • An app should request the level of permission based on the APIs it uses. Requesting insufficient permission can result in the host application blocking the use of specific APIs in the app and generating errors at runtime.

Show:
© 2014 Microsoft