Options to use when requesting background. No options Request autostart as well Whether the application is D-Bus-activatable The XdpButtonState enumeration is used to describe the state of buttons. the button is down the button is up Options for how the cursor is handled. no cursor cursor is embedded on the stream cursor is sent as metadata of the stream Flags to specify what input devices to control for a remote desktop session. no device control the keyboard. control the pointer. control the touchscreen. The `XdpDiscreteAxis` enumeration is used to describe the discrete scroll axes. the horizontal scroll axis the horizontal scroll axis Flags that determine what session status changes are inhibited. Inhibit logout Inhibit user switching Inhibit suspend Inhibit the session going idle Flags to specify what input device capabilities should be captured no device capture the keyboard capture pointer events capture touchscreen events A representation of a pointer barrier on an [class@InputCaptureZone]. Barriers can be assigned with [method@InputCaptureSession.set_pointer_barriers], once the Portal interaction is complete the barrier's "is-active" state indicates whether the barrier is active. Barriers can only be used once, subsequent calls to [method@InputCaptureSession.set_pointer_barriers] will invalidate all current barriers. The caller-assigned unique id of this barrier A boolean indicating whether this barrier is active. A barrier cannot become active once it failed to apply, barriers that are not active can be thus cleaned up by the caller. The pointer barrier x offset in logical pixels The pointer barrier x offset in logical pixels The pointer barrier y offset in logical pixels The pointer barrier y offset in logical pixels A representation of a long-lived input capture portal interaction. The [class@InputCaptureSession] object is used to represent portal interactions with the input capture desktop portal that extend over multiple portal calls. Usually a caller creates an input capture session, requests the available zones and sets up pointer barriers on those zones before enabling the session. To find available zones, call [method@InputCaptureSession.get_zones]. These [class@InputCaptureZone] object represent the accessible desktop area for input capturing. [class@InputCapturePointerBarrier] objects can be set up on these zones to trigger input capture. The [class@InputCaptureSession] wraps a [class@Session] object. Connect this session to an EIS implementation and return the fd. This fd can be passed into ei_setup_backend_fd(). See the libei documentation for details. This is a sync DBus invocation. a socket to the EIS implementation for this input capture session or a negative errno on failure. a [class@InputCaptureSession] Disables this input capture session. a [class@InputCaptureSession] Enables this input capture session. In the future, this client may receive input events. a [class@InputCaptureSession] Return the [class@XdpSession] for this InputCapture session. a [class@Session] object a [class@XdpInputCaptureSession] Obtains the current set of [class@InputCaptureZone] objects. The returned object is valid until the zones are invalidated by the [signal@InputCaptureSession::zones-changed] signal. Unless the session is active, this function returns `NULL`. the available zones. The caller must keep a reference to the list or the elements if used outside the immediate scope. a [class@InputCaptureSession] Releases this input capture session without a suggested cursor position. a [class@InputCaptureSession] Releases this input capture session with a suggested cursor position. Note that the implementation is not required to honour this position. a [class@InputCaptureSession] the suggested cursor x position once capture has been released the suggested cursor y position once capture has been released Sets the pointer barriers for this session. When the request is done, @callback will be called. You can then call [method@InputCaptureSession.set_pointer_barriers_finish] to get the results. The result of this request is the list of pointer barriers that failed to apply - barriers not present in the returned list are active. Once the pointer barrier is applied (i.e. the reply to the DBus Request has been received), the the [property@InputCapturePointerBarrier:is-active] property is changed on that barrier. Failed barriers have the property set to a %FALSE value. a [class@InputCaptureSession] the pointer barriers to apply Finishes the set-pointer-barriers request, and returns a GList with the pointer barriers that failed to apply and should be cleaned up by the caller. a list of failed pointer barriers a [class@InputCaptureSession] a [iface@Gio.AsyncResult] Emitted when an InputCapture session activates and sends events. When this signal is emitted, events will appear on the transport layer. the unique activation_id to identify this input capture a GVariant with the signal options Emitted when an InputCapture session deactivates and no longer sends events. the unique activation_id to identify this input capture a GVariant with the signal options Emitted when an InputCapture session is disabled. This signal is emitted when capturing was disabled by the server. a GVariant with the signal options Emitted when an InputCapture session's zones have changed. When this signal is emitted, all current zones will have their [property@InputCaptureZone:is-valid] property set to %FALSE and all internal references to those zones have been released. This signal is sent after libportal has fetched the updated zones, a caller should call xdp_input_capture_session_get_zones() to retrieve the new zones. a GVariant with the signal options A representation of a zone that supports input capture. The [class@XdpInputCaptureZone] object is used to represent a zone on the user-visible desktop that may be used to set up [class@XdpInputCapturePointerBarrier] objects. In most cases, the set of [class@XdpInputCaptureZone] objects represent the available monitors but the exact implementation is up to the implementation. The height of this zone in logical pixels A boolean indicating whether this zone is currently valid. Zones are invalidated by the Portal's ZonesChanged signal, see [signal@InputCaptureSession::zones-changed]. Once invalidated, a Zone can be discarded by the caller, it cannot become valid again. The width of this zone in logical pixels The x offset of this zone in logical pixels The x offset of this zone in logical pixels The `XdpKeyState` enumeration is used to describe the state of keys. the key is down the key is up The type of a launcher. a launcher for a regular application a launcher for a web app The values of this enum indicate the desired level of accuracy for location information. No particular accuracy Country-level accuracy City-level accuracy Neighborhood-level accuracy Street-level accuracy Maximum accuracy The values of this enum are returned in the [signal@Portal::session-state-changed] signal to indicate the current state of the user session. the session is running the session is in the query end phase, during which applications can save their state or inhibit the session from ending the session is about to end Options for opening files. No options Allow selecting multiple files Options for opening uris. No options Use an application chooser for the given uri Allow writing to file (if uri points to a local file that is exported in the document portal and app is sandboxed itself) Flags to specify what kind of sources to offer for a screencast session. do not select any output allow selecting monitors allow selecting individual application windows allow creating new virtual displays Parent window abstraction. The [struct@Parent] struct provides an abstract way to represent a window, without introducing a dependency on a toolkit library. XdpParent implementations for GTK 3, GTK 4, Qt 5, and Qt 6 are available as separate libraries. Copies @source into a new [struct@Parent]. an [struct@Parent] that is a copy of @source a [struct@Parent] Frees @parent. an [struct@Parent] Options for how the screencast session should persist. do not persist persist as long as the application is alive persist until the user revokes this permission Context for portal calls. The XdpPortal object provides the main context object for the portal operations of libportal. Typically, an application will create a single XdpPortal object with [ctor@Portal.new] and use it throughout its lifetime. Creates a new [class@Portal] object. a newly created [class@Portal] object or NULL on error Creates a new [class@Portal] object. If D-Bus is unavailable this API will abort. We recommend using xdp_portal_initable_new() to safely handle this failure. a newly created [class@Portal] object Detects if running inside of a Flatpak or WebKit sandbox. See also: [func@Portal.running_under_sandbox]. %TRUE if the current process is running under a Flatpak sandbox This function tries to determine if the current process is running under a sandbox that requires the use of portals. If you need to check error conditions see [func@Portal.running_under_snap]. Note that these functions are all cached and will always return the same result. %TRUE if the current process should use portals to access resources on the host system, or %FALSE if either an error was encountered or the process is running unsandboxed Detects if you are running inside of a Snap sandbox. See also: [func@Portal.running_under_sandbox]. %TRUE if the current process is running under a Snap sandbox, or %FALSE if either unsandboxed or an error was encountered in which case @error will be set Request access to a camera. When the request is done, @callback will be called. You can then call [method@Portal.access_camera_finish] to get the results. a [class@Portal] parent window information options for this call optional [class@Gio.Cancellable] a callback to call when the request is done data to pass to @callback Finishes a camera acess request. Returns the result as a boolean. If the access was granted, you can then call [method@Portal.open_pipewire_remote_for_camera] to obtain a pipewire remote. `TRUE` if access to a camera was granted a [class@Portal] a [iface@Gio.AsyncResult] Sends a desktop notification. The following keys may be present in @notification: - title `s`: a user-visible string to display as title - body `s`: a user-visible string to display as body - markup-body `s`: a user-visible string to display as body with support for markup - icon `v`: a serialized icon (in the format produced by [method@Gio.Icon.serialize] for class@Gio.ThemedIcon, class@Gio.FileIcon and class@Gio.BytesIcon) - sound `v`: a serialized sound - priority `s`: "low", "normal", "high" or "urgent" - default-action `s`: name of an action that will be activated when the user clicks on the notification - default-action-target `v`: target parameter to send along when activating the default action. - buttons `aa{sv}`: array of serialized buttons - display-hint `as`: An array of display hints. - category `s`: A category for this notification. [See the spec for supported categories](https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.Notification.html#org-freedesktop-portal-notification-addnotification) The serialized sound consists of a `s` or `sv`: - default : Play the default sound for the notification. - silent : Don't ever play a sound for the notification. - file `s`: A path to a sound file. - bytes `ay`: An array of bytes. The supported sound formats are ogg/opus, ogg/vorbis and wav/pcm. Each serialized button is a dictionary with the following supported keys: - label `s`: user-visible label for the button. Mandatory without a purpose. - action `s`: name of an action that will be activated when the user clicks on the button. Mandatory - purpose `s`: information used by the server to style the button specially. - target `v`: target parameter to send along when activating the button Actions with a prefix of "app." are assumed to be exported by the application and will be activated via the org.freedesktop.Application interface, others are activated by emitting the [signal@Portal::notification-action-invoked] signal. It is the callers responsibility to ensure that the ID is unique among all notifications. To withdraw a notification, use [method@Portal.remove_notification]. a [class@Portal] unique ID for the notification a [struct@GLib.Variant] dictionary with the content of the notification options for this call optional [class@Gio.Cancellable] a callback to call when the request is done data to pass to @callback Finishes the notification request. Returns the result as a boolean. `TRUE` if the notification was added a [class@Portal] a [iface@Gio.AsyncResult] Presents a window that lets the user compose an email, with some pre-filled information. When the request is done, @callback will be called. You can then call [method@Portal.compose_email_finish] to get the results. a [class@Portal] parent window information the email addresses to send to the email addresses to cc the email addresses to bcc the subject for the email the body for the email an array of paths for files to attach options for this call optional [class@Gio.Cancellable] a callback to call when the request is done data to pass to @callback Finishes the compose-email request. `TRUE` if the request was handled successfully a [class@Portal] a [iface@Gio.AsyncResult] Creates a session for input capture When the request is done, @callback will be called. You can then call [method@Portal.create_input_capture_session_finish] to get the results. a [class@Portal] parent window information which kinds of capabilities to request optional [class@Gio.Cancellable] a callback to call when the request is done data to pass to @callback Finishes the InputCapture CreateSession request, and returns a [class@InputCaptureSession]. To get to the [class@Session] within use xdp_input_capture_session_get_session(). a [class@InputCaptureSession] a [class@Portal] a [iface@Gio.AsyncResult] Creates a session for remote desktop. When the request is done, @callback will be called. You can then call [method@Portal.create_remote_desktop_session_finish] to get the results. a [class@Portal] which kinds of input devices to ofer in the new dialog which kinds of source to offer in the dialog options for this call the cursor mode of the session optional [class@Gio.Cancellable] a callback to call when the request is done data to pass to @callback Finishes the create-remote-desktop request, and returns a [class@Session]. a [class@Session] a [class@Portal] a [iface@Gio.AsyncResult] Creates a session for remote desktop. When the request is done, @callback will be called. You can then call [method@Portal.create_remote_desktop_session_finish] to get the results. a [class@Portal] which kinds of input devices to ofer in the new dialog which kinds of source to offer in the dialog options for this call the cursor mode of the session the persist mode of the session the token of a previous screencast session to restore optional [class@Gio.Cancellable] a callback to call when the request is done data to pass to @callback Creates a session for a screencast. When the request is done, @callback will be called. You can then call [method@Portal.create_screencast_session_finish] to get the results. a [class@Portal] which kinds of source to offer in the dialog options for this call the cursor mode of the session the persist mode of the session the token of a previous screencast session to restore optional [class@Gio.Cancellable] a callback to call when the request is done data to pass to @callback Finishes the create-screencast request, and returns a [class@Session]. a [class@Session] a [class@Portal] a [iface@Gio.AsyncResult] This function gets the contents of a .desktop file that was previously installed by the dynamic launcher portal. The @desktop_file_id must be prefixed with the caller's app ID followed by a "." and suffixed with ".desktop". the contents of the desktop file, or %NULL with @error set a [class@Portal] the .desktop file name This function gets the icon associated with a .desktop file that was previously installed by the dynamic launcher portal. The @desktop_file_id must be prefixed with the caller's app ID followed by a "." and suffixed with ".desktop". the icon in a format recognized by g_icon_deserialize(), or %NULL with @error set a [class@Portal] the .desktop file name return location for icon format string, one of "png", "jpeg", "svg" return location for icon size This function completes installation of a launcher so that the icon and name given in previous method calls will show up in the desktop environment's menu. The @desktop_file_id must be prefixed with the caller's app ID followed by a "." and suffixed with ".desktop". The @desktop_entry data need not include Icon= or Name= entries since these will be added by the portal, and the Exec= entry will be rewritten to call the application with e.g. "flatpak run" depending on the sandbox status of the app. %TRUE if the installation was successful, %FALSE with @error set otherwise a [class@Portal] a token acquired via a [method@Portal.dynamic_launcher_request_install_token] or [method@Portal.dynamic_launcher_prepare_install] call the .desktop file name to be used the key-file to be used for the contents of the .desktop file Presents a dialog to the user so they can confirm they want to install a launcher to their desktop. When the request is done, @callback will be called. You can then call [method@Portal.dynamic_launcher_prepare_install_finish] to get the results. a [class@Portal] parent window information the name for the launcher a #GBytesIcon as returned by g_icon_serialize(). Must be a png or jpeg no larger than 512x512, or an svg the type of the launcher the URL if the launcher is for a web app, or %NULL if %TRUE, the user will be able to edit the name of the launcher if %TRUE, the user will be able to edit the icon of the launcher, if the implementation supports this optional [class@Gio.Cancellable] a callback to call when the request is done data to pass to @callback Finishes the prepare-install-launcher request, and returns [struct@GLib.Variant] dictionary with the following information: - name s: the name chosen by the user (or the provided name if the editable_name option was not set) - token s: a token that can by used in a [method@Portal.dynamic_launcher_install] call to complete the installation a [struct@GLib.Variant] dictionary with launcher information a [class@Portal] a [iface@Gio.AsyncResult] Requests a token which can be passed to [method@Portal.dynamic_launcher_install] to complete installation of the launcher without user interaction. This function only works when the caller's app ID is in the allowlist for the portal backend being used. It's intended for software centers such as GNOME Software or KDE Discover. a token that can be passed to [method@Portal.dynamic_launcher_install], or %NULL with @error set a [class@Portal] the name for the launcher a #GBytesIcon as returned by g_icon_serialize(). Must be a png or jpeg no larger than 512x512, or an svg This function uninstalls a launcher that was previously installed using the dynamic launcher portal, resulting in the .desktop file and icon being deleted. The @desktop_file_id must be prefixed with the caller's app ID followed by a "." and suffixed with ".desktop". %TRUE if the uninstallation was successful, %FALSE with @error set otherwise a [class@Portal] the .desktop file name This function returns an object to access settings exposed through the portal. a [class@Settings] new settings object. a vardict of supported options for properties that have options. a [class@Portal] Gets information about the user. When the request is done, @callback will be called. You can then call [method@Portal.get_user_information_finish] to get the results. a [class@Portal] parent window information a string that can be shown in the dialog to explain why the information is needed options for this call optional [class@Gio.Cancellable] a callback to call when the request is done data to pass to @callback Finishes the get-user-information request. Returns the result in the form of a [struct@GLib.Variant] dictionary containing the following fields: - id `s`: the user ID - name `s`: the users real name - image `s`: the uri of an image file for the users avatar picture a [struct@GLib.Variant] dictionary with user information a [class@Portal] a [iface@Gio.AsyncResult] Returns whether any camera are present. `TRUE` if the system has cameras a [class@Portal] Makes `XdpPortal` start monitoring location changes. When the location changes, the [signal@Portal::location-updated]. signal is emitted. Use [method@Portal.location_monitor_stop] to stop monitoring. Note that [class@Portal] only maintains a single location monitor at a time. If you want to change the @distance_threshold, @time_threshold or @accuracy of the current monitor, you first have to call [method@Portal.location_monitor_stop] to stop monitoring. a [class@Portal] a [struct@Parent], or `NULL` distance threshold, in meters time threshold, in seconds desired accuracy options for this call optional [class@Gio.Cancellable] a callback to call when the request is done data to pass to @callback Finishes a location-monitor request. Returns result in the form of boolean. `TRUE` if the request succeeded a [class@Portal] a [iface@Gio.AsyncResult] Stops location monitoring that was started with [method@Portal.location_monitor_start]. a [class@Portal] Opens the directory containing the file specified by the @uri. which must be a file: uri pointing to a file that the application has access to. a [class@Portal] parent window information the URI to open options for this call optional [class@Gio.Cancellable] a callback to call when the request is done data to pass to @callback Finishes the open-directory request. Returns the result in the form of a boolean. `TRUE` if the call succeeded a [class@Portal] a [iface@Gio.AsyncResult] Asks the user to open one or more files. The format for the @filters argument is `a(sa(us))`. Each item in the array specifies a single filter to offer to the user. The first string is a user-visible name for the filter. The `a(us)` specifies a list of filter strings, which can be either a glob pattern (indicated by 0) or a mimetype (indicated by 1). Example: `[('Images', [(0, '*.ico'), (1, 'image/png')]), ('Text', [(0, '*.txt')])]` The format for the @choices argument is `a(ssa(ss)s)`. For each element, the first string is an ID that will be returned with the response, te second string is a user-visible label. The `a(ss)` is the list of choices, each being a is an ID and a user-visible label. The final string is the initial selection, or `""`, to let the portal decide which choice will be initially selected. None of the strings, except for the initial selection, should be empty. As a special case, passing an empty array for the list of choices indicates a boolean choice that is typically displayed as a check button, using `"true"` and `"false"` as the choices. Example: `[('encoding', 'Encoding', [('utf8', 'Unicode (UTF-8)'), ('latin15', 'Western')], 'latin15'), ('reencode', 'Reencode', [], 'false')]` When the request is done, @callback will be called. You can then call [method@Portal.open_file_finish] to get the results. a [class@Portal] parent window information title for the file chooser dialog a [struct@GLib.Variant] describing file filters a [struct@GLib.Variant] describing the current file filter a [struct@GLib.Variant] describing extra widgets options for this call optional [class@Gio.Cancellable] a callback to call when the request is done data to pass to @callback Finishes the open-file request Returns the result in the form of a [struct@GLib.Variant] dictionary containing the following fields: - uris `as`: an array of strings containing the uris of selected files - choices `a(ss)`: an array of pairs of strings, the first string being the ID of a combobox that was passed into this call, the second string being the selected option. a [struct@GLib.Variant] dictionary with the results a [class@Portal] a [iface@Gio.AsyncResult] Opens a file descriptor to the pipewire remote where the camera nodes are available. The file descriptor should be used to create a pw_core object, by using pw_context_connect_fd(). Only the camera nodes will be available from this pipewire node. the file descriptor a [class@Portal] Opens @uri with an external handler. a [class@Portal] parent window information the URI to open options for this call optional [class@Gio.Cancellable] a callback to call when the request is done data to pass to @callback Finishes the open-uri request. Returns the result in the form of a boolean. `TRUE` if the call succeeded a [class@Portal] a [iface@Gio.AsyncResult] Lets the user pick a color from the screen. When the request is done, @callback will be called. You can then call [method@Portal.pick_color_finish] to get the results. a [class@Portal] parent window information optional [class@Gio.Cancellable] a callback to call when the request is done data to pass to @callback Finishes a pick-color request. Returns the result in the form of a GVariant of the form (ddd), containing red, green and blue components in the range [0,1]. GVariant containing the color a [class@Portal] a [iface@Gio.AsyncResult] Presents a print dialog to the user and returns print settings and page setup. When the request is done, @callback will be called. You can then call [method@Portal.prepare_print_finish] to get the results. a [class@Portal] parent window information tile for the print dialog Serialized print settings Serialized page setup options for this call optional [class@Gio.Cancellable] a callback to call when the request is done data to pass to @callback Finishes the prepare-print request. Returns a [struct@GLib.Variant] dictionary with the following information: - settings `a{sv}`: print settings as set up by the user in the print dialog - page-setup `a{sv}: page setup as set up by the user in the print dialog - token u: a token that can by used in a [method@Portal.print_file] call to avoid the print dialog a [struct@GLib.Variant] dictionary with print information a [class@Portal] a [iface@Gio.AsyncResult] Prints a file. If a valid token is present in the @options, then this call will print with the settings from the Print call that the token refers to. If no token is present, then a print dialog will be presented to the user. When the request is done, @callback will be called. You can then call [method@Portal.print_file_finish] to get the results. a [class@Portal] parent window information tile for the print dialog token that was returned by a previous [method@Portal.prepare_print] call, or 0 path of the document to print options for this call optional [class@Gio.Cancellable] a callback to call when the request is done data to pass to @callback Finishes the print request. `TRUE` if the request was successful a [class@Portal] a [iface@Gio.AsyncResult] Withdraws a desktop notification. a [class@Portal] the ID of an notification Requests background permissions. When the request is done, @callback will be called. You can then call [method@Portal.request_background_finish] to get the results. a [class@Portal] parent window information reason to present to user for request command line to autostart options for this call optional [class@Gio.Cancellable] a callback to call when the request is done data to pass to @callback Finishes the request. Returns `TRUE` if successful. `TRUE` if successful. a [class@Portal] a [iface@Gio.AsyncResult] Asks the user for a location to save a file. The format for the @filters argument is the same as for [method@Portal.open_file]. The format for the @choices argument is the same as for [method@Portal.open_file]. When the request is done, @callback will be called. You can then call [method@Portal.save_file_finish] to get the results. a [class@Portal] parent window information title for the file chooser dialog suggested filename suggested folder to save the file in the current file (when saving an existing file) a [struct@GLib.Variant] describing file filters a [struct@GLib.Variant] describing the current file filter a [struct@GLib.Variant] describing extra widgets options for this call optional [class@Gio.Cancellable] a callback to call when the request is done data to pass to @callback Finishes the save-file request. Returns the result in the form of a [struct@GLib.Variant] dictionary containing the following fields: - uris `(as)`: an array of strings containing the uri of the selected file - choices `a(ss)`: an array of pairs of strings, the first string being the ID of a combobox that was passed into this call, the second string being the selected option. a [struct@GLib.Variant] dictionary with the results a [class@Portal] a [iface@Gio.AsyncResult] Asks for a folder as a location to save one or more files. The names of the files will be used as-is and appended to the selected folder's path in the list of returned files. If the selected folder already contains a file with one of the given names, the portal may prompt or take some other action to construct a unique file name and return that instead. The format for the @choices argument is the same as for [method@Portal.open_file]. When the request is done, @callback will be called. You can then call [method@Portal.save_file_finish] to get the results. a [class@Portal] parent window information title for the file chooser dialog suggested filename suggested folder to save the file in An array of file names to be saved a [struct@GLib.Variant] describing extra widgets options for this call optional [class@Gio.Cancellable] a callback to call when the request is done data to pass to @callback Finishes the save-files request. Returns the result in the form of a [struct@GLib.Variant] dictionary containing the following fields: - uris `(as)`: an array of strings containing the uri corresponding to each file passed to the save-files request, in the same order. Note that the file names may have changed, for example if a file with the same name in the selected folder already exists. - choices `a(ss)`: an array of pairs of strings, the first string being the ID of a combobox that was passed into this call, the second string being the selected option. a [struct@GLib.Variant] dictionary with the results a [class@Portal] a [iface@Gio.AsyncResult] Inhibits various session status changes. To obtain an ID that can be used to undo the inhibition, use [method@Portal.session_inhibit_finish] in the callback. To remove an active inhibitor, call [method@Portal.session_uninhibit] with the same ID. a [class@Portal] parent window information user-visible reason for the inhibition information about what to inhibit optional [class@Gio.Cancellable] a callback to call when the request is done data to pass to @callback Finishes the inhbit request. Returns the ID of the inhibition as a positive integer. The ID can be passed to [method@Portal.session_uninhibit] to undo the inhibition. the ID of the inhibition, or -1 if there was an error a [class@Portal] a [iface@Gio.AsyncResult] This method should be called within one second of receiving a [signal@Portal::session-state-changed] signal with the 'Query End' state, to acknowledge that they have handled the state change. Possible ways to handle the state change are either to call [method@Portal.session_inhibit] to prevent the session from ending, or to save your state and get ready for the session to end. a [class@Portal] Makes [class@Portal] start monitoring the login session state. When the state changes, the [signal@Portal::session-state-changed] signal is emitted. Use [method@Portal.session_monitor_stop] to stop monitoring. a [class@Portal] a XdpParent, or `NULL` options for this call optional [class@Gio.Cancellable] a callback to call when the request is done data to pass to @callback Finishes a session-monitor request. Returns the result in the form of boolean. `TRUE` if the request succeeded a [class@Portal] a [iface@Gio.AsyncResult] Stops session state monitoring that was started with [method@Portal.session_monitor_start]. a [class@Portal] Removes an inhibitor that was created by a call to [method@Portal.session_inhibit]. a [class@Portal] unique ID for an active inhibition Sets the status information of the application, for when it's running in background. a [class@Portal] status message when running in background optional [class@Gio.Cancellable] a callback to call when the request is done data to pass to @callback Finishes setting the background status of the application. %TRUE if successfully set status, %FALSE otherwise a [class@Portal] a [iface@Gio.AsyncResult] Sets a desktop background image, given by a uri. a [class@Portal] parent window information the URI to use options for this call optional [class@Gio.Cancellable] a callback to call when the request is done data to pass to @callback Finishes the open-uri request. Returns the result in the form of a boolean. `TRUE` if the call succeeded a [class@Portal] a [iface@Gio.AsyncResult] Creates a new copy of the applications sandbox, and runs a process in, with the given arguments. The learn when the spawned process exits, connect to the [signal@Portal::spawn-exited] signal. a [class@Portal] the cwd for the new process the argv for the new process an array of open fds to pass to the new process, or `NULL` an array of integers to map the @fds to, or `NULL`. Must be the same length as @fds the length of @fds and @map_to arrays an array of KEY=VALUE environment settings, or `NULL` flags influencing the spawn operation paths to expose rw in the new sandbox, or `NULL` paths to expose ro in the new sandbox, or `NULL` optional [class@Gio.Cancellable] a callback to call when the request is done data to pass to @callback Finishes the spawn request. Returns the pid of the newly spawned process. the pid of the spawned process. a [class@Portal] a [iface@Gio.AsyncResult] Sends a Unix signal to a process that has been spawned by [method@Portal.spawn]. a [class@Portal] the pid of the process to send a signal to the Unix signal to send (see signal(7)) whether to send the signal to the process group of the process Takes a screenshot. When the request is done, @callback will be called. You can then call [method@Portal.take_screenshot_finish] to get the results. a [class@Portal] parent window information options for this call optional [class@Gio.Cancellable] a callback to call when the request is done data to pass to @callback Finishes a screenshot request. Returns the result in the form of a URI pointing to an image file. URI pointing to an image file a [class@Portal] a [iface@Gio.AsyncResult] Sends the file at @path to the trash can. a [class@Portal] the path for a local file optional [class@Gio.Cancellable] a callback to call when the request is done data to pass to @callback Finishes the trash-file request. Returns the result in the form of a boolean. `TRUE` if the call succeeded a [class@Portal] a [iface@Gio.AsyncResult] Installs an available software update. This should be called in response to a [signal@Portal::update-available] signal. During the update installation, the [signal@Portal::update-progress] signal will be emitted to provide progress information. a [class@Portal] a [struct@Parent] options for this call optional [class@Gio.Cancellable] a callback to call when the request is done data to pass to @callback Finishes an update-installation request. Returns the result in the form of boolean. Note that the update may not be completely installed by the time this function is called. You need to listen to the [signal@Portal::update-progress] signal to learn when the installation is complete. `TRUE` if the update is being installed a [class@Portal] a [iface@Gio.AsyncResult] Makes `XdpPortal` start monitoring for available software updates. When a new update is available, the [signal@Portal::update-available]. signal is emitted. Use [method@Portal.update_monitor_stop] to stop monitoring. a [class@Portal] options for this cal.. optional [class@Gio.Cancellable] a callback to call when the request is done data to pass to @callback Finishes an update-monitor request. Returns the result in the form of boolean. `TRUE` if the request succeeded a [class@Portal] a [iface@Gio.AsyncResult] Stops update monitoring that was started with [method@Portal.update_monitor_start]. a [class@Portal] Emitted when location monitoring is enabled and the location changes. the latitude, in degrees the longitude, in degrees the altitude, in meters the accuracy, in meters the speed, in meters per second the heading, in degrees the description the timestamp seconds since the Unix epoch the microseconds fraction of the timestamp Emitted when a non-exported action is activated on a notification. the notification ID the action name the target parameter for the action Emitted when session state monitoring is enabled and the state of the login session changes or the screensaver is activated or deactivated. whether the screensaver is active the current state of the login session Emitted when a process that was spawned with [method@Portal.spawn] exits. the pid of the process the exit status of the process Emitted when updates monitoring is enabled and a new update is available. It is only sent once with the same information, but it can be sent many times if new updates appear. the commit that the sandbox is running with the commit that is currently deployed. Restarting the app will use this commit the commit that is available as an update. Updating the app will deloy this commit Emitted to indicate progress of an update installation. It is undefined exactly how often it is sent, but it will be emitted at least once at the end with a non-zero @status. For each successful operation in the update, we're also guaranteed to send exactly one signal with @progress 100. the number of operations that the update consists of the position of the currently active operation the progress of the currently active operation, as a number between 0 and 100 the overall status of the update the error name if the status is 'failed' the error message if the status is 'failed' Options for starting remote desktop sessions. No options allow opening multiple streams Options for starting screen casts. No options allow opening multiple streams A representation of long-lived screencast portal interactions. The XdpSession object is used to represent portal interactions with the screencast or remote desktop portals that extend over multiple portal calls. To find out what kind of session an XdpSession object represents and whether it is still active, you can use [method@Session.get_session_type] and [method@Session.get_session_state]. All sessions start in an initial state. They can be made active by calling [method@Session.start], and ended by calling [method@Session.close]. Closes the session. an active [class@Session] Connect this XdpRemoteDesktopSession to an EIS implementation and return the fd. This fd can be passed into ei_setup_backend_fd(). See the libei documentation for details. This call must be issued before xdp_session_start(). If successful, all input event emulation must be handled via the EIS connection and calls to xdp_session_pointer_motion() etc. are silently ignored. the file descriptor to the EIS implementation a [class@Session] Obtains the devices that the user selected. Unless the session is active, this function returns `XDP_DEVICE_NONE`. the selected devices a [class@Session] Retrieves the effective persist mode of @session. May only be called after @session is successfully started, i.e. after [method@Session.start_finish]. the effective persist mode of @session a [class@Session] Retrieves the restore token of @session. A restore token will only be available if `XDP_PERSIST_MODE_TRANSIENT` or `XDP_PERSIST_MODE_PERSISTENT` was passed when creating the screencast session. Remote desktop sessions cannot be restored. May only be called after @session is successfully started, i.e. after [method@Session.start_finish]. the restore token of @session a [class@Session] Obtains information about the state of the session that is represented by @session. the state of @session an [class@Session] Obtains information about the type of session that is represented by @session. the type of @session an [class@Session] Obtains the streams that the user selected. The information in the returned [struct@GLib.Variant] has the format `a(ua{sv})`. Each item in the array is describing a stream. The first member is the pipewire node ID, the second is a dictionary of stream properties, including: - position, `(ii)`: a tuple consisting of the position `(x, y)` in the compositor coordinate space. Note that the position may not be equivalent to a position in a pixel coordinate space. Only available for monitor streams. - size, `(ii)`: a tuple consisting of (width, height). The size represents the size of the stream as it is displayed in the compositor coordinate space. Note that this size may not be equivalent to a size in a pixel coordinate space. The size may differ from the size of the stream. Unless the session is active, this function returns `NULL`. the selected streams a [class@Session] Changes the state of the key to @state. May only be called on a remote desktop session with `XDP_DEVICE_KEYBOARD` access. a remote desktop [class@Session] whether to interpret @key as a keysym instead of a keycode the keysym or keycode to change the new state Opens a file descriptor to the pipewire remote where the screencast streams are available. The file descriptor should be used to create a pw_remote object, by using pw_remote_connect_fd(). Only the screencast stream nodes will be available from this pipewire node. the file descriptor a [class@Session] The axis movement from a smooth scroll device, such as a touchpad. When applicable, the size of the motion delta should be equivalent to the motion vector of a pointer motion done using the same advice. May only be called on a remote desktop session with `XDP_DEVICE_POINTER` access. a [class@Session] whether this is the last in a series of related events relative axis movement on the X axis relative axis movement on the Y axis The axis movement from a discrete scroll device. May only be called on a remote desktop session with `XDP_DEVICE_POINTER` access. a [class@Session] the axis to change number of steps scrolled Changes the state of the button to @state. May only be called on a remote desktop session with `XDP_DEVICE_POINTER` access. a [class@Session] the button the new state Moves the pointer from its current position. May only be called on a remote desktop session with `XDP_DEVICE_POINTER` access. a [class@Session] relative horizontal movement relative vertical movement Moves the pointer to a new position in the given streams logical coordinate space. May only be called on a remote desktop session with `XDP_DEVICE_POINTER` access. a [class@Session] the node ID of the pipewire stream the position is relative to new X position new Y position Starts the session. When the request is done, @callback will be called. You can then call [method@Session.start_finish] to get the results. a [class@Session] in initial state parent window information optional [class@Gio.Cancellable] a callback to call when the request is done data to pass to @callback Finishes the session-start request. `TRUE` if the session was started successfully. a [class@Session] a [iface@Gio.AsyncResult] Notify about a new touch down event. The `(x, y)` position represents the new touch point position in the streams logical coordinate space. May only be called on a remote desktop session with `XDP_DEVICE_TOUCHSCREEN` access. a [class@Session] the node ID of the pipewire stream the position is relative to touch slot where the touch point appeared new X position new Y position Notify about a new touch motion event. The `(x, y)` position represents where the touch point position in the streams logical coordinate space moved. May only be called on a remote desktop session with `XDP_DEVICE_TOUCHSCREEN` access. a [class@Session] the node ID of the pipewire stream the position is relative to touch slot that is changing position new X position new Y position Notify about a new touch up event. May only be called on a remote desktop session with `XDP_DEVICE_TOUCHSCREEN` access. a [class@Session] touch slot that changed Emitted when a session is closed externally. The state of a session. the session has not been started. the session is active. the session is no longer active. The type of a session. a screencast session. a remote desktop session. an input capture session. A representation of the settings exposed by the portal. The [class@Settings] object is used to access and observe the settings exposed by xdg-desktop-portal. It is obtained from [method@Portal.get_settings]. Call [method@Settings.read_value] to read a settings value. Connect to [signal@Settings::changed] to observe value changes. Read a setting value within @namespace, with @key. A convenience function that combines xdp_settings_read_value() with g_variant_get(). In case of error, if @error is not NULL, then the error is returned. the [class@Settings] object. the namespace of the value. the key of the value. a GCancellable or NULL. return location for error or NULL. a #GVariant format string arguments as per @format Read all the setting values within @namespace. a value containing all the values, or %NULL if not found. If @error is not NULL, then the error is returned. the [class@Settings] object. List of namespaces to filter results by, supports simple globbing explained below. a GCancellable or NULL. Read a setting value as unsigned int within @namespace, with @key. the stringint value, or NULL if not found or not the right type. If @error is not NULL, then the error is returned. the [class@Settings] object. the namespace of the value. the key of the value. a GCancellable or NULL. Read a setting value as unsigned int within @namespace, with @key. the uint value, or 0 if not found or not the right type. If @error is not NULL, then the error is returned. the [class@Settings] object. the namespace of the value. the key of the value. a GCancellable or NULL. Read a setting value within @namespace, with @key. the value, or %NULL if not found. If @error is not NULL, then the error is returned. the [class@Settings] object. the namespace of the value. the key of the value. a GCancellable or NULL. Emitted when a setting value is changed externally. the value namespace the value key the value Flags influencing the spawn operation and how the new sandbox is created. No flags Clear the environment Spawn the latest version of the app Spawn in a sandbox (equivalent to the --sandbox option of flatpak run) Spawn without network (equivalent to the --unshare=network option of flatpak run) Kill the sandbox when the caller disappears from the session bus The values of this enum are returned in the [signal@Portal::update-progress] signal to indicate the current progress of an installation. Installation in progress Nothing to install Installation finished successfully Installation failed The values of this enumeration determine where the wallpaper is being set. No flags Set wallpaper on the desktop background Set wallpaper on the lockscreen Request the preview to be shown