.. _org.freedesktop.portal.Documents:

================================
 Documents
================================



Portal for managing files and documents

The document portal allows to make files from the outside world
available to sandboxed applications in a controlled way.

Exported files will be made accessible to the application via
a fuse filesystem that gets mounted at ``/run/user/$UID/doc/``. The
filesystem gets mounted both outside and inside the sandbox, but
the view inside the sandbox is restricted to just those files
that the application is allowed to access.

Individual files will appear at ``/run/user/$UID/doc/$DOC_ID/filename``,
where $DOC_ID is the ID of the file in the document store. It is
returned by the `org.freedesktop.portal.Documents.Add`_ and
`org.freedesktop.portal.Documents.AddNamed`_ calls.

The permissions that the application has for a document store entry
(see `org.freedesktop.portal.Documents.GrantPermissions`_) are reflected
in the POSIX mode bits in the fuse filesystem.

The D-Bus interface for the document portal is available under the
bus name org.freedesktop.portal.Documents and the object path
/org/freedesktop/portal/documents.

This documentation describes version 5 of this interface.




.. include:: doc-org.freedesktop.portal.Documents.properties.rst

.. include:: doc-org.freedesktop.portal.Documents.methods.rst