Hide navigation sidebar
Hide table of contents sidebar
Skip to content
Back to top
View this page
Toggle table of contents sidebar

# API Reference

Portal interfaces are available to sandboxed applications with the default filtered session bus access of Flatpak.

Desktop portals appear under the bus name `org.freedesktop.portal.Desktop` and the object path `/org/freedesktop/portal/desktop` on the session bus, unless specified otherwise.

Apps running on the host system have access to a special interface for registering themselves with XDG Desktop Portal. Registering a host app with XDG Desktop Portal overwrites the automatic detection based on the XDG cgroup pathname standardization for applications. This might improve the user experience when the host app was launched in a way that doesn’t follow the standard. See org.freedesktop.host.portal.Registry

Disclaimer: The host app registry is expected to eventually be deprecated and may be removed. Applications should gracefully handle interface or method no longer being available to be forward compatible. App launchers, or apps themselves, should place the app in a cgroup named according to specific naming conventions. When the host app registry becomes deprecated, the details of the replacement will be documented in org.freedesktop.host.portal.Registry.

All apps have access to the portals below:

- Account
- Background
- Camera
- Clipboard
- Documents
- Dynamic Launcher
- Email
- File Chooser
- File Transfer
- Game Mode
- Global Shortcuts
- Inhibit
- Input Capture
- Location
- Memory Monitor
- Network Monitor
- Notification
- OpenURI
- Power Profile Monitor
- Print
- Proxy Resolver
- Realtime
- Remote Desktop
- Request
- ScreenCast
- Screenshot
- Secret
- Session
- Settings
- Trash
- Usb
- Wallpaper