### xdp_portal_dynamic_launcher_prepare_install

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

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 `xdp_portal_dynamic_launcher_prepare_install_finish()` to get the results. This method completes asynchronously.

```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. When the request is done, `callback` will be called. You can then call `xdp_portal_dynamic_launcher_prepare_install_finish()` to get the results. This method completes asynchronously.

### Method
void

### Parameters
#### Path Parameters
- **portal** (XdpPortal*) - Required - The portal object.
- **parent** (XdpParent) - Optional - Parent window information.
- **name** (const char*) - Required - The name for the launcher.
- **icon_v** (GVariant) - Required - A `GBytesIcon` as returned by g_icon_serialize(). Must be a png or jpeg no larger than 512x512, or an svg.
- **launcher_type** (XdpLauncherType) - Required - The type of the launcher.
- **target** (const char*) - Optional - The URL if the launcher is for a web app, or `NULL`.
- **editable_name** (gboolean) - Required - If `TRUE`, the user will be able to edit the name of the launcher.
- **editable_icon** (gboolean) - Required - If `TRUE`, the user will be able to edit the icon of the launcher, if the implementation supports this.
- **cancellable** (GCancellable) - Optional - Optional `GCancellable`.
- **callback** (GAsyncReadyCallback) - Optional - A callback to call when the request is done.
- **data** (gpointer) - Optional - Data to pass to `callback`.
```

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

### xdp_portal_dynamic_launcher_install

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

Installs a dynamic launcher by completing the setup process. This function takes a token, the desired desktop file ID, and the desktop entry content as input. It ensures that the application icon and name are correctly registered in the desktop environment's menu.

```APIDOC
## XdpPortaldynamic_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.
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.

### Method
xdp_portal_dynamic_launcher_install

### Parameters
#### Path Parameters
- **portal** (XdpPortal*) - Description: Pointer to the XdpPortal object.
- **token** (const char*) - Required - Description: A token acquired via a `xdp_portal_dynamic_launcher_request_install_token()` or `xdp_portal_dynamic_launcher_prepare_install()` call. The data is owned by the caller of the method. The value is a NUL terminated UTF-8 string.
- **desktop_file_id** (const char*) - Required - Description: The .desktop file name to be used. The data is owned by the caller of the method. The value is a NUL terminated UTF-8 string.
- **desktop_entry** (const char*) - Required - Description: The key-file to be used for the contents of the .desktop file. The data is owned by the caller of the method. The value is a NUL terminated UTF-8 string.
- **error** (GError **) - Optional - Description: The return location for a recoverable error. 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** - TRUE if the installation was successful, FALSE with error set otherwise.
```

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

### Start XdpSession

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

Initiates an XDP session. Provide a callback to be invoked upon completion. Use xdp_session_start_finish within the callback to get the operation's results. This method is asynchronous.

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

```

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

### 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
(No parameters documented)

### Request Example
(No request example available)

### Response
(No response details available)
```

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

### Request Install Token Declaration

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

This is the C function declaration for requesting an install token for a dynamic launcher. It takes the portal instance, launcher name, icon variant, and an error pointer.

```c
char*
xdp_portal_dynamic_launcher_request_install_token (
  XdpPortal* portal,
  const char* name,
  GVariant* icon_v,
  GError** error
)

```

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

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

### Method
(Not specified in source)

### Endpoint
(Not specified in source)
```

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

### xdp_portal_dynamic_launcher_prepare_install_finish

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

Finishes the prepare-install-launcher request, returning a GVariant dictionary with the chosen name and an installation token.

```APIDOC
## xdp_portal_dynamic_launcher_prepare_install_finish

### Description
Finishes the prepare-install-launcher request, and returns `GVariant` 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 `xdp_portal_dynamic_launcher_install()` call to complete the installation.

### Method
(Not specified, likely an internal C function call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
- **name** (s) - The name chosen by the user.
- **token** (s) - A token for `xdp_portal_dynamic_launcher_install()`.

#### Response Example
(GVariant dictionary containing 'name' and 'token')

ERROR HANDLING:
- **error** (GError **) - Returns a recoverable error if one occurs.
```

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

### XdpPortal Session Monitor Start Declaration

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

This is the C function declaration for starting the XdpPortal session monitor. It is used to initiate asynchronous monitoring of the login session state.

```c
void
xdp_portal_session_monitor_start (
  XdpPortal* portal,
  XdpParent* parent,
  XdpSessionMonitorFlags flags,
  GCancellable* cancellable,
  GAsyncReadyCallback callback,
  gpointer data
)

```

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

### XdpPortal dynamic_launcher_install Declaration

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

This is the C function declaration for xdp_portal_dynamic_launcher_install. It is used to complete the installation of a launcher.

```c
gboolean
xdp_portal_dynamic_launcher_install (
  XdpPortal* portal,
  const char* token,
  const char* desktop_file_id,
  const char* desktop_entry,
  GError** error
)

```

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

### xdp_portal_session_monitor_start

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

Starts monitoring the login session state for an XdpPortal. This is an asynchronous operation that emits the `XdpPortal::session-state-changed` signal when the state changes. Use `xdp_portal_session_monitor_stop()` to stop monitoring and `xdp_portal_session_monitor_start_finish()` in the callback to get the result.

```APIDOC
## xdp_portal_session_monitor_start

### Description
Makes `XdpPortal` start monitoring the login session state. When the state changes, the `XdpPortal::session-state-changed` signal is emitted. Use `xdp_portal_session_monitor_stop()` to stop monitoring.

This method completes asynchronously. Use `xdp_portal_session_monitor_start_finish()` inside the `GAsyncReadyCallback` to obtain the result of the operation.

### Method
void

### Endpoint
xdp_portal_session_monitor_start (XdpPortal* portal, XdpParent* parent, XdpSessionMonitorFlags flags, GCancellable* cancellable, GAsyncReadyCallback callback, gpointer data)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (void)
This method returns void upon successful completion.

#### Response Example
None
```

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

### XdpPortal Location Monitor Start Declaration

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

This is the C function declaration for starting the XdpPortal location monitor. It specifies the parameters required for setting up location tracking.

```c
void
xdp_portal_location_monitor_start (
  XdpPortal* portal,
  XdpParent* parent,
  guint distance_threshold,
  guint time_threshold,
  XdpLocationAccuracy accuracy,
  XdpLocationMonitorFlags flags,
  GCancellable* cancellable,
  GAsyncReadyCallback callback,
  gpointer data
)

```

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

### 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
(No parameters documented)

### Request Example
(No request example available)

### Response
(No response details available)
```

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

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

### Method
(Not specified in source)

### Endpoint
(Not specified in source)
```

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

### xdp_portal_prepare_print

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

Presents a print dialog to the user and returns print settings and page setup. This method completes asynchronously.

```APIDOC
## XdpPortal.prepare_print

### Description
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 `xdp_portal_prepare_print_finish()` to get the results. This method completes asynchronously. Use `xdp_portal_prepare_print_finish()` inside the `GAsyncReadyCallback` to obtain the result of the operation.

### Method Signature
```c
void xdp_portal_prepare_print (
  XdpPortal* portal,
  XdpParent* parent,
  const char* title,
  GVariant* settings,
  GVariant* page_setup,
  XdpPrintFlags flags,
  GCancellable* cancellable,
  GAsyncReadyCallback callback,
  gpointer data
)
```

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

#### Method Parameters
- **parent** (XdpParent) - Parent window information. The argument can be `NULL`.
- **title** (const char*) - Title for the print dialog. The value is a NUL terminated UTF-8 string.
- **settings** (GVariant) - Serialized print settings. The argument can be `NULL`.
- **page_setup** (GVariant) - Serialized page setup. The argument can be `NULL`.
- **flags** (XdpPrintFlags) - Options for this call.
- **cancellable** (GCancellable) - Optional `GCancellable`. The argument can be `NULL`.
- **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`.

### Request Example
None provided in source.

### Response
#### Success Response
This method is asynchronous. Results are obtained by calling `xdp_portal_prepare_print_finish()` within the `GAsyncReadyCallback`.

#### Response Example
None provided in source.
```

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

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

### Method
(Not specified in source)

### Endpoint
(Not specified in source)
```

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

### XdpPortal Update Install Declaration

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

This is the C function declaration for `xdp_portal_update_install`. It is used to initiate the software update installation process asynchronously.

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

```

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

### XdpInputCaptureSession start Declaration

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

This is the C declaration for the xdp_input_capture_session_start function. It is used to start an input capture session asynchronously.

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

```

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

### xdp_portal_update_install_finish

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

Finishes an update-installation request. Returns TRUE if the update is being installed. 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.

```APIDOC
## xdp_portal_update_install_finish

### Description
Finishes an update-installation request. Returns TRUE if the update is being installed. 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.

### Method
Call

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (gboolean)
- **return value** (gboolean) - TRUE if the update is being installed.

#### Response Example
None

#### Error Handling
- **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.
```

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

### xdp_session_start

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

Starts the XdpSession. This method is asynchronous and requires a callback to handle the completion and retrieve results using `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.

### Method
void

### Parameters
#### Path Parameters
- **session** (XdpSession*) - Required - The session object to start.

#### Query Parameters
- **parent** (XdpParent) - Optional - Parent window information. Can be NULL.
- **cancellable** (GCancellable) - Optional - A GCancellable object for cancellation. Can be NULL.
- **callback** (GAsyncReadyCallback) - Optional - A callback function to be invoked when the operation completes. Can be NULL.
- **data** (gpointer) - Optional - Data to be passed to the callback function. Can be NULL.

### Request Example
```c
xdp_session_start(session, parent, cancellable, callback, data);
```

### Response
This method does not return a value directly. Results are obtained via the `callback` and `xdp_session_start_finish()`.
```

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

### xdp_input_capture_session_start

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

Starts the input capture session asynchronously. The provided callback will be invoked upon completion, and `xdp_input_capture_session_start_finish()` can be used to retrieve the results.

```APIDOC
## xdp_input_capture_session_start

### Description
Start the input capture session. When the request is done, `callback` will be called. You can then call `xdp_input_capture_session_start_finish()` to get the results. This method completes asynchronously. Use `xdp_input_capture_session_start_finish()` inside the `GAsyncReadyCallback` to obtain the result of the operation.

### Method
xdp_input_capture_session_start

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

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

### Request Example
None

### Response
#### Success Response
None explicitly defined, operation is asynchronous.

#### Response Example
None
```

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

### xdp_portal_update_install

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

Installs an available software update. This method should be called in response to a `XdpPortal::update-available` signal. Progress is reported via the `XdpPortal::update-progress` signal. The operation is asynchronous.

```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.

### Method
void

### Endpoint
N/A (SDK Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
None (asynchronous operation, result obtained via callback)

#### Response Example
None
```

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

### XdpPortalupdate_monitor_start Declaration

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

Declaration of the XdpPortalupdate_monitor_start function. This function starts monitoring for available software updates.

```c
void
xdp_portal_update_monitor_start (
  XdpPortal* portal,
  XdpUpdateMonitorFlags flags,
  GCancellable* cancellable,
  GAsyncReadyCallback callback,
  gpointer data
)

```

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

### xdp_portal_update_monitor_start

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

Starts monitoring for available software updates. Emits the `XdpPortal::update-available` signal when a new update is detected. This is an asynchronous operation.

```APIDOC
## xdp_portal_update_monitor_start

### Description
Makes `XdpPortal` start monitoring for available software updates. When a new update is available, the `XdpPortal::update-available` signal is emitted. Use `xdp_portal_update_monitor_stop()` to stop monitoring. This method completes asynchronously. Use `xdp_portal_update_monitor_start_finish()` inside the `GAsyncReadyCallback` to obtain the result of the operation.

### Method
void

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
None (asynchronous operation)

#### Response Example
None
```

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

### xdp_portal_create_remote_desktop_session_full

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

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

```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. Use `()` inside the `GAsyncReadyCallback` to obtain the result of the operation.

### Method
void

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

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

### xdp_portal_create_screencast_session

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

Creates a session for a screencast. This is an asynchronous operation. Use `xdp_portal_create_screencast_session_finish()` to get the results after the callback is invoked.

```APIDOC
## xdp_portal_create_screencast_session

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

### Method
`void xdp_portal_create_screencast_session(...)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
* **portal** (`XdpPortal*`) - The portal instance.
* **outputs** (`XdpOutputType`) - Which kinds of source to offer in the dialog.
* **flags** (`XdpScreencastFlags`) - 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. The argument can be `NULL`. The value is a NUL terminated UTF-8 string.
* **cancellable** (`GCancellable*`) - Optional `GCancellable`. The argument can be `NULL`.
* **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`.

### Request Example
None explicitly provided in the source.

### Response
#### Success Response
This method is asynchronous. Results are obtained by calling `xdp_portal_create_screencast_session_finish()` within the `GAsyncReadyCallback`.

#### Response Example
None explicitly provided in the source.
```

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

### xdp_portal_dynamic_launcher_request_install_token

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

Requests a token for completing launcher installation without user interaction. This function is intended for software centers and requires the caller's app ID to be on an allowlist.

```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. 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.

### Method
(Not specified, likely a C function call)

### Parameters
#### Path Parameters
(None specified)

#### Query Parameters
(None specified)

#### Request Body
(None specified)

### Request Example
(None specified)

### Response
#### Success Response
- **return value** (char*) - A token that can be passed to `xdp_portal_dynamic_launcher_install()`, or `NULL` with `error` set. The caller of the method takes ownership of the returned data, and is responsible for freeing it. The value is a NUL terminated UTF-8 string.

#### Response Example
(None specified)

### Parameters
- **portal** (XdpPortal*) - (Implicit parameter for C function)
- **name** (const char*) - The name for the launcher. The data is owned by the caller of the method. The value is a NUL terminated UTF-8 string.
- **icon_v** (GVariant) - A `GBytesIcon` as returned by g_icon_serialize(). Must be a png or jpeg no larger than 512x512, or an svg. 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.
```

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

### XdpPortal.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 XdpInputCaptureSession. The created session is inactive, and must be started with method.InputCaptureSession.start.

```APIDOC
## XdpPortal.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 [method.InputCaptureSession.start].

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

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

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

### xdp_input_capture_session_start_finish

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

Completes the input capture session start request, returning true if the operation was successful.

```APIDOC
## xdp_input_capture_session_start_finish

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

### Method
(Not specified, likely a function call in an SDK)

### Endpoint
(Not applicable for SDK methods)

### Parameters
(No parameters explicitly documented for this method, likely operates on a pending request)

### Response
- **success** (boolean) - TRUE if the session start was successful, FALSE otherwise.
```

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

### xdp_portal_trash_file

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

Sends the file at `path` to the trash can asynchronously. Use `xdp_portal_trash_file_finish()` to get the result.

```APIDOC
## xdp_portal_trash_file

### Description
Sends the file at `path` to the trash can. This method completes asynchronously. Use `xdp_portal_trash_file_finish()` inside the `GAsyncReadyCallback` to obtain the result of the operation.

### Method
void

### Parameters
#### Path Parameters
- **path** (const char*) - Required - The path for a local file. The value is a NUL terminated UTF-8 string.
- **cancellable** (GCancellable) - Optional - Optional `GCancellable`.
- **callback** (GAsyncReadyCallback) - Optional - A callback to call when the request is done.
- **data** (gpointer) - Optional - Data to pass to `callback`.
```

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

### xdp_portal_dynamic_launcher_get_desktop_entry

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

Retrieves the contents of a .desktop file previously installed by the dynamic launcher portal. The desktop_file_id must be prefixed with the caller's app ID and suffixed with '.desktop'.

```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.
The `desktop_file_id` must be prefixed with the caller’s app ID followed by a “.” and suffixed with “.desktop”.

### Method
```c
char* xdp_portal_dynamic_launcher_get_desktop_entry (
  XdpPortal* portal,
  const char* desktop_file_id,
  GError** error
)
```

### Parameters
#### Path Parameters
- **desktop_file_id** (const char*) - Required - The .desktop file name. The data is owned by the caller of the method. The value is a NUL terminated UTF-8 string.
- **error** (GError **) - Optional - 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
_Type:_ `char*`
The contents of the desktop file, or `NULL` with `error` set. The caller of the method takes ownership of the returned data, and is responsible for freeing it. The value is a NUL terminated UTF-8 string.
```

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

### XdpPortal.prepare_print_finish

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

Finishes the prepare-print request. It returns a GVariant dictionary containing print settings, page setup, and a token for subsequent print calls.

```APIDOC
## XdpPortal.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 by used in a `xdp_portal_print_file()` call to avoid the print dialog.

### Method
(Not specified, likely an internal method call)

### Parameters
#### Path Parameters
(None specified)

#### Query Parameters
(None specified)

#### Request Body
(None specified)

### Request Example
(None specified)

### Response
#### Success Response
- **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 `xdp_portal_print_file()` call to avoid the print dialog.

#### Response Example
(None specified)
```

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

### 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
(No parameters documented)

### Request Example
(No request example available)

### Response
(No response details available)
```

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

### xdp_portal_dynamic_launcher_uninstall

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

Uninstalls a launcher previously installed using the dynamic launcher portal. This action deletes the associated .desktop file and icon.

```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
(Not specified, likely a C function call)

### Parameters
#### Path Parameters
(None)

#### Query Parameters
(None)

#### Request Body
(None)

### Parameters
- **portal** (*XdpPortal*) - The XdpPortal instance.
- **desktop_file_id** (*const char*) - Required - The .desktop file name. Must be prefixed with the caller’s app ID followed by a “.” and suffixed with “.desktop”. 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
_Type:_ `gboolean`
`TRUE` if the uninstallation was successful, `FALSE` with `error` set otherwise.
```

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

### xdp_portal_location_monitor_start

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

Starts monitoring location changes for an XdpPortal. A location-updated signal is emitted when the location changes. Use xdp_portal_location_monitor_stop() to stop monitoring. This method completes asynchronously.

```APIDOC
## xdp_portal_location_monitor_start

### Description
Starts monitoring location changes for an XdpPortal. When the location changes, the `XdpPortal::location-updated` signal is emitted. Use `xdp_portal_location_monitor_stop()` to stop monitoring. This method completes asynchronously.

### Method
void

### Parameters
#### Path Parameters
* **portal** (XdpPortal*) - The XdpPortal instance.
* **parent** (XdpParent) - A `XdpParent`, or `NULL`. The argument can be `NULL`.
* **distance_threshold** (guint) - Distance threshold, in meters.
* **time_threshold** (guint) - Time threshold, in seconds.
* **accuracy** (XdpLocationAccuracy) - Desired accuracy.
* **flags** (XdpLocationMonitorFlags) - Options for this call.
* **cancellable** (GCancellable) - Optional `GCancellable`. The argument can be `NULL`.
* **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`.
```

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

### xdp_portal_dynamic_launcher_get_icon

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

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”.

```APIDOC
## xdp_portal_dynamic_launcher_get_icon

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

### Method
(Not specified, likely a function call in a library)

### Parameters
#### Path Parameters
(None specified)

#### Query Parameters
(None specified)

#### Request Body
(None specified)

### Request Example
(Not specified)

### Response
#### Success Response
The icon in a format recognized by g_icon_deserialize().

#### Response Example
(Not specified)

### Parameters
- **portal** (XdpPortal*) - (Not specified if required or optional, assumed required for function call)
- **desktop_file_id** (const char*) - Required - The .desktop file name. The data is owned by the caller of the method. The value is a NUL terminated UTF-8 string.
- **out_icon_format** (char**) - Optional - Return location for icon format string, one of “png”, “jpeg”, “svg”. The argument can be NULL. The data is owned by the caller of the method. The value is a NUL terminated UTF-8 string.
- **out_icon_size** (guint*) - Optional - Return location for icon size. The argument can be NULL. The data is owned by the caller of the method.
- **error** (GError **) - Optional - 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.
```

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

### XdpPortal dynamic_launcher_prepare_install_finish Declaration

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

The declaration for the XdpPortal dynamic_launcher_prepare_install_finish method. This function is used to complete the prepare-install-launcher request.

```c
GVariant*
xdp_portal_dynamic_launcher_prepare_install_finish (
  XdpPortal* portal,
  GAsyncResult* result,
  GError** error
)

```

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

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

### Method
(Not specified in source)

### Endpoint
(Not specified in source)
```

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

### xdp_input_capture_session_start

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

Initiates the input capture session.

```APIDOC
## xdp_input_capture_session_start

### Description
Start the input capture session.

### Method
(Not specified, likely a function call in an SDK)

### Endpoint
(Not applicable for SDK methods)

### Parameters
(No parameters explicitly documented for this method)

### Response
(The result of the operation is obtained via `xdp_input_capture_session_start_finish()`)
```

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

### XdpPortal Get Input Capture Version Declaration

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

This C code snippet shows the declaration of the xdp_portal_get_input_capture_version function. It is used to initiate an asynchronous request to get the input portal API version.

```c
void
xdp_portal_get_input_capture_version (
  XdpPortal* portal,
  GCancellable* cancellable,
  GAsyncReadyCallback callback,
  void* callback_data
)

```

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

### xdp_portal_dynamic_launcher_launch

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

Launches an application using the dynamic launcher portal.

```APIDOC
## xdp_portal_dynamic_launcher_launch

### Description
No description available.

### Method
(Instance method)

### Parameters
(No parameters documented)

### Request Example
(No request example available)

### Response
(No response details available)
```

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

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

### Method
(Instance method)

### Parameters
(No parameters documented)

### Request Example
(No request example available)

### Response
(No response details available)
```

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

### xdp_portal_update_monitor_stop

Source: https://libportal.org/method.Portal.update_monitor_stop.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()`.

### Method
```c
void xdp_portal_update_monitor_stop (XdpPortal* portal)
```

### Parameters
#### Path Parameters
- **portal** (XdpPortal*) - Description: Pointer to the XdpPortal instance.
```

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

### XDP_OPEN_FILE_FLAG_NONE

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

Represents no options set for opening a file. Available since version 1.0.

```go
XDP_OPEN_FILE_FLAG_NONE
    Value: 0
```

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

### xdp_portal_session_monitor_stop

Source: https://libportal.org/method.Portal.session_monitor_stop.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()`.

### Method
```c
void xdp_portal_session_monitor_stop(
  XdpPortal* portal
)
```

### Parameters
#### Path Parameters
- **portal** (XdpPortal*) - Description: Pointer to the XdpPortal structure.
```

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

### XdpPortal.create_remote_desktop_session_finish

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

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

```APIDOC
## XdpPortal.create_remote_desktop_session_finish

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

### Method
(Not specified in source, likely a C function call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### 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
- **XdpSession** - A `XdpSession`. The caller of the method takes ownership of the returned data, and is responsible for freeing it.
```

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

### 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
(No parameters documented)

### Request Example
(No request example available)

### Response
(No response details available)
```

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

### XdpUpdateStatus Members

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

This snippet lists the members of the XdpUpdateStatus enum, indicating the status of an installation.

```csharp
XDP_UPDATE_STATUS_RUNNING
    
Installation in progress.
    * Value: `0`
    * Available since: 1.0
```

```csharp
XDP_UPDATE_STATUS_EMPTY
    
Nothing to install.
    * Value: `1`
    * Available since: 1.0
```

```csharp
XDP_UPDATE_STATUS_DONE
    
Installation finished successfully.
    * Value: `2`
    * Available since: 1.0
```

```csharp
XDP_UPDATE_STATUS_FAILED
    
Installation failed.
    * Value: `3`
    * Available since: 1.0
```