Module desktop 

Interact with the user’s desktop such as taking a screenshot, setting a background or querying the user’s location.

Modules

accountaccount

Access to the current logged user information such as the id, name or their avatar uri.

backgroundbackground

Request to run in the background or started automatically when the user logs in.

cameracamera

Check if a camera is available, request access to it and open a PipeWire remote stream.

clipboardclipboard

Interact with the clipboard.

dynamic_launcherdynamic_launcher

Install launchers like Web Application from your browser or Steam.

emailemail

Compose an email.

file_chooserfile_chooser

Open/save file(s) chooser. The interface lets sandboxed applications ask the user for access to files outside the sandbox. The portal backend will present the user with a file chooser dialog.

game_modegame_mode

Enable/disable/query the status of Game Mode.

global_shortcutsglobal_shortcuts

Register global shortcuts Register global shortcuts

inhibitinhibit

Inhibit the session from being restarted or the user from logging out.

input_captureinput_capture

Capture input events from physical or logical devices.

locationlocation

Query the user’s GPS location.

memory_monitormemory_monitor

Monitor memory level.

network_monitornetwork_monitor

Check the status of the network on a user’s machine. Note This portal doesn’t work for sandboxed applications.

notificationnotification

Send/withdraw notifications.

open_uriopen_uri

Open a URI or a directory.

power_profile_monitorpower_profile_monitor

Power profile monitoring.

printprint

Print a document.

proxy_resolverproxy_resolver

Proxy information. Note This portal doesn’t work for sandboxed applications.

realtimerealtime

Set threads to realtime.

remote_desktopremote_desktop

Start a remote desktop session and interact with it.

screencastscreencast

Start a screencast session and get the PipeWire remote of it.

screenshotscreenshot

Take a screenshot or pick a color.

secretsecret

Retrieve a per-application secret used to encrypt confidential data inside the sandbox.

settingssettings

Read & listen to system settings changes.

trashtrash

Move a file to the trash.

usbusb

Provide an interface to USB device. Allow enumerating devices and requiring access to.

wallpaperwallpaper

Set a wallpaper on lockscreen, background or both.

Structs

Colorscreenshot or settings

A color as a RGB tuple.

CreateSessionOptions

Specified options for creating a session.

HandleTokenbackend

A handle token is a DBus Object Path element.

Request

The Request interface is shared by all portal interfaces.

Session

Shared by all portal interfaces that involve long lived sessions.

Enums

Iconnotification or dynamic_launcher or backend

A representation of an icon.

PersistModescreencast or remote_desktop or input_capture

Persistence mode for a screencast, remote desktop, or input capture session.

Response

A typical response returned by the Request::response. of a Request.

ResponseError

An error returned a portal request caused by either the user cancelling the request or something else.

ResponseType

Possible responses.

Traits

SessionPortal

Portals that have a long-lived interaction