Libportal

https://libportal.org
Admin
Libportal is a library providing GIO-style asynchronous API wrappers for D-Bus portal APIs, enabling...
Tokens:63,662
Snippets:962
Trust Score:6.3
Update:2 days ago
Show doc for...
Tokens:
Raw
### xdp_session_start

Source: https://libportal.org/class.Session.html

Starts the session.

```APIDOC
## xdp_session_start

### Description
Starts the session.

### Method
Instance method

### Signature
void xdp_session_start (XdpSession* session, GCancellable* cancellable, GAsyncReadyCallback callback, gpointer user_data);

### Parameters
- **session** (XdpSession*) - The session.
- **cancellable** (GCancellable*) - A cancellable object, or NULL.
- **callback** (GAsyncReadyCallback) - A callback to call when the request is finished.
- **user_data** (gpointer) - User data to pass to the callback.

```

--------------------------------

### xdp_input_capture_session_start

Source: https://libportal.org/class.InputCaptureSession.html

Starts the input capture session.

```APIDOC
## xdp_input_capture_session_start

### Description
Start the input capture session.

### Method
start

### Parameters
None documented.

### Returns
None documented.
```

--------------------------------

### xdp_portal_dynamic_launcher_get_desktop_entry

Source: https://libportal.org/class.Portal.html

This function gets the contents of a .desktop file that was previously installed by the dynamic launcher portal.

```APIDOC
## xdp_portal_dynamic_launcher_get_desktop_entry

### Description
This function gets the contents of a .desktop file that was previously installed by the dynamic launcher portal.

### Method
Instance method

### Parameters
None

### Returns
The contents of the .desktop file.
```

--------------------------------

### xdp_portal_dynamic_launcher_prepare_install

Source: https://libportal.org/class.Portal.html

Presents a dialog to the user so they can confirm they want to install a launcher to their desktop.

```APIDOC
## xdp_portal_dynamic_launcher_prepare_install

### Description
Presents a dialog to the user so they can confirm they want to install a launcher to their desktop.

### Method
Instance method

### Parameters
None

### Returns
None
```

--------------------------------

### xdp_portal_session_monitor_start

Source: https://libportal.org/class.Portal.html

Makes XdpPortal start monitoring the login session state.

```APIDOC
## xdp_portal_session_monitor_start

### Description
Makes XdpPortal start monitoring the login session state.

```

--------------------------------

### xdp_portal_dynamic_launcher_request_install_token

Source: https://libportal.org/class.Portal.html

Requests a token which can be passed to xdp_portal_dynamic_launcher_install() to complete installation of the launcher without user interaction.

```APIDOC
## xdp_portal_dynamic_launcher_request_install_token

### Description
Requests a token which can be passed to xdp_portal_dynamic_launcher_install() to complete installation of the launcher without user interaction.

### Method
Instance method

### Parameters
None

### Returns
A token for installation.
```

--------------------------------

### xdp_portal_update_monitor_start

Source: https://libportal.org/class.Portal.html

Makes XdpPortal start monitoring for available software updates.

```APIDOC
## xdp_portal_update_monitor_start

### Description
Makes XdpPortal start monitoring for available software updates.

```

--------------------------------

### xdp_portal_dynamic_launcher_install

Source: https://libportal.org/class.Portal.html

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.

```APIDOC
## xdp_portal_dynamic_launcher_install

### Description
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.

### Method
Instance method

### Parameters
None

### Returns
None
```

--------------------------------

### xdp_portal_update_install

Source: https://libportal.org/class.Portal.html

Installs an available software update.

```APIDOC
## xdp_portal_update_install

### Description
Installs an available software update.

```

--------------------------------

### xdp_portal_location_monitor_start

Source: https://libportal.org/class.Portal.html

Makes XdpPortal start monitoring location changes.

```APIDOC
## xdp_portal_location_monitor_start

### Description
Makes XdpPortal start monitoring location changes.

```

--------------------------------

### xdp_portal_prepare_print

Source: https://libportal.org/class.Portal.html

Presents a print dialog to the user and returns print settings and page setup.

```APIDOC
## xdp_portal_prepare_print

### Description
Presents a print dialog to the user and returns print settings and page setup.

```

--------------------------------

### xdp_portal_update_install_finish

Source: https://libportal.org/method.Portal.update_install_finish.html

Finishes an update-installation request. Returns a boolean indicating whether the update is being installed. The installation may not be complete when this function returns; listen to the XdpPortal::update-progress signal for completion.

```APIDOC
## xdp_portal_update_install_finish

### Description
Finishes an update-installation request. Returns the result in the form of a boolean. Note that the update may not be completely installed by the time this function is called; you need to listen to the XdpPortal::update-progress signal to learn when the installation is complete.

### Declaration
```c
gboolean
xdp_portal_update_install_finish (
  XdpPortal* portal,
  GAsyncResult* result,
  GError** error
)
```

### Parameters
- **portal** (XdpPortal*) - The portal object. (Not explicitly documented in source, but implied by the declaration.)
- **result** (GAsyncResult) - A GAsyncResult. The data is owned by the caller of the method.
- **error** (GError**) - The return location for a recoverable error. The argument can be NULL. If not NULL, initialize it to a NULL GError*. On error, it will be set to a newly allocated GError; the caller takes ownership and is responsible for freeing it.

### Return Value
- **gboolean** - TRUE if the update is being installed.
```

--------------------------------

### xdp_portal_update_install

Source: https://libportal.org/method.Portal.update_install.html

Installs an available software update asynchronously. This method should be called in response to the XdpPortal::update-available signal and will emit progress via the XdpPortal::update-progress signal. Use xdp_portal_update_install_finish() in the callback to obtain the result.

```APIDOC
## xdp_portal_update_install

### Description
Installs an available software update. This should be called in response to a XdpPortal::update-available signal. During the update installation, the XdpPortal::update-progress signal will be emitted to provide progress information. This method completes asynchronously. Use xdp_portal_update_install_finish() inside the GAsyncReadyCallback to obtain the result of the operation.

### Declaration
```c
void
xdp_portal_update_install (
  XdpPortal* portal,
  XdpParent* parent,
  XdpUpdateInstallFlags flags,
  GCancellable* cancellable,
  GAsyncReadyCallback callback,
  gpointer data
)
```

### Parameters
- **portal** (XdpPortal*) - The portal object.
- **parent** (XdpParent) - A XdpParent. The data is owned by the caller of the method.
- **flags** (XdpUpdateInstallFlags) - Options for this call.
- **cancellable** (GCancellable) - Optional GCancellable. The argument can be NULL. The data is owned by the caller of the method.
- **callback** (GAsyncReadyCallback) - A callback to call when the request is done. The argument can be NULL.
- **data** (gpointer) - Data to pass to callback. The argument can be NULL. The data is owned by the caller of the method.

### Return Value
This method completes asynchronously. Use xdp_portal_update_install_finish() inside the GAsyncReadyCallback to obtain the result of the operation.
```

--------------------------------

### xdp_session_start

Source: https://libportal.org/method.Session.start.html

Starts the session asynchronously. The callback is invoked when the request is done, and the result can be obtained with xdp_session_start_finish().

```APIDOC
## xdp_session_start

### Description
Starts the session. When the request is done, `callback` will be called. You can then call `xdp_session_start_finish()` to get the results. This method completes asynchronously.

### Declaration
```c
void
xdp_session_start (
  XdpSession* session,
  XdpParent* parent,
  GCancellable* cancellable,
  GAsyncReadyCallback callback,
  gpointer data
)
```

### Parameters
- **session** (XdpSession*) - The session to start.
- **parent** (XdpParent*) - Parent window information. Can be NULL. The data is owned by the caller.
- **cancellable** (GCancellable*) - Optional GCancellable. Can be NULL. The data is owned by the caller.
- **callback** (GAsyncReadyCallback) - A callback to call when the request is done. Can be NULL.
- **data** (gpointer) - Data to pass to callback. Can be NULL. The data is owned by the caller.

### Return Value
None (void).

### Notes
- The operation is asynchronous. Use `xdp_session_start_finish()` inside the `GAsyncReadyCallback` to obtain the result.
```

--------------------------------

### xdp_input_capture_session_start_finish

Source: https://libportal.org/class.InputCaptureSession.html

Finishes the InputCapture Start request and returns TRUE if it was successful.

```APIDOC
## xdp_input_capture_session_start_finish

### Description
Finishes the InputCapture Start request, and returns TRUE if it was successful.

### Method
start_finish

### Parameters
None documented.

### Returns
Boolean - TRUE if successful, FALSE otherwise.
```

--------------------------------

### xdp_input_capture_session_start

Source: https://libportal.org/method.InputCaptureSession.start.html

Starts an input capture session asynchronously. When the operation completes, the provided callback is invoked, and the result can be obtained by calling xdp_input_capture_session_start_finish().

```APIDOC
## xdp_input_capture_session_start

### Description
Starts an input capture session. This method completes asynchronously. When the request is done, the callback will be called. You can then call xdp_input_capture_session_start_finish() to get the results.

### Declaration
```c
void
xdp_input_capture_session_start (
  XdpInputCaptureSession* session,
  XdpParent* parent,
  XdpInputCapability capabilities,
  GCancellable* cancellable,
  GAsyncReadyCallback callback,
  gpointer data
)
```

### Parameters
- **session** (XdpInputCaptureSession*) - The input capture session object.
- **parent** (XdpParent*) - Parent window information. Can be NULL. The data is owned by the caller.
- **capabilities** (XdpInputCapability) - Which kinds of capabilities to request.
- **cancellable** (GCancellable*) - Optional GCancellable. Can be NULL. The data is owned by the caller.
- **callback** (GAsyncReadyCallback) - A callback to call when the request is done. Can be NULL.
- **data** (gpointer) - Data to pass to callback. Can be NULL. The data is owned by the caller.

### Return Value
This function does not return a value. The result of the asynchronous operation is obtained by calling xdp_input_capture_session_start_finish() inside the callback.
```

--------------------------------

### xdp_portal_create_input_capture_session2_finish

Source: https://libportal.org/method.Portal.create_input_capture_session2_finish.html

Finishes the InputCapture CreateSession2 method call and returns a new XdpInputCaptureSession. The session is inactive and must be started with InputCaptureSession.start.

```APIDOC
## xdp_portal_create_input_capture_session2_finish

### Description
Finishes the InputCapture CreateSession2 method call, and returns a XdpInputCaptureSession. To get to the XdpSession within use xdp_input_capture_session_get_session(). The created session is inactive, and must be started with InputCaptureSession.start.

### Declaration
```c
XdpInputCaptureSession*
xdp_portal_create_input_capture_session2_finish (
  XdpPortal* portal,
  GAsyncResult* result,
  GError** error
)
```

### Parameters
- **portal** (XdpPortal*) - The portal object.
- **result** (GAsyncResult*) - A GAsyncResult. The data is owned by the caller of the method.
- **error** (GError**) - The return location for a recoverable error. The argument can be NULL. If the return location is not NULL, then you must initialize it to a NULL GError*. The argument will be left initialized to NULL by the method if there are no errors. In case of error, the argument will be set to a newly allocated GError; the caller will take ownership of the data, and be responsible for freeing it.

### Return Value
- **XdpInputCaptureSession*** - A XdpInputCaptureSession. The caller of the method takes ownership of the returned data, and is responsible for freeing it.
```

--------------------------------

### xdp_portal_create_global_shortcuts_session_finish

Source: https://libportal.org/class.Portal.html

Finishes the GlobalShortcuts CreateSession request, and returns a XdpGlobalShortcutsSession. To get to the XdpSession within use xdp_global_shortcuts_session_get_session().

```APIDOC
## xdp_portal_create_global_shortcuts_session_finish

### Description
Finishes the GlobalShortcuts CreateSession request, and returns a XdpGlobalShortcutsSession. To get to the XdpSession within use xdp_global_shortcuts_session_get_session().

### Method
Instance method

### Parameters
None

### Returns
A XdpGlobalShortcutsSession.
```

--------------------------------

### XdpRemoteDesktopFlags

Source: https://libportal.org/flags.RemoteDesktopFlags.html

Enumeration defining options for starting remote desktop sessions. Members include XDP_REMOTE_DESKTOP_FLAG_NONE (value 0) and XDP_REMOTE_DESKTOP_FLAG_MULTIPLE (value 1), both available since version 1.0.

```APIDOC
## XdpRemoteDesktopFlags

### Description
Options for starting remote desktop sessions.

### Declaration
```
flags Xdp.RemoteDesktopFlags
```

### Members

#### XDP_REMOTE_DESKTOP_FLAG_NONE
- **Value**: 0
- **Available since**: 1.0
- **Description**: No options.

#### XDP_REMOTE_DESKTOP_FLAG_MULTIPLE
- **Value**: 1
- **Available since**: 1.0
- **Description**: Allow opening multiple streams.
```

--------------------------------

### xdp_portal_prepare_print_finish

Source: https://libportal.org/method.Portal.prepare_print_finish.html

Finishes the prepare-print request. Returns a GVariant dictionary with print settings, page setup, and a token for use in a subsequent print_file call.

```APIDOC
## xdp_portal_prepare_print_finish

### Description
Finishes the prepare-print request. Returns a GVariant 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 be used in a xdp_portal_print_file() call to avoid the print dialog.

### Method
Function

### Signature
GVariant* xdp_portal_prepare_print_finish (XdpPortal* portal, GAsyncResult* result, GError** error)

### Parameters
- **portal** (XdpPortal*) - The portal object.
- **result** (GAsyncResult*) - A GAsyncResult. The data is owned by the caller of the method.
- **error** (GError**) - The return location for a recoverable error. The argument can be NULL. If the return location is not NULL, then you must initialize it to a NULL GError*. The argument will be left initialized to NULL by the method if there are no errors. In case of error, the argument will be set to a newly allocated GError; the caller will take ownership of the data, and be responsible for freeing it.

### Return Value
- **GVariant** - A GVariant dictionary with print information. The caller of the method takes ownership of the returned data, and is responsible for freeing it.
```

--------------------------------

### xdp_portal_dynamic_launcher_get_icon

Source: https://libportal.org/class.Portal.html

This function gets the icon associated with a .desktop file that was previously installed by the dynamic launcher portal.

```APIDOC
## xdp_portal_dynamic_launcher_get_icon

### Description
This function gets the icon associated with a .desktop file that was previously installed by the dynamic launcher portal.

### Method
Instance method

### Parameters
None

### Returns
The icon associated with the .desktop file.
```

--------------------------------

### xdp_portal_dynamic_launcher_prepare_install_finish

Source: https://libportal.org/class.Portal.html

Finishes the prepare-install-launcher request, and returns GVariant dictionary with the following information:.

```APIDOC
## xdp_portal_dynamic_launcher_prepare_install_finish

### Description
Finishes the prepare-install-launcher request, and returns GVariant dictionary with the following information:.

### Method
Instance method

### Parameters
None

### Returns
A GVariant dictionary with the following information:.
```

--------------------------------

### xdp_portal_get_user_information

Source: https://libportal.org/class.Portal.html

Gets information about the user.

```APIDOC
## xdp_portal_get_user_information

### Description
Gets information about the user.

```

--------------------------------

### xdp_portal_dynamic_launcher_launch

Source: https://libportal.org/class.Portal.html

No description available.

```APIDOC
## xdp_portal_dynamic_launcher_launch

### Description
No description available.

### Method
Instance method

### Parameters
None

### Returns
None
```

--------------------------------

### xdp_portal_dynamic_launcher_launch

Source: https://libportal.org/method.Portal.dynamic_launcher_launch.html

Launches a dynamic launcher using the provided desktop file ID and activation token. Returns a gboolean indicating success or failure.

```APIDOC
## xdp_portal_dynamic_launcher_launch

### Description
Launches a dynamic launcher using the provided desktop file ID and activation token. Returns a gboolean indicating success or failure.

### Declaration
```c
gboolean
xdp_portal_dynamic_launcher_launch (
  XdpPortal* portal,
  const char* desktop_file_id,
  const char* activation_token,
  GError** error
)
```

### Parameters
- **portal** (XdpPortal*) - The portal object.
- **desktop_file_id** (const char*) - The desktop file ID. The data is owned by the caller of the method. The value is a NUL terminated UTF-8 string.
- **activation_token** (const char*) - The activation token. The data is owned by the caller of the method. The value is a NUL terminated UTF-8 string.
- **error** (GError**) - The return location for a recoverable error. The argument can be NULL. If the return location is not NULL, then you must initialize it to a NULL GError*. The argument will be left initialized to NULL by the method if there are no errors. In case of error, the argument will be set to a newly allocated GError; the caller will take ownership of the data, and be responsible for freeing it.

### Return Value
- **gboolean** - No description available.
```

--------------------------------

### xdp_portal_update_monitor_stop

Source: https://libportal.org/class.Portal.html

Stops update monitoring that was started with xdp_portal_update_monitor_start().

```APIDOC
## xdp_portal_update_monitor_stop

### Description
Stops update monitoring that was started with xdp_portal_update_monitor_start().

```

--------------------------------

### xdp_portal_location_monitor_stop

Source: https://libportal.org/class.Portal.html

Stops location monitoring that was started with xdp_portal_location_monitor_start().

```APIDOC
## xdp_portal_location_monitor_stop

### Description
Stops location monitoring that was started with xdp_portal_location_monitor_start().

```

--------------------------------

### xdp_portal_spawn

Source: https://libportal.org/class.Portal.html

Creates a new copy of the applications sandbox, and runs a process in, with the given arguments.

```APIDOC
## xdp_portal_spawn

### Description
Creates a new copy of the applications sandbox, and runs a process in, with the given arguments.

```

--------------------------------

### xdp_portal_session_monitor_stop

Source: https://libportal.org/class.Portal.html

Stops session state monitoring that was started with xdp_portal_session_monitor_start().

```APIDOC
## xdp_portal_session_monitor_stop

### Description
Stops session state monitoring that was started with xdp_portal_session_monitor_start().

```

--------------------------------

### xdp_global_shortcut_new

Source: https://libportal.org/struct.GlobalShortcut.html

Constructor for creating a new XdpGlobalShortcut instance. No description available in the source.

```APIDOC
## xdp_global_shortcut_new

### Description
No description available.

### Method
Constructor

### Signature
xdp_global_shortcut_new
```

--------------------------------

### xdp_portal_create_global_shortcuts_session

Source: https://libportal.org/class.Portal.html

Creates a session for global shortcuts.

```APIDOC
## xdp_portal_create_global_shortcuts_session

### Description
Creates a session for global shortcuts.

### Method
Instance method

### Parameters
None

### Returns
None
```

--------------------------------

### xdp_session_get_selection_mime_types

Source: https://libportal.org/class.Session.html

Get the currently advertised mime types of the current clipboard selection owner.

```APIDOC
## xdp_session_get_selection_mime_types

### Description
Get the currently advertised mime types of the current clipboard selection owner.

### Method
Instance method

### Signature
char** xdp_session_get_selection_mime_types (XdpSession* session);

### Parameters
- **session** (XdpSession*) - The session.

### Returns
- **char*** - A NULL-terminated array of mime type strings.

```

--------------------------------

### xdp_portal_set_wallpaper_finish

Source: https://libportal.org/class.Portal.html

Finishes the open-uri request.

```APIDOC
## xdp_portal_set_wallpaper_finish

### Description
Finishes the open-uri request.

```

--------------------------------

### xdp_global_shortcuts_session_configure_shortcuts

Source: https://libportal.org/class.GlobalShortcutsSession.html

Requests that the portal show configuration UI for all shortcuts of this session.

```APIDOC
## xdp_global_shortcuts_session_configure_shortcuts

### Description
Requests that the portal show configuration UI for all shortcuts of this session.

### Method
ConfigureShortcuts

### Parameters
No parameters documented.

### Response
No response documented.
```

--------------------------------

### xdp_portal_create_remote_desktop_session_finish

Source: https://libportal.org/class.Portal.html

Finishes the create-remote-desktop request, and returns a XdpSession.

```APIDOC
## xdp_portal_create_remote_desktop_session_finish

### Description
Finishes the create-remote-desktop request, and returns a XdpSession.

### Method
Instance method

### Parameters
None

### Returns
A XdpSession.
```

--------------------------------

### XdpUpdateStatus Enumeration

Source: https://libportal.org/enum.UpdateStatus.html

Enumeration values returned in the XdpPortal::update-progress signal to indicate the current progress of an installation.

```APIDOC
## XdpUpdateStatus Enumeration

### Description
The values of this enum are returned in the XdpPortal::update-progress signal to indicate the current progress of an installation.

### Members

- **XDP_UPDATE_STATUS_RUNNING** (Value: 0) - Installation in progress. Available since: 1.0
- **XDP_UPDATE_STATUS_EMPTY** (Value: 1) - Nothing to install. Available since: 1.0
- **XDP_UPDATE_STATUS_DONE** (Value: 2) - Installation finished successfully. Available since: 1.0
- **XDP_UPDATE_STATUS_FAILED** (Value: 3) - Installation failed. Available since: 1.0
```

--------------------------------

### xdp_portal_create_global_shortcuts_session

Source: https://libportal.org/method.Portal.create_global_shortcuts_session.html

Creates a session for global shortcuts asynchronously. When the request completes, the provided callback is invoked, and the result can be retrieved using xdp_portal_create_global_shortcuts_session_finish().

```APIDOC
## xdp_portal_create_global_shortcuts_session

### Description
Creates a session for global shortcuts. This method completes asynchronously. When the request is done, the callback will be called. You can then call xdp_portal_create_global_shortcuts_session_finish() to get the results.

### Method
Asynchronous function

### Signature
void xdp_portal_create_global_shortcuts_session (XdpPortal* portal, GCancellable* cancellable, GAsyncReadyCallback callback, gpointer data)

### Parameters
- **portal** (XdpPortal*) - The portal object.
- **cancellable** (GCancellable*) - Optional. A cancellable object. Can be NULL. The data is owned by the caller.
- **callback** (GAsyncReadyCallback) - A callback to call when the request is done. Can be NULL.
- **data** (gpointer) - Data to pass to callback. Can be NULL. The data is owned by the caller.

### Return Value
This function does not return a value directly. The result is obtained by calling xdp_portal_create_global_shortcuts_session_finish() inside the GAsyncReadyCallback.
```

--------------------------------

### xdp_portal_create_input_capture_session_finish

Source: https://libportal.org/class.Portal.html

Finishes the InputCapture CreateSession request, and returns a XdpInputCaptureSession. To get to the XdpSession within use xdp_input_capture_session_get_session().

```APIDOC
## xdp_portal_create_input_capture_session_finish

### Description
Finishes the InputCapture CreateSession request, and returns a XdpInputCaptureSession. To get to the XdpSession within use xdp_input_capture_session_get_session().

### Method
Instance method

### Parameters
None

### Returns
A XdpInputCaptureSession.
```

--------------------------------

### xdp_portal_create_remote_desktop_session_full

Source: https://libportal.org/class.Portal.html

Creates a session for remote desktop.

```APIDOC
## xdp_portal_create_remote_desktop_session_full

### Description
Creates a session for remote desktop.

### Method
Instance method

### Parameters
None

### Returns
None
```

--------------------------------

### xdp_global_shortcut_get_description

Source: https://libportal.org/method.GlobalShortcut.get_description.html

Retrieves the description of a global shortcut. The returned string is owned by the instance and is a NUL terminated UTF-8 string.

```APIDOC
## xdp_global_shortcut_get_description

### Description
Retrieves the description of a global shortcut. The returned string is owned by the instance and is a NUL terminated UTF-8 string.

### Declaration
```c
const char*
xdp_global_shortcut_get_description (
  const XdpGlobalShortcut* shortcut
)
```

### Parameters
- **shortcut** (const XdpGlobalShortcut*) - The global shortcut object.

### Return Value
- **const char*** - The description of the shortcut. The returned data is owned by the instance. The value is a NUL terminated UTF-8 string.
```

--------------------------------

### xdp_input_capture_session_set_restore_token

Source: https://libportal.org/class.InputCaptureSession.html

Sets the restore token for the session about to be started. This instructs the portal to restore the previous session identified by this token.

```APIDOC
## xdp_input_capture_session_set_restore_token

### Description
Sets the restore token for the session about to be started. This instructs the portal to restore the previous session identified by this token.

### Method
set_restore_token

### Parameters
None documented.

### Returns
None documented.
```

--------------------------------

### XdpScreencastFlags Enumeration

Source: https://libportal.org/flags.ScreencastFlags.html

Enumeration defining options for starting screen casts. Members: XDP_SCREENCAST_FLAG_NONE (0) and XDP_SCREENCAST_FLAG_MULTIPLE (1).

```APIDOC
## XdpScreencastFlags

### Description
Options for starting screen casts.

### Members

- **XDP_SCREENCAST_FLAG_NONE** (integer) - No options. Value: 0. Available since: 1.0.
- **XDP_SCREENCAST_FLAG_MULTIPLE** (integer) - Allow opening multiple streams. Value: 1. Available since: 1.0.
```

--------------------------------

### xdp_portal_request_background()

Source: https://libportal.org/libportal.html

The Background portal lets applications request background permissions such as enabling autostart. This function is the libportal wrapper for the org.freedesktop.portal.Background D-Bus interface.

```APIDOC
## xdp_portal_request_background()

### Description
Requests background permissions such as enabling autostart.

### Method
Function call

### Endpoint
xdp_portal_request_background()

### Parameters
None documented.

### Response
Returns the result of the background permission request asynchronously via GIO-style callback.
```

--------------------------------

### xdp_portal_create_input_capture_session2_finish

Source: https://libportal.org/class.Portal.html

Finishes the InputCapture CreateSession2 method call, and returns a XdpInputCaptureSession. To get to the XdpSession within use xdp_input_capture_session_get_session().

```APIDOC
## xdp_portal_create_input_capture_session2_finish

### Description
Finishes the InputCapture CreateSession2 method call, and returns a XdpInputCaptureSession. To get to the XdpSession within use xdp_input_capture_session_get_session().

### Method
Instance method

### Parameters
None

### Returns
A XdpInputCaptureSession.
```

--------------------------------

### xdp_input_capture_session_set_pointer_barriers

Source: https://libportal.org/class.InputCaptureSession.html

Sets the pointer barriers for this session. When the request is done, callback will be called. You can then call xdp_input_capture_session_set_pointer_barriers_finish() to get the results.

```APIDOC
## xdp_input_capture_session_set_pointer_barriers

### Description
Sets the pointer barriers for this session. When the request is done, callback will be called. You can then call xdp_input_capture_session_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.

### Method
set_pointer_barriers

### Parameters
None documented.

### Returns
None documented.
```

--------------------------------

### xdp_portal_update_install_finish

Source: https://libportal.org/class.Portal.html

Finishes an update-installation request.

```APIDOC
## xdp_portal_update_install_finish

### Description
Finishes an update-installation request.

```

--------------------------------

### xdp_global_shortcuts_session_configure_shortcuts

Source: https://libportal.org/method.GlobalShortcutsSession.configure_shortcuts.html

Requests that the portal show configuration UI for all shortcuts of this session. This method completes asynchronously; use xdp_global_shortcuts_session_configure_shortcuts_finish() inside the GAsyncReadyCallback to obtain the result.

```APIDOC
## xdp_global_shortcuts_session_configure_shortcuts

### Description
Requests that the portal show configuration UI for all shortcuts of this session. This method completes asynchronously. Use xdp_global_shortcuts_session_configure_shortcuts_finish() inside the GAsyncReadyCallback to obtain the result of the operation.

### Method
Asynchronous function

### Signature
void xdp_global_shortcuts_session_configure_shortcuts (XdpGlobalShortcutsSession* session, const char* parent_window, const char* activation_token, GCancellable* cancellable, GAsyncReadyCallback callback, gpointer data)

### Parameters
- **session** (XdpGlobalShortcutsSession*) - The session object.
- **parent_window** (const char*) - Parent window identifier. Can be NULL. NUL terminated UTF-8 string. Owned by caller.
- **activation_token** (const char*) - Token used to activate the configuration window. Can be NULL. NUL terminated UTF-8 string. Owned by caller.
- **cancellable** (GCancellable*) - Optional GCancellable. Can be NULL. Owned by caller.
- **callback** (GAsyncReadyCallback) - Callback called when the method call is done. Can be NULL.
- **data** (gpointer) - Data to pass to callback. Can be NULL. Owned by caller.

### Return Value
This method completes asynchronously. The result is obtained via xdp_global_shortcuts_session_configure_shortcuts_finish().
```

--------------------------------

### xdp_global_shortcuts_session_list_shortcuts

Source: https://libportal.org/class.GlobalShortcutsSession.html

List currently registered shortcuts and triggers.

```APIDOC
## xdp_global_shortcuts_session_list_shortcuts

### Description
List currently registered shortcuts and triggers.

### Method
ListShortcuts

### Parameters
No parameters documented.

### Response
No response documented.
```

--------------------------------

### xdp_portal_access_camera

Source: https://libportal.org/method.Portal.access_camera.html

Requests access to a camera asynchronously. When the request is done, the provided callback will be called. Use xdp_portal_access_camera_finish() to get the results.

```APIDOC
## xdp_portal_access_camera

### Description
Requests access to a camera. When the request is done, `callback` will be called. You can then call `xdp_portal_access_camera_finish()` to get the results. This method completes asynchronously.

### Declaration
```c
void
xdp_portal_access_camera (
  XdpPortal* portal,
  XdpParent* parent,
  XdpCameraFlags flags,
  GCancellable* cancellable,
  GAsyncReadyCallback callback,
  gpointer data
)
```

### Parameters
- **portal** (XdpPortal*) - The portal object.
- **parent** (XdpParent*) - Parent window information. Can be NULL. Data is owned by the caller.
- **flags** (XdpCameraFlags) - Options for this call.
- **cancellable** (GCancellable*) - Optional cancellable. Can be NULL. Data is owned by the caller.
- **callback** (GAsyncReadyCallback) - A callback to call when the request is done. Can be NULL.
- **data** (gpointer) - Data to pass to callback. Can be NULL. Data is owned by the caller.

### Return Value
This method completes asynchronously. Use `xdp_portal_access_camera_finish()` inside the `GAsyncReadyCallback` to obtain the result of the operation.
```

--------------------------------

### xdp_portal_dynamic_launcher_uninstall

Source: https://libportal.org/class.Portal.html

This function uninstalls a launcher that was previously installed using the dynamic launcher portal, resulting in the .desktop file and icon being deleted.

```APIDOC
## xdp_portal_dynamic_launcher_uninstall

### Description
This function uninstalls a launcher that was previously installed using the dynamic launcher portal, resulting in the .desktop file and icon being deleted.

### Method
Instance method

### Parameters
None

### Returns
None
```

--------------------------------

### xdp_portal_create_remote_desktop_session_full

Source: https://libportal.org/method.Portal.create_remote_desktop_session_full.html

Asynchronously creates a remote desktop session. The callback is called when the request is done, and the result can be retrieved with xdp_portal_create_remote_desktop_session_finish().

```APIDOC
## xdp_portal_create_remote_desktop_session_full

### Description
Creates a session for remote desktop. When the request is done, callback will be called. You can then call xdp_portal_create_remote_desktop_session_finish() to get the results. This method completes asynchronously.

### Method
Asynchronous function

### Signature
void xdp_portal_create_remote_desktop_session_full (
  XdpPortal* portal,
  XdpDeviceType devices,
  XdpOutputType outputs,
  XdpRemoteDesktopFlags flags,
  XdpCursorMode cursor_mode,
  XdpPersistMode persist_mode,
  const char* restore_token,
  GCancellable* cancellable,
  GAsyncReadyCallback callback,
  gpointer data
)

### Parameters
- **portal** (XdpPortal*) - The portal object.
- **devices** (XdpDeviceType) - Which kinds of input devices to offer in the new dialog.
- **outputs** (XdpOutputType) - Which kinds of source to offer in the dialog.
- **flags** (XdpRemoteDesktopFlags) - Options for this call.
- **cursor_mode** (XdpCursorMode) - The cursor mode of the session.
- **persist_mode** (XdpPersistMode) - The persist mode of the session.
- **restore_token** (const char*) - The token of a previous screencast session to restore. Can be NULL. NUL terminated UTF-8 string. Owned by caller.
- **cancellable** (GCancellable*) - Optional GCancellable. Can be NULL. Owned by caller.
- **callback** (GAsyncReadyCallback) - A callback to call when the request is done. Can be NULL.
- **data** (gpointer) - Data to pass to callback. Can be NULL. Owned by caller.

### Return Value
None (void). The result is obtained via xdp_portal_create_remote_desktop_session_finish().
```

--------------------------------

### xdp_portal_create_remote_desktop_session

Source: https://libportal.org/class.Portal.html

Creates a session for remote desktop.

```APIDOC
## xdp_portal_create_remote_desktop_session

### Description
Creates a session for remote desktop.

### Method
Instance method

### Parameters
None

### Returns
None
```

--------------------------------

### xdp_portal_print_file

Source: https://libportal.org/method.Portal.print_file.html

Prints a file asynchronously. If a valid token is provided, it uses the settings from the corresponding prepare_print call; otherwise, a print dialog is shown. The callback is invoked when the operation completes, and results are retrieved with xdp_portal_print_file_finish().

```APIDOC
## xdp_portal_print_file

### Description
Prints a file. If a valid token is present in the options, this call will print with the settings from the Print call that the token refers to. If no token is present, a print dialog will be presented to the user. When the request is done, callback will be called. You can then call xdp_portal_print_file_finish() to get the results.

### Method
Asynchronous function

### Signature
void xdp_portal_print_file (XdpPortal* portal, XdpParent* parent, const char* title, guint token, const char* file, XdpPrintFlags flags, GCancellable* cancellable, GAsyncReadyCallback callback, gpointer data)

### Parameters
- **portal** (XdpPortal*) - The portal object.
- **parent** (XdpParent*) - Parent window information. Can be NULL.
- **title** (const char*) - Title for the print dialog. NUL terminated UTF-8 string.
- **token** (guint) - Token returned by a previous xdp_portal_prepare_print() call, or 0.
- **file** (const char*) - Path of the document to print. NUL terminated UTF-8 string.
- **flags** (XdpPrintFlags) - Options for this call.
- **cancellable** (GCancellable*) - Optional GCancellable. Can be NULL.
- **callback** (GAsyncReadyCallback) - A callback to call when the request is done. Can be NULL.
- **data** (gpointer) - Data to pass to callback. Can be NULL.

### Completion
Use xdp_portal_print_file_finish() inside the GAsyncReadyCallback to obtain the result of the operation.
```

--------------------------------

### XdpPortal::update-progress

Source: https://libportal.org/signal.Portal.update-progress.html

Signal emitted to indicate progress of an update installation. It is emitted at least once at the end with a non-zero status, and for each successful operation, exactly one signal with progress 100 is guaranteed.

```APIDOC
## Signal: XdpPortal::update-progress

### Description
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 are also guaranteed to send exactly one signal with progress 100.

### Declaration
```c
void
update_progress (
  XdpPortal* self,
  guint n_ops,
  guint op,
  guint progress,
  XdpUpdateStatus* status,
  gchar* error,
  gchar* error_message,
  gpointer user_data
)
```

### Parameters
- **self** (XdpPortal*) - The instance the signal is emitted on.
- **n_ops** (guint) - The number of operations that the update consists of.
- **op** (guint) - The position of the currently active operation.
- **progress** (guint) - The progress of the currently active operation, as a number between 0 and 100.
- **status** (XdpUpdateStatus*) - The overall status of the update. The data is owned by the caller of the function.
- **error** (gchar*) - The error name if the status is 'failed'. The data is owned by the caller of the function. The value is a NUL terminated UTF-8 string.
- **error_message** (gchar*) - The error message if the status is 'failed'. The data is owned by the caller of the function. The value is a NUL terminated UTF-8 string.
- **user_data** (gpointer) - User data passed to the signal handler.

### Default Handler
The default handler is called before the handlers added via g_signal_connect().
```

--------------------------------

### xdp_portal_set_wallpaper

Source: https://libportal.org/class.Portal.html

Sets a desktop background image, given by a uri.

```APIDOC
## xdp_portal_set_wallpaper

### Description
Sets a desktop background image, given by a uri.

```

--------------------------------

### xdp_portal_create_screencast_session_finish

Source: https://libportal.org/class.Portal.html

Finishes the create-screencast request, and returns a XdpSession.

```APIDOC
## xdp_portal_create_screencast_session_finish

### Description
Finishes the create-screencast request, and returns a XdpSession.

### Method
Instance method

### Parameters
None

### Returns
A XdpSession.
```

--------------------------------

### xdp_portal_create_screencast_session

Source: https://libportal.org/class.Portal.html

Creates a session for a screencast.

```APIDOC
## xdp_portal_create_screencast_session

### Description
Creates a session for a screencast.

### Method
Instance method

### Parameters
None

### Returns
None
```

--------------------------------

### xdp_portal_save_files

Source: https://libportal.org/method.Portal.save_files.html

Asynchronously asks for a folder as a location to save one or more files. The names of the files are used as-is and appended to the selected folder's path. When the request is done, the callback is invoked, and you can call xdp_portal_save_files_finish() to get the results.

```APIDOC
## xdp_portal_save_files

### Description
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 `xdp_portal_open_file()`. When the request is done, `callback` will be called. You can then call `xdp_portal_save_file_finish()` to get the results. This method completes asynchronously. Use `xdp_portal_save_files_finish()` inside the `GAsyncReadyCallback` to obtain the result of the operation.

### Method
void

### Signature
void xdp_portal_save_files (XdpPortal* portal, XdpParent* parent, const char* title, const char* current_name, const char* current_folder, GVariant* files, GVariant* choices, XdpSaveFileFlags flags, GCancellable* cancellable, GAsyncReadyCallback callback, gpointer data)

### Parameters
- **portal** (XdpPortal*) - Required - The portal object.
- **parent** (XdpParent*) - Optional - Parent window information. Can be NULL.
- **title** (const char*) - Required - Title for the file chooser dialog. NUL terminated UTF-8 string.
- **current_name** (const char*) - Optional - Suggested filename. Can be NULL. NUL terminated UTF-8 string.
- **current_folder** (const char*) - Optional - Suggested folder to save the file in. Can be NULL. NUL terminated UTF-8 string.
- **files** (GVariant*) - Required - An array of file names to be saved.
- **choices** (GVariant*) - Optional - A GVariant describing extra widgets. Can be NULL.
- **flags** (XdpSaveFileFlags) - Required - Options for this call.
- **cancellable** (GCancellable*) - Optional - Optional GCancellable. Can be NULL.
- **callback** (GAsyncReadyCallback) - Optional - A callback to call when the request is done. Can be NULL.
- **data** (gpointer) - Optional - Data to pass to callback. Can be NULL.

### Return Value
None (void). The result is obtained asynchronously via the callback and `xdp_portal_save_files_finish()`.
```
Tokens:
Raw