Expand description
Interact with the user’s desktop such as taking a screenshot, setting a background or querying the user’s location.
Modules
Request access to the current logged user information such as the id, name or their avatar uri.
Request running an application in the background. Note This portal only works for sandboxed applications.
Check if a camera is available, request access to it and open a PipeWire remote stream.
Request access to specific devices such as camera, speakers or microphone. Note This portal doesn’t work for sandboxed applications.
Examples
Compose an email.
Open/save file(s) chooser.
Enable/disable/query the status of Game Mode.
Inhibit the session from being restarted or the user from logging out.
Query the user’s GPS location.
Monitor memory level.
Check the status of the network on a user’s machine. Note This portal doesn’t work for sandboxed applications.
Send/withdraw notifications.
Open a file or a directory.
Power profile monitoring.
Print a document.
Proxy information. Note This portal doesn’t work for sandboxed applications.
Set threads to realtime.
Start a remote desktop session and interact with it.
Start a screencast session and get the PipeWire remote of it.
Take a screenshot or pick a color.
Retrieve a per-application secret used to encrypt confidential data inside the sandbox.
Read & listen to system settings changes.
Move a file to the trash.
Set a wallpaper on lockscreen, background or both.
Structs
The Session interface is shared by all portal interfaces that involve long lived sessions. When a method that creates a session is called, if successful, the reply will include a session handle (i.e. object path) for a Session object, which will stay alive for the duration of the session.
Enums
An error returned a portal request caused by either the user cancelling the request or something else.