+
The command reference is generated from the flatpak repo; see https://github.com/flatpak/flatpak/tree/main/doc
Flatpak comes with a rich commandline interface. -
Table of Contents
Table of Contents
flatpak — Build, install and run applications and runtimes
flatpak [OPTION...] {COMMAND}
+
Table of Contents
Table of Contents
flatpak — Build, install and run applications and runtimes
flatpak [OPTION...] {COMMAND}
Flatpak is a tool for managing applications and the runtimes they use. In the Flatpak model, applications can be built and distributed independently from the host system they are used @@ -291,7 +291,7 @@ flatpak-remote(5), flatpak-installation(5), https://www.flatpak.org -
Table of Contents
Table of Contents
flatpak-build-bundle — Create a single-file bundle from a local repository
flatpak build-bundle [OPTION...] LOCATION FILENAME NAME [BRANCH]
Creates a single-file named FILENAME for the application (or runtime) named NAME in the repository at LOCATION . If @@ -659,7 +659,7 @@
--filesystem=FSAllow the application access to a subset of the filesystem. This updates the [Context] group in the metadata. - FS can be one of: home, host, host-os, host-etc, xdg-desktop, xdg-documents, xdg-download, + FS can be one of: home, host, host-os, host-etc, host-root, xdg-desktop, xdg-documents, xdg-download, xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, xdg-run, xdg-config, xdg-cache, xdg-data, an absolute path, or a homedir-relative path like ~/dir or paths relative to the xdg dirs, like xdg-download/subdir. @@ -673,7 +673,7 @@ Remove access to the specified subset of the filesystem from the application. This overrides to the Context section from the application metadata. - FILESYSTEM can be one of: home, host, host-os, host-etc, xdg-desktop, xdg-documents, xdg-download, + FILESYSTEM can be one of: home, host, host-os, host-etc, host-root, xdg-desktop, xdg-documents, xdg-download, xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, an absolute path, or a homedir-relative path like ~/dir. This option can be used multiple times. @@ -1120,7 +1120,7 @@
--filesystem=FILESYSTEM[:ro|:create]Allow the application access to a subset of the filesystem. This overrides to the Context section from the application metadata. - FILESYSTEM can be one of: home, host, host-os, host-etc, xdg-desktop, xdg-documents, xdg-download, + FILESYSTEM can be one of: home, host, host-os, host-etc, host-root, xdg-desktop, xdg-documents, xdg-download, xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, xdg-run, xdg-config, xdg-cache, xdg-data, an absolute path, or a homedir-relative path like ~/dir or paths relative to the xdg dirs, like xdg-download/subdir. @@ -1134,7 +1134,7 @@ Remove access to the specified subset of the filesystem from the application. This overrides to the Context section from the application metadata. - FILESYSTEM can be one of: home, host, host-os, host-etc, xdg-desktop, xdg-documents, xdg-download, + FILESYSTEM can be one of: home, host, host-os, host-etc, host-root xdg-desktop, xdg-documents, xdg-download, xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, an absolute path, or a homedir-relative path like ~/dir. This option can be used multiple times. @@ -1644,7 +1644,7 @@ flatpak(1), flatpak-install(1), flatpak-update(1) -
flatpak-install — Install an application or runtime
flatpak install [OPTION...] [REMOTE] REF...
flatpak install [OPTION...] [--from|--bundle] LOCATION
flatpak-install — Install an application or runtime
flatpak install [OPTION...] [REMOTE] REF...
flatpak install [OPTION...] [--from|--bundle|--image] LOCATION
Installs an application or runtime. The primary way to install is to specify a REMOTE name as the source and one ore more REF s to specify the @@ -1678,11 +1678,11 @@ system-wide basis (see flatpak(1)).
- The alternative form of the command (with --from or
- --bundle) allows to install directly from a source such as a
- .flatpak single-file bundle or a .flatpakref
- application description. The options are optional if the first argument has the expected
- filename extension.
+ The alternative form of the command (with --from, --bundle,
+ or --image) allows to install directly from a source. The source can be a
+ .flatpak single-file bundle, .flatpakref
+ application description, or a reference to an OCI image. The options are optional if the
+ first argument has the expected filename extension or prefix.
Note that flatpak allows to have multiple branches of an application and runtimes installed and used at the same time. However, only one version of an application @@ -1701,6 +1701,13 @@
--from
Treat LOCATION as an application description file.
This is assumed if the argument ends with .flatpakref.
+
--image
+ Treat LOCATION as the location of a Flatpak in
+ OCI image format. [LOCATION] is in the format of
+ containers-transports(5).
+ Supported schemes are docker://, oci:,
+ and oci-archive:. This is assumed if the argument starts
+ with one of these schemes.
--reinstallUninstall first if already installed.
-u, --user@@ -2008,7 +2015,7 @@
--filesystem=FILESYSTEMAllow the application access to a subset of the filesystem. This overrides to the Context section from the application metadata. - FILESYSTEM can be one of: home, host, host-os, host-etc, xdg-desktop, xdg-documents, xdg-download, + FILESYSTEM can be one of: home, host, host-os, host-etc, host-root, xdg-desktop, xdg-documents, xdg-download, xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, xdg-run, xdg-config, xdg-cache, xdg-data, an absolute path, or a homedir-relative path like ~/dir or paths @@ -2250,13 +2257,87 @@ flatpak-permission-remove(1), flatpak-permission-reset(1), flatpak-permission-show(1) -
flatpak-preinstall — Install flatpaks that are part of the operating system
flatpak preinstall [OPTION...]
+ This command manages flatpaks that are part of the operating system. If no options are given, running flatpak preinstall will synchronize (install and remove) flatpaks to match the set that the OS vendor has chosen. +
+ Preinstalled flatpaks are defined by dropping .preinstall files into the directories /usr/share/flatpak/preinstall.d/ and /etc/flatpak/preinstall.d/. The OS runs flatpak preinstall -y (or its GUI equivalent) on system startup, which then does the actual installation.
+
+ This system allows the OS vendor to define the list of flatpaks that are installed together with the OS, and also makes it possible for the OS vendor to make changes to the list in the future, which is then applied once flatpak preinstall is run next time. + + Users can opt out of preinstalled flatpaks by simply uninstalling them, at which point they won't get automatically reinstalled again. +
+ The .preinstall file is using the same .ini file format that is used for systemd unit files or application .desktop files. +
+ The NAME is the fully qualified name of the runtime or application. All the information for a single runtime or application is contained in one [Flatpak Preinstall NAME] group. Multiple groups can be defined in a single file. +
+ The following keys can be present in this group: +
Install (boolean)+ Whether this group should be installed. If this key is not specified, the group will be installed. +
Branch (string)+ The name of the branch from which to install the application or runtime. If this key is not specified, the "master" branch is used. +
IsRuntime (boolean)+ Whether this group refers to a runtime. If this key is not specified, the group is assumed to refer to an application. +
CollectionID (string)+ The collection ID of the remote to use, if it has one. +
The following options are understood:
-h, --help+ Show help options and exit. +
--reinstall+ Uninstall first if already installed. +
-u, --user+ Install the application or runtime in a per-user installation. +
--system+ Install the application or runtime in the default system-wide installation. +
--installation=NAME
+ Install the application or runtime in a system-wide installation
+ specified by NAME among those defined in
+ /etc/flatpak/installations.d/. Using
+ --installation=default is equivalent to using
+ --system.
+
--no-deploy+ Download the latest version, but don't deploy it. +
--no-pull+ Don't download the latest version, deploy whatever is locally available. +
--no-related+ Don't download related extensions, such as the locale data. +
--no-deps+ Don't verify runtime dependencies when installing. +
--sideload-repo=PATH
+ Adds an extra local ostree repo as a source for installation. This is equivalent
+ to using the sideload-repos directories (see
+ flatpak(1)),
+ but can be done on a per-command basis. Any path added here is used in addition
+ to ones in those directories.
+
--include-sdk
+ For each app being installed, also installs the SDK that was used to build it.
+ Implies --or-update; incompatible with --no-deps.
+
--include-debug
+ For each ref being installed, as well as all dependencies, also installs its
+ debug info. Implies --or-update; incompatible with
+ --no-deps.
+
-y, --assumeyes+ Automatically answer yes to all questions (or pick the most prioritized answer). This is useful for automation. +
--noninteractive+ Produce minimal output and avoid most questions. This is suitable for use in + non-interactive situations, e.g. in a build script. +
-v, --verbose+ Print debug information during command processing. +
--ostree-verbose+ Print OSTree debug information during command processing. +
flatpak-ps — Enumerate running instances
flatpak ps [OPTION...]
Lists useful information about running Flatpak instances.
To see full details of a running instance, you can open the file
/run/user/$UID/.flatpak/$INSTANCE/info, where $INSTANCE is the instance
ID reported by flatpak ps.
-
The following options are understood:
-h, --help+
The following options are understood:
-h, --helpShow help options and exit.
-v, --verbosePrint debug information during command processing. @@ -2268,7 +2349,7 @@
Append :s[tart], :m[iddle], :e[nd] or :f[ull] to column names to change ellipsization. -
flatpak-remote-add — Add a remote repository
flatpak remote-add [OPTION...] NAME LOCATION
flatpak-remote-add — Add a remote repository
flatpak remote-add [OPTION...] NAME LOCATION
Adds a remote repository to the flatpak repository configuration. NAME is the name for the new remote, and LOCATION is a url or pathname. @@ -2314,7 +2395,7 @@
Unless overridden with the --user or --installation options, this command
changes the default system-wide installation.
-
The following options are understood:
-h, --help+
The following options are understood:
-h, --helpShow help options and exit.
--fromAssume the URI is a .flatpakrepo file rather than the repository itself. This is enabled @@ -2399,17 +2480,17 @@ Print debug information during command processing.
--ostree-verbosePrint OSTree debug information during command processing. -
flatpak-remote-delete — Delete a remote repository
flatpak remote-delete [OPTION...] NAME
flatpak-remote-delete — Delete a remote repository
flatpak remote-delete [OPTION...] NAME
Removes a remote repository from the flatpak repository configuration. NAME is the name of an existing remote.
@@ -2417,7 +2498,7 @@ this command uses either the default system-wide installation or the per-user one, depending on which has the specified REMOTE . -
The following options are understood:
-h, --help+
flatpak-remote-info — Show information about an application or runtime in a remote
flatpak remote-info [OPTION...] REMOTE REF
flatpak-remote-info — Show information about an application or runtime in a remote
flatpak remote-info [OPTION...] REMOTE REF
Shows information about the runtime or application REF from the remote repository with the name REMOTE . You can find all configured remote repositories with flatpak remotes. @@ -2454,7 +2535,7 @@ this command uses either the default system-wide installation or the per-user one, depending on which has the specified REMOTE . -
The following options are understood:
-h, --help+
flatpak-remote-ls — Show available runtimes and applications
flatpak remote-ls [OPTION...] [REMOTE]
flatpak-remote-ls — Show available runtimes and applications
flatpak remote-ls [OPTION...] [REMOTE]
Shows runtimes and applications that are available in the remote repository with the name REMOTE , or all remotes if one isn't specified. You can find all configured @@ -2524,7 +2605,7 @@ this command uses either the default system-wide installation or the per-user one, depending on which has the specified REMOTE . -
The following options are understood:
-h, --help+
The following options are understood:
-h, --helpShow help options and exit.
-u, --userUse the per-user configuration. @@ -2566,7 +2647,7 @@
Append :s[tart], :m[iddle], :e[nd] or :f[ull] to column names to change ellipsization. -
The following fields are understood by the --columns option:
Show the name
Show the application description @@ -2598,7 +2679,7 @@ Show the list of available columns
Note that field names can be abbreviated to a unique prefix. -
flatpak-remote-modify — Modify a remote repository
flatpak remote-modify [OPTION...] NAME
flatpak-remote-modify — Modify a remote repository
flatpak remote-modify [OPTION...] NAME
Modifies options for an existing remote repository in the flatpak repository configuration. NAME is the name for the remote.
@@ -2620,7 +2701,7 @@ this command uses either the default system-wide installation or the per-user one, depending on which has the specified REMOTE . -
The following options are understood:
-h, --help+
flatpak-remotes — List remote repositories
flatpak remotes [OPTION...]
Lists the known remote repositories, in priority order.
By default, both per-user and system-wide installations
are shown. Use the --user, --system or --installation
options to change this.
-
The following options are understood:
-h, --help+
The following options are understood:
-h, --helpShow help options and exit.
-u, --userShow the per-user configuration. @@ -2743,7 +2824,7 @@
Append :s[tart], :m[iddle], :e[nd] or :f[ull] to column names to change ellipsization. -
The following fields are understood by the --columns option:
Show the name of the remote
Show the title of the remote @@ -2771,15 +2852,15 @@ Show the list of available columns
Note that field names can be abbreviated to a unique prefix. -
flatpak-repair — Repair a flatpak installation
flatpak repair [OPTION...]
Repair a flatpak installation by pruning and reinstalling invalid objects. The repair command does all of the following:
Scan all locally available refs, removing any that don't correspond to a deployed ref. @@ -2796,7 +2877,7 @@ operate on the system installation.
An alternative command for repairing OSTree repositories is ostree fsck. -
The following options are understood:
-h, --help+
flatpak-repo — Show information about a local repository
flatpak repo [OPTION...] LOCATION
flatpak-repo — Show information about a local repository
flatpak repo [OPTION...] LOCATION
Show information about a local repository.
If you need to modify a local repository, see the flatpak build-update-repo command, or use the ostree tool. -
The following options are understood:
-h, --help+
flatpak-run — Run an application or open a shell in a runtime
flatpak run [OPTION...] REF [ARG...]
flatpak-run — Run an application or open a shell in a runtime
flatpak run [OPTION...] REF [ARG...]
If REF names an installed application, Flatpak runs the application in a sandboxed environment. Extra arguments are passed on to the application. The current branch and arch of @@ -2916,7 +2997,7 @@ If parental controls support is enabled, flatpak will check the current user’s parental controls settings, and will refuse to run an app if it is blocklisted for the current user. -
The following options are understood:
-h, --help+
The following options are understood:
-h, --helpShow help options and exit.
-u, --userLook for the application and runtime in per-user installations. @@ -3000,7 +3081,7 @@
--filesystem=FILESYSTEM
Allow the application access to a subset of the filesystem.
This overrides to the Context section from the application metadata.
- FILESYSTEM can be one of: home, host, host-os, host-etc, xdg-desktop, xdg-documents, xdg-download,
+ FILESYSTEM can be one of: home, host, host-os, host-etc, host-root, xdg-desktop, xdg-documents, xdg-download,
xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos,
xdg-run, xdg-config, xdg-cache, xdg-data,
an absolute path, or a homedir-relative path like ~/dir or paths
@@ -3220,7 +3301,7 @@
This option will usually only be useful if it is
combined with --app-path= and
--env=LD_LIBRARY_PATH=.
- ...
flatpak-search — Search for applications and runtimes
flatpak search TEXT
Searches for applications and runtimes matching TEXT . Note that this uses appstream data that can be updated with the flatpak update command. The appstream data is updated automatically only if it's at least a day old. -
The following options are understood:
-u, --user+
The following options are understood:
-u, --userOnly search through remotes in the per-user installation.
--systemOnly search through remotes in the default system-wide installation. @@ -3258,7 +3339,7 @@
Append :s[tart], :m[iddle], :e[nd] or :f[ull] to column names to change ellipsization. -
flatpak-uninstall — Uninstall an application or runtime
flatpak uninstall [OPTION...] [REF...]
flatpak-uninstall — Uninstall an application or runtime
flatpak uninstall [OPTION...] [REF...]
Uninstalls an application or runtime. REF is a reference to the application or runtime to uninstall.
@@ -3311,7 +3392,7 @@ options, this command searches both the system-wide installation and the per-user one for REF and errors out if it exists in more than one. -
The following options are understood:
-h, --help+
The following options are understood:
-h, --helpShow help options and exit.
--keep-refKeep the ref for the application and the objects belonging to it @@ -3354,9 +3435,9 @@ Print debug information during command processing.
--ostree-verbosePrint OSTree debug information during command processing. -
flatpak-update — Update an application or runtime
flatpak update [OPTION...] [REF...]
flatpak update [OPTION...] --appstream [REMOTE]
flatpak-update — Update an application or runtime
flatpak update [OPTION...] [REF...]
flatpak update [OPTION...] --appstream [REMOTE]
Updates applications and runtimes. REF is a reference to the application or runtime to update. If no REF is given, everything is updated, as well as appstream info for all remotes. @@ -3395,7 +3476,7 @@
Unless overridden with the --user, --system or --installation option, this command updates
any matching refs in the standard system-wide installation and the per-user one.
-
The following options are understood:
-h, --help+
flatpak-spawn — Run commands in a sandbox
flatpak-spawn [OPTION...] COMMAND [ARGUMENT...]
flatpak-spawn — Run commands in a sandbox
flatpak-spawn [OPTION...] COMMAND [ARGUMENT...]
Unlike other flatpak commands, flatpak-spawn is available
to applications inside the sandbox. It runs COMMAND
outside the sandbox: either in another sandbox, or on the host.
@@ -3463,7 +3544,7 @@
uses the Flatpak portal to create a copy of the sandbox it was called from,
optionally using tighter permissions and optionally the latest version of the
app and runtime (see --latest-version).
-
The following options are understood:
-h, --help+
The following options are understood:
-h, --helpShow help options and exit.
-v, --verbosePrint debug information @@ -3472,7 +3553,9 @@
--clear-envRun with a clean environment
--watch-bus- Make the spawned command exit if the caller disappears from the session bus + Make the spawned command exit when flatpak-spawn + itself exits; notably, this occurs when its connection to the + session bus is closed.
--env=VAR=VALUESet an environment variable
--latest-version@@ -3511,11 +3594,11 @@
Note that the given directory must exist in the sandbox or, when used in conjunction
with --host, on the host.
-
Table of Contents
Table of Contents
flatpakrepo — Reference to a remote
Flatpak uses flatpakrepo files to share information about remotes.
The flatpakrepo file contains enough information
to add the remote. Use the flatpak remote-add --from
@@ -3533,10 +3616,10 @@
.flatpakrepo extension. If a file with the
same name exists in both, the file under /etc will
take precedence.
-
The flatpakrepo file is using the same .ini file format that is used for systemd unit files or application .desktop files. -
+
All the information is contained in the [Flatpak Repo] group.
The following keys can be present in this group: @@ -3556,17 +3639,17 @@ It is recommended to use this key over DeployCollectionID or CollectionID because only newer clients (Flatpak 1.12.8 or later) pay attention to it (and older clients don't handle collection IDs properly). -
DeployCollectionID (string)This is deprecated but still supported for backwards compatibility. Use DeploySideloadCollectionID instead.
CollectionID (string)This is deprecated but still supported for backwards compatibility. Use DeploySideloadCollectionID instead.
[Flatpak Repo] Title=gedit Url=http://sdk.gnome.org/repo-apps/ GPGKey=mQENBFUUCGcBCAC/K9WeV4xCaKr3NKRqPXeY5mpaXAJyasLqCtrDx92WUgbu0voWrhohNAKpqizod2dvzc/XTxm3rHyIxmNfdhz1gaGhynU75Qw4aJVcly2eghTIl++gfDtOvrOZo/VuAq30f32dMIgHQdRwEpgCwz7WyjpqZYltPAEcCNL4MTChAfiHJeeiQ5ibystNBW8W6Ymf7sO4m4g5+/aOxI54oCOzD9TwBAe+yXcJJWtc2rAhMCjtyPJzxd0ZVXqIzCe1xRvJ6Rq7YCiMbiM2DQFWXKnmYQbj4TGNMnwNdAajCdrcBWEMSbzq7EzuThIJRd8Ky4BkEe1St6tuqwFaMZz+F9eXABEBAAG0KEdub21lIFNESyAzLjE2IDxnbm9tZS1vcy1saXN0QGdub21lLm9yZz6JATgEEwECACIFAlUUCGcCGwMGCwkIBwMCBhUIAgkKCwQWAgMBAh4BAheAAAoJEArkz6VV0VKBa5cH/0vXa31YgEjNk78gGFXqnQxdD1WYA87OYxDi189l4lA802EFTF4wCBuZyDOqdd5BhS3Ab0cR778DmZXRUP2gwe+1zTJypU2JMnDpkwJ4NK1VP6/tE4SAPrznBtmb76BKaWBqUfZ9Wq1zg3ugvqkZB/Exq+usypIOwQVp1KL58TrjBRda0HvRctzkNhr0qYAtkfLFe0GvksBp4vBm8uGwAx7fw/HbhIjQ9pekTwvB+5GwDPO/tSip/1bQfCS+XJB8Ffa04HYPLGedalnWBrwhYY+G/kn5Zh9L/AC8xeLwTJTHM212rBjPa9CWs9C6a57MSaeGIEHLC1hEyiJJ15w8jmY= DeployCollectionID=org.gnome.Apps -
flatpakref — Reference to a remote for an application or runtime
Flatpak uses flatpakref files to share information about a remote for
a single application. The flatpakref file contains
enough information to add the remote and install the application.
@@ -3578,10 +3661,10 @@
The filename extension commonly used for flatpakref files is .flatpakref.
A flatpakref file can also refer to a remote for a runtime. -
The flatpakref file is using the same .ini file format that is used for systemd unit files or application .desktop files. -
+
All the information is contained in the [Flatpak Ref] group.
The following keys can be present in this group: @@ -3594,7 +3677,7 @@ collection IDs properly).
DeployCollectionID (string)This is deprecated but still supported for backwards compatibility. Use DeploySideloadCollectionID instead.
CollectionID (string)This is deprecated but still supported for backwards compatibility. Use DeploySideloadCollectionID instead.
IsRuntime (boolean)Whether this file refers to a runtime. If this key is not specified, the file is assumed to refer to an application.
GPGKey (string)The base64-encoded gpg key for the remote.
RuntimeRepo (string)The url for a .flatpakrepo file for the remote where the runtime can be found. Note that if the runtime is available in the remote providing the app, that remote may be - used instead but the one specified by this option will still be added.
SuggestRemoteName (string)A suggested name for the remote.
[Flatpak Ref] Title=gedit Name=org.gnome.gedit @@ -3603,11 +3686,11 @@ IsRuntime=false GPGKey=mQENBFUUCGcBCAC/K9WeV4xCaKr3NKRqPXeY5mpaXAJyasLqCtrDx92WUgbu0voWrhohNAKpqizod2dvzc/XTxm3rHyIxmNfdhz1gaGhynU75Qw4aJVcly2eghTIl++gfDtOvrOZo/VuAq30f32dMIgHQdRwEpgCwz7WyjpqZYltPAEcCNL4MTChAfiHJeeiQ5ibystNBW8W6Ymf7sO4m4g5+/aOxI54oCOzD9TwBAe+yXcJJWtc2rAhMCjtyPJzxd0ZVXqIzCe1xRvJ6Rq7YCiMbiM2DQFWXKnmYQbj4TGNMnwNdAajCdrcBWEMSbzq7EzuThIJRd8Ky4BkEe1St6tuqwFaMZz+F9eXABEBAAG0KEdub21lIFNESyAzLjE2IDxnbm9tZS1vcy1saXN0QGdub21lLm9yZz6JATgEEwECACIFAlUUCGcCGwMGCwkIBwMCBhUIAgkKCwQWAgMBAh4BAheAAAoJEArkz6VV0VKBa5cH/0vXa31YgEjNk78gGFXqnQxdD1WYA87OYxDi189l4lA802EFTF4wCBuZyDOqdd5BhS3Ab0cR778DmZXRUP2gwe+1zTJypU2JMnDpkwJ4NK1VP6/tE4SAPrznBtmb76BKaWBqUfZ9Wq1zg3ugvqkZB/Exq+usypIOwQVp1KL58TrjBRda0HvRctzkNhr0qYAtkfLFe0GvksBp4vBm8uGwAx7fw/HbhIjQ9pekTwvB+5GwDPO/tSip/1bQfCS+XJB8Ffa04HYPLGedalnWBrwhYY+G/kn5Zh9L/AC8xeLwTJTHM212rBjPa9CWs9C6a57MSaeGIEHLC1hEyiJJ15w8jmY= DeployCollectionID=org.gnome.Apps -
flatpak-installation — Configuration for an installation location
flatpak can operate in system-wide or per-user mode. The system-wide data
is located in $prefix/var/lib/flatpak/, and the per-user data is in
$HOME/.local/share/flatpak/.
@@ -3615,20 +3698,20 @@
In addition to the default installation locations, more system-wide installations
can be defined via configuration files /etc/flatpak/installations.d/,
which must have the .conf extension and follow the format described below.
-
The installation config file format is using the same .ini file format that is used for systemd unit files or application .desktop files. -
+
All the configuration for the the installation location with name NAME is contained in the [Installation "NAME"] group.
The following keys are recognized: -
Path (string)The path for this installation. This key is mandatory.
DisplayName (string)The name to use when showing this installation in the UI.
Priority (integer)A priority for this installation.
StorageType (string)The type of storage used for this installation. Possible values include: network, mmc, sdcard, harddisk.
+
Path(string)The path for this installation. This key is mandatory.
DisplayName(string)The name to use when showing this installation in the UI.
Priority(integer)A priority for this installation.
StorageType(string)The type of storage used for this installation. Possible values include: network, mmc, sdcard, harddisk.
flatpak-metadata — Information about an application or runtime
Flatpak uses metadata files to describe applications and runtimes.
The metadata file for a deployed application or
runtime is placed in the toplevel deploy directory. For example, the
@@ -3645,7 +3728,7 @@
For compatibility with older Flatpak versions,
/run/user/$UID/flatpak-info is a symbolic
link to the same file.
-
The metadata file is using the same .ini file format that is used for systemd unit files or application .desktop files.
@@ -3826,6 +3909,37 @@
at /run/host/etc.
Available since 1.7. +
host-root+ The complete host operating system. +
+ To avoid conflicting with the Flatpak
+ runtime, this is mounted in the sandbox
+ at /run/host/root.
+
+ This permission is only intended to be used + as a last resort when there is no possible + alternative with other filesystem + permissions for applications that need the + entire root filesystem of the host. +
+ Please note that following symlinks under
+ /run/host/root naively
+ will result in a wrong path. For example,
+ using realpath() is wrong.
+ Instead, applications will have to implement
+ some way of following symlinks in a way that
+ behaves as if it were chroot'd into
+ /run/host/root.
+
+ There are a few ways to do this. Modern
+ kernels support the openat2()
+ call with RESOLVE_IN_ROOT.
+ For a more portable solution with support for
+ older kernels, see the implementation from
+ the steam-runtime-tools
+ as an example.
+
+ Available since 1.17.
xdg-desktop,
xdg-documents,
xdg-download,
@@ -4285,7 +4399,7 @@
devices list. Each element is the same syntax the arguments
to `--nousb`. Hidden devices take precedence over enumerable
devices. Available since 1.15.11.
- flatpak-remote — Configuration for a remote
Flatpak stores information about configured remotes for an installation location in
$installation/repo/config. For example, the remotes for the
default system-wide installation are in
@@ -4333,10 +4447,10 @@
/etc/flatpak/remotes.d/. Ifa file with
the same name exists in both, the file under
/etc will take precedence.
-
The remote config file format is using the same .ini file format that is used for systemd unit files or application .desktop files. -
+
All the configuration for the the remote with name NAME is contained in the [remote "NAME"] group.
@@ -4356,7 +4470,7 @@
xa.disable (boolean)Whether the remote is disabled. Defaults to false.
xa.prio (integer)The priority for the remote. This is used when listing remotes, and when searching them for the runtime needed by an app. The remote providing the app is searched for its runtime before others with equal priority. Defaults to 1.
xa.noenumerate (boolean)Whether this remote should be ignored when presenting available apps/runtimes, - or when searching for a runtime dependency. Defaults to false.
xa.nodeps (boolean)Whether this remote should be excluded when searching for dependencies. Defaults to false.
xa.title (string)An optional title to use when presenting this remote in a UI.
xa.title-is-set (boolean)This key is set to true if xa.title has been explicitly set.
xa.comment (string)An optional single-line comment to use when presenting this remote in a UI.
xa.comment-is-set (boolean)This key is set to true if xa.comment has been explicitly set.
xa.description (string)An optional full-paragraph of text to use when presenting this remote in a UI.
xa.description-is-set (boolean)This key is set to true if xa.description has been explicitly set.
xa.homepage (string)An optional URL that points to a website for this repository to use when presenting this remote in a UI.
xa.homepage-is-set (boolean)This key is set to true if xa.homepage has been explicitly set.
xa.icon (string)An optional URL that points to an icon for this repository to use when presenting this remote in a UI.
xa.icon-is-set (boolean)This key is set to true if xa.icon has been explicitly set.
xa.default-branch (string)The default branch to use when installing from this remote.
xa.default-branch-is-set (boolean)This key is set to true if xa.default-branch has been explicitly set.
xa.main-ref (string)The main reference served by this remote. This is used for origin remotes of applications installed via a flatpakref file.
+ or when searching for a runtime dependency. Defaults to false.
xa.nodeps (boolean)Whether this remote should be excluded when searching for dependencies. Defaults to false.
xa.title (string)An optional title to use when presenting this remote in a UI.
xa.title-is-set (boolean)This key is set to true if xa.title has been explicitly set.
xa.comment (string)An optional single-line comment to use when presenting this remote in a UI.
xa.comment-is-set (boolean)This key is set to true if xa.comment has been explicitly set.
xa.description (string)An optional full-paragraph of text to use when presenting this remote in a UI.
xa.description-is-set (boolean)This key is set to true if xa.description has been explicitly set.
xa.homepage (string)An optional URL that points to a website for this repository to use when presenting this remote in a UI.
xa.homepage-is-set (boolean)This key is set to true if xa.homepage has been explicitly set.
xa.icon (string)An optional URL that points to an icon for this repository to use when presenting this remote in a UI.
xa.icon-is-set (boolean)This key is set to true if xa.icon has been explicitly set.
xa.default-branch (string)The default branch to use when installing from this remote.
xa.default-branch-is-set (boolean)This key is set to true if xa.default-branch has been explicitly set.
xa.main-ref (string)The main reference served by this remote. This is used for origin remotes of applications installed via a flatpakref file.
- For flatpak 1.9.1 +
Table of Contents
Table of Contents
FlatpakInstallation — Installation information
| FlatpakInstallation *
+ Table of Contents
Table of Contents
NameFlatpakInstallation — Installation information Functions
flatpak_installation_uninstall_full ()gboolean flatpak_installation_uninstall_full ( | [nullable] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
progress | the callback. | [scope call][closure progress_data][nullable] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
progress_data | user data passed to | [nullable] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cancellable | a GCancellable. | [nullable] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
error | return location for a GError |
Since: 0.11.8
gboolean flatpak_installation_launch (FlatpakInstallation *self,const char *name,const char *arch, @@ -206,7 +206,7 @@flatpak_installation_get_current_installed_app()to find out what builds are available, in order to get a value forcommit.Parameters
self
name
name of the app to launch
arch
which architecture to launch (default: current architecture).
[nullable] branch
which branch of the application (default: "master").
[nullable] commit
the commit of
branch-to launch.[nullable] cancellable
a GCancellable.
[nullable] error
return location for a GError
gboolean +to launch.[nullable] cancellable
a GCancellable.
[nullable] error
return location for a GError
gboolean flatpak_installation_launch_full (FlatpakInstallation *self,FlatpakLaunchFlags flags,const char *name, @@ -222,7 +222,7 @@ that can be used to get information about the running instance. You can also use it to wait for the instance to be done withg_child_watch_add()if you pass the FLATPAK_LAUNCH_FLAGS_DO_NOT_REAP flag.Parameters
self
flags
set of FlatpakLaunchFlags
name
name of the app to launch
arch
which architecture to launch (default: current architecture).
[nullable] branch
which branch of the application (default: "master").
[nullable] commit
the commit of
branch-to launch.[nullable] instance_out
return location for a FlatpakInstance.
[nullable] cancellable
a GCancellable.
[nullable] error
return location for a GError
Since: 1.1
FlatpakInstalledRef * +to launch.[nullable] instance_out
return location for a FlatpakInstance.
[nullable] cancellable
a GCancellable.
[nullable] error
return location for a GError
Since: 1.1
FlatpakInstalledRef * flatpak_installation_get_current_installed_app (FlatpakInstallation *self,const char *name, @@ -230,13 +230,13 @@GError **error);
Get the last build of reference name
that was installed with
flatpak_installation_install(), or NULL if the reference has
-never been installed locally.
self | ||
name | the name of the app | |
cancellable | a GCancellable. | [nullable] |
error | return location for a GError |
const char * +never been installed locally.Parameters
self
name
the name of the app
cancellable
a GCancellable.
[nullable] error
return location for a GError
const char *
flatpak_installation_get_display_name (FlatpakInstallation *self);Returns the display name of the installation for self
.
Note that this function may return NULL if the installation
-does not have a display name.
Since: 0.8
const char *
flatpak_installation_get_id (FlatpakInstallation *self);Returns the ID of the installation for self
.
The ID for the default system installation is "default". -The ID for the user installation is "user".
Since: 0.8
FlatpakInstalledRef * +The ID for the user installation is "user".Since: 0.8
FlatpakInstalledRef * flatpak_installation_get_installed_ref (FlatpakInstallation *self,FlatpakRefKind kind, @@ -245,36 +245,36 @@const char *branch,GCancellable *cancellable,GError **error);
Returns information about an installed ref, such as the available builds, -its size, location, etc.
self | ||
kind | whether this is an app or runtime | |
name | name of the app/runtime to fetch | |
arch | which architecture to fetch (default: current architecture). | [nullable] |
branch | which branch to fetch (default: "master"). | [nullable] |
cancellable | a GCancellable. | [nullable] |
error | return location for a GError |
gboolean +its size, location, etc.Parameters
self
kind
whether this is an app or runtime
name
name of the app/runtime to fetch
arch
which architecture to fetch (default: current architecture).
[nullable] branch
which branch to fetch (default: "master").
[nullable] cancellable
a GCancellable.
[nullable] error
return location for a GError
gboolean flatpak_installation_get_min_free_space_bytes (FlatpakInstallation *self,guint64 *out_bytes,GError **error);
Returns the min-free-space config value from the OSTree repository of this installation.
Applications can use this value, together with information about the available disk space and the size of pending updates or installs, to estimate whether a -pull operation will fail due to running out of disk space.
Since: 1.1
gint +pull operation will fail due to running out of disk space.Since: 1.1
gint
flatpak_installation_get_priority (FlatpakInstallation *self);Returns the numeric priority of the installation for self
-.
Since: 0.8
FlatpakStorageType
flatpak_installation_get_storage_type (FlatpakInstallation *self);Returns the type of storage of the installation for self
-.
Since: 0.8
void flatpak_installation_set_no_interaction (FlatpakInstallation *self,gboolean no_interaction);
This method can be used to prevent interactive authorization dialogs to appear
for operations on self
. This is useful for background operations that are not
-directly triggered by a user action.
By default, interaction is allowed.
Since: 1.1.1
gboolean +directly triggered by a user action.By default, interaction is allowed.
Since: 1.1.1
gboolean
flatpak_installation_get_no_interaction
- (FlatpakInstallation *self);Returns the value set with flatpak_installation_set_no_interaction().
Since: 1.1.1
GPtrArray *
+ (FlatpakInstallation *self);Returns the value set with flatpak_installation_set_no_interaction().
Since: 1.1.1
GPtrArray * flatpak_installation_list_installed_refs (FlatpakInstallation *self,GCancellable *cancellable,GError **error);
Lists the installed references.
a GPtrArray of -FlatpakInstalledRef instances.
[transfer container][element-type FlatpakInstalledRef]
GPtrArray * +FlatpakInstalledRef instances.[transfer container][element-type FlatpakInstalledRef]
GPtrArray * flatpak_installation_list_installed_refs_by_kind (FlatpakInstallation *self,FlatpakRefKind kind,GCancellable *cancellable,GError **error);
Lists the installed references of a specific kind.
self | ||
kind | the kind of installation | |
cancellable | a GCancellable. | [nullable] |
error | return location for a GError |
a GPtrArray of -FlatpakInstalledRef instances.
[transfer container][element-type FlatpakInstalledRef]
GPtrArray * +FlatpakInstalledRef instances.[transfer container][element-type FlatpakInstalledRef]
GPtrArray * flatpak_installation_list_installed_refs_for_update (FlatpakInstallation *self,GCancellable *cancellable, @@ -285,24 +285,27 @@ ref to the returning GPtrArray to pull in the FlatpakRelatedRef or runtime again via an update operation in FlatpakTransaction.In case more than one app needs an update of the same runtime or extension, this function will return all of those apps.
Returns
a GPtrArray of -FlatpakInstalledRef instances, or
NULLon error.[transfer container][element-type FlatpakInstalledRef]
GPtrArray * +FlatpakInstalledRef instances, orNULLon error.[transfer container][element-type FlatpakInstalledRef]
GPtrArray * flatpak_installation_list_installed_related_refs_sync (FlatpakInstallation *self,const char *remote_name,const char *ref,GCancellable *cancellable, -GError **error);
Lists all the locally installed refs from remote_name
- that are
-related to ref
-. These are things that are interesting to install,
-update, or uninstall together with ref
-. For instance, locale data
-or debug information.
This function is similar to flatpak_installation_list_remote_related_refs_sync,
+ GError **error);
Lists all the locally installed refs that are related to ref
+. These are
+things that are interesting to install, update, or uninstall together with
+ref
+. For instance, locale data or debug information.
Note that while the related refs are usually installed from the same remote
+as ref
+ (remote_name
+), it is possible they were installed from another
+remote.
This function is similar to flatpak_installation_list_remote_related_refs_sync, but instead of looking at what is available on the remote, it only looks at the locally installed refs. This is useful for instance when you're looking for related refs to uninstall, or when you're planning to use -FLATPAK_UPDATE_FLAGS_NO_PULL to install previously pulled refs.
self | ||
remote_name | the name of the remote | |
ref | the ref | |
cancellable | a GCancellable. | [nullable] |
error | return location for a GError |
a GPtrArray of -FlatpakRelatedRef instances.
[transfer container][element-type FlatpakRelatedRef]
Since: 0.6.7
GPtrArray * +FLATPAK_UPDATE_FLAGS_NO_PULL to install previously pulled refs.Parameters
self
remote_name
the name of the remote providing
ref+ref
the ref
cancellable
a GCancellable.
[nullable] error
return location for a GError
Returns
a GPtrArray of +FlatpakRelatedRef instances.
[transfer container][element-type FlatpakRelatedRef]
Since: 0.6.7
GPtrArray * flatpak_installation_list_unused_refs (FlatpakInstallation *self,const char *arch,GCancellable *cancellable, @@ -310,20 +313,20 @@ or the runtime or sdk of a used ref, or an extension of a used ref. Pinned runtimes are also considered used; see flatpak-pin(1) andflatpak_installation_list_pinned_refs().Parameters
self
arch
if non-
NULL, the architecture of refs to collect.[nullable] cancellable
a GCancellable.
[nullable] error
return location for a GError
Returns
a GPtrArray of -FlatpakInstalledRef instances.
[transfer container][element-type FlatpakInstalledRef]
Since: 1.1.2
GPtrArray * +FlatpakInstalledRef instances.[transfer container][element-type FlatpakInstalledRef]
Since: 1.1.2
GPtrArray * flatpak_installation_list_remote_refs_sync (FlatpakInstallation *self,const char *remote_or_uri,GCancellable *cancellable,GError **error);
Lists all the applications and runtimes in a remote.
self | ||
remote_or_uri | the name or URI of the remote | |
cancellable | a GCancellable. | [nullable] |
error | return location for a GError |
a GPtrArray of -FlatpakRemoteRef instances.
[transfer container][element-type FlatpakRemoteRef]
GPtrArray * +FlatpakRemoteRef instances.[transfer container][element-type FlatpakRemoteRef]
GPtrArray * flatpak_installation_list_remote_refs_sync_full (FlatpakInstallation *self,const char *remote_or_uri,FlatpakQueryFlags flags,GCancellable *cancellable,GError **error);
Lists all the applications and runtimes in a remote.
self | ||
remote_or_uri | the name or URI of the remote | |
flags | set of FlatpakQueryFlags | |
cancellable | a GCancellable. | [nullable] |
error | return location for a GError |
a GPtrArray of -FlatpakRemoteRef instances.
[transfer container][element-type FlatpakRemoteRef]
Since: 1.3.3
GPtrArray * +FlatpakRemoteRef instances.[transfer container][element-type FlatpakRemoteRef]
Since: 1.3.3
GPtrArray * flatpak_installation_list_remotes_by_type (FlatpakInstallation *self,const FlatpakRemoteType types[], @@ -334,7 +337,7 @@ Equivalent functionallity to FLATPAK_REMOTE_TYPE_USB can be had by listing remote refs with FLATPAK_QUERY_FLAGS_ONLY_SIDELOADED.Parameters
self
types
an array of FlatpakRemoteType.
[array length=num_types] num_types
the number of types provided in
typescancellable
a GCancellable.
[nullable] error
return location for a GError
GPtrArray * +FlatpakRemote instances.[transfer container][element-type FlatpakRemote]
GPtrArray * flatpak_installation_list_remote_related_refs_sync (FlatpakInstallation *self,const char *remote_name, @@ -353,18 +356,18 @@flatpak_related_ref_should_delete()returnsTRUEif it should be uninstalled with the main ref.The commit property of each FlatpakRelatedRef is not guaranteed to be non-
NULL.Parameters
self
remote_name
the name of the remote
ref
the ref
cancellable
a GCancellable.
[nullable] error
return location for a GError
Returns
a GPtrArray of -FlatpakRelatedRef instances.
[transfer container][element-type FlatpakRelatedRef]
Since: 0.6.7
GPtrArray * +FlatpakRelatedRef instances.[transfer container][element-type FlatpakRelatedRef]
Since: 0.6.7
GPtrArray * flatpak_installation_list_remotes (FlatpakInstallation *self,GCancellable *cancellable,GError **error);
Lists the static remotes, in priority (highest first) order. For same priority, an earlier added remote comes before a later added one.
FlatpakRemote * +FlatpakRemote instances.[transfer container][element-type FlatpakRemote]
FlatpakRemote * flatpak_installation_get_remote_by_name (FlatpakInstallation *self,const gchar *name,GCancellable *cancellable,GError **error);
Looks up a remote by name.
self | ||
name | a remote name | |
cancellable | a GCancellable. | [nullable] |
error | return location for a GError |
GBytes * flatpak_installation_fetch_remote_metadata_sync (FlatpakInstallation *self,const char *remote_name, @@ -372,7 +375,7 @@GCancellable *cancellable,GError **error);
Obtains the metadata file from a commit.
NOTE: Since 0.11.4 this information is accessible in FlatpakRemoteRef, so this function is not very useful anymore.
self | ||
remote_name | the name of the remote | |
ref | the ref | |
cancellable | a GCancellable. | [nullable] |
error | return location for a GError |
FlatpakRemoteRef * +orNULLif an error occurred.[transfer full]
FlatpakRemoteRef * flatpak_installation_fetch_remote_ref_sync (FlatpakInstallation *self,const char *remote_name, @@ -381,7 +384,7 @@const char *arch,const char *branch,GCancellable *cancellable, -GError **error);
Gets the current remote branch of a ref in the remote.
self | ||
remote_name | the name of the remote | |
kind | what this ref contains (an FlatpakRefKind) | |
name | name of the app/runtime to fetch | |
arch | which architecture to fetch (default: current architecture). | [nullable] |
branch | which branch to fetch (default: 'master'). | [nullable] |
cancellable | a GCancellable. | [nullable] |
error | return location for a GError |
FlatpakRemoteRef *
+ GError **error);Gets the current remote branch of a ref in the remote.
self | ||
remote_name | the name of the remote | |
kind | what this ref contains (an FlatpakRefKind) | |
name | name of the app/runtime to fetch | |
arch | which architecture to fetch (default: current architecture). | [nullable] |
branch | which branch to fetch (default: 'master'). | [nullable] |
cancellable | a GCancellable. | [nullable] |
error | return location for a GError |
FlatpakRemoteRef * flatpak_installation_fetch_remote_ref_sync_full (FlatpakInstallation *self,const char *remote_name, @@ -391,7 +394,7 @@const char *branch,FlatpakQueryFlags flags,GCancellable *cancellable, -GError **error);
Gets the current remote branch of a ref in the remote.
self | ||
remote_name | the name of the remote | |
kind | what this ref contains (an FlatpakRefKind) | |
name | name of the app/runtime to fetch | |
arch | which architecture to fetch (default: current architecture). | [nullable] |
branch | which branch to fetch (default: 'master'). | [nullable] |
flags | set of FlatpakQueryFlags | |
cancellable | a GCancellable. | [nullable] |
error | return location for a GError |
Since: 1.3.3
gboolean
+ GError **error);Gets the current remote branch of a ref in the remote.
self | ||
remote_name | the name of the remote | |
kind | what this ref contains (an FlatpakRefKind) | |
name | name of the app/runtime to fetch | |
arch | which architecture to fetch (default: current architecture). | [nullable] |
branch | which branch to fetch (default: 'master'). | [nullable] |
flags | set of FlatpakQueryFlags | |
cancellable | a GCancellable. | [nullable] |
error | return location for a GError |
Since: 1.3.3
gboolean flatpak_installation_fetch_remote_size_sync (FlatpakInstallation *self,const char *remote_name, @@ -404,13 +407,13 @@ local disk space that is required to check out this commit.Note that if there are locally available data that are in the ref, which is common for instance if you're doing an update then the real download size may be smaller than what is returned here.
NOTE: Since 0.11.4 this information is accessible in FlatpakRemoteRef, so this -function is not very useful anymore.
Parameters
self
remote_name
the name of the remote
ref
the ref
download_size
return location for the (maximum) download size.
[out] installed_size
return location for the installed size.
[out] cancellable
a GCancellable.
[nullable] error
return location for a GError
char * +function is not very useful anymore.Parameters
self
remote_name
the name of the remote
ref
the ref
download_size
return location for the (maximum) download size.
[out] installed_size
return location for the installed size.
[out] cancellable
a GCancellable.
[nullable] error
return location for a GError
char * flatpak_installation_load_app_overrides (FlatpakInstallation *self,const char *app_id,GCancellable *cancellable,GError **error);
Loads the metadata overrides file for an application.
self | ||
app_id | an application id | |
cancellable | a GCancellable. | [nullable] |
error | return location for a GError |
gboolean +orNULLif an error occurred.[transfer full]
gboolean flatpak_installation_update_appstream_sync (FlatpakInstallation *self,const char *remote_name, @@ -420,7 +423,7 @@GError **error);
Updates the local copy of appstream for remote_name
for the specified arch
.
-If you need progress feedback, use flatpak_installation_update_appstream_full_sync().
self | ||
remote_name | the name of the remote | |
arch | Architecture to update, or | [nullable] |
out_changed | Set to | [nullable] |
cancellable | a GCancellable. | [nullable] |
error | return location for a GError |
FlatpakInstalledRef * +If you need progress feedback, useflatpak_installation_update_appstream_full_sync().Parameters
self
remote_name
the name of the remote
arch
Architecture to update, or
NULLfor the local machine arch.[nullable] out_changed
Set to
TRUEif the contents of the appstream changed,FALSEif nothing changed.[nullable] cancellable
a GCancellable.
[nullable] error
return location for a GError
FlatpakInstalledRef * flatpak_installation_install_bundle (FlatpakInstallation *self,GFile *file,FlatpakProgressCallback progress, @@ -429,8 +432,8 @@GError **error);
flatpak_installation_install_bundle has been deprecated since version 1.7.0 and should not be used in newly-written code.
Use flatpak_transaction_add_install_bundle() instead.
This is an old deprecated function, you should use
FlatpakTransaction and flatpak_transaction_add_install_bundle()
instead. It has a lot more interesting features.
Install an application or runtime from an flatpak bundle file. -See flatpak-build-bundle(1) for how to create bundles.
self | ||
file | a GFile that is an flatpak bundle | |
progress | progress callback. | [scope call][nullable] |
progress_data | user data passed to | [closure progress][nullable] |
cancellable | a GCancellable. | [nullable] |
error | return location for a GError |
FlatpakRemoteRef * +See flatpak-build-bundle(1) for how to create bundles.Parameters
self
file
a GFile that is an flatpak bundle
progress
progress callback.
[scope call][closure progress_data][nullable] progress_data
user data passed to
progress+.[nullable] cancellable
a GCancellable.
[nullable] error
return location for a GError
FlatpakRemoteRef * flatpak_installation_install_ref_file (FlatpakInstallation *self,GBytes *ref_file_data,GCancellable *cancellable, @@ -442,11 +445,11 @@ to install it.Note, the FlatpakRemoteRef will not have the commit field set, or other details, to avoid unnecessary roundtrips. If you need that you have to resolve it explicitly with
flatpak_installation_fetch_remote_ref_sync().Parameters
self
ref_file_data
The ref file contents
cancellable
a GCancellable.
[nullable] error
return location for a GError
Returns
a FlatpakRemoteRef if the remote has been added successfully,
NULL-on error.[transfer full]
Since: 0.6.10
Since: 0.6.10
gboolean flatpak_installation_drop_caches (FlatpakInstallation *self,GCancellable *cancellable,GError **error);
Drops all internal (in-memory) caches. For instance, this may be needed to pick up new or changed -remotes configured outside this installation instance.
gboolean +remotes configured outside this installation instance.
gboolean flatpak_installation_add_remote (FlatpakInstallation *self,FlatpakRemote *remote,gboolean if_needed, @@ -462,23 +465,23 @@ unfiltered .flatpakref viaflatpak_remote_new_from_file()) the the local remote filter gets reset. This is to allow the setup where there is a default setup of a filtered remote, yet you can still use the standard -flatpakref file to get the full contents without getting two remotes.Parameters
self
remote
the new FlatpakRemote
if_needed
if
TRUE, only add if it doesn't existscancellable
a GCancellable.
[nullable] error
return location for a GError
Since: 1.3.4
gboolean +flatpakref file to get the full contents without getting two remotes.Parameters
self
remote
the new FlatpakRemote
if_needed
if
TRUE, only add if it doesn't existscancellable
a GCancellable.
[nullable] error
return location for a GError
Since: 1.3.4
gboolean flatpak_installation_modify_remote (FlatpakInstallation *self,FlatpakRemote *remote,GCancellable *cancellable,GError **error);
Saves changes in the remote
- object.
self | ||
remote | the modified FlatpakRemote | |
cancellable | a GCancellable. | [nullable] |
error | return location for a GError |
gboolean + object.Parameters
self
remote
the modified FlatpakRemote
cancellable
a GCancellable.
[nullable] error
return location for a GError
gboolean flatpak_installation_remove_remote (FlatpakInstallation *self,const char *name,GCancellable *cancellable, -GError **error);
Removes the remote with the given name from the installation.
self | ||
name | the name of the remote to remove | |
cancellable | a GCancellable. | [nullable] |
error | return location for a GError |
gboolean
+ GError **error);Removes the remote with the given name from the installation.
self | ||
name | the name of the remote to remove | |
cancellable | a GCancellable. | [nullable] |
error | return location for a GError |
gboolean flatpak_installation_update_remote_sync (FlatpakInstallation *self,const char *name,GCancellable *cancellable,GError **error);
Updates the local configuration of a remote repository by fetching the related information from the summary file in the remote OSTree -repository and committing the changes to the local installation.
self | ||
name | the name of the remote to update | |
cancellable | a GCancellable. | [nullable] |
error | return location for a GError |
Since: 0.6.13
gboolean +repository and committing the changes to the local installation.Parameters
self
name
the name of the remote to update
cancellable
a GCancellable.
[nullable] error
return location for a GError
Since: 0.6.13
gboolean flatpak_installation_cleanup_local_refs_sync (FlatpakInstallation *self,GCancellable *cancellable, @@ -491,29 +494,29 @@ from taking up disk space. Note that this will not remove the objects referred to byreffrom the underlying OSTree repo, you should use -flatpak_installation_prune_local_repo()to do that.Since: 0.10.0
char * +flatpak_installation_prune_local_repo()to do that.Since: 0.10.0
char * flatpak_installation_get_config (FlatpakInstallation *self,const char *key,GCancellable *cancellable,GError **error);
Get a global configuration option for the installation, see
-flatpak_installation_set_config_sync() for supported keys.
self | ||
key | the name of the key to get | |
cancellable | a GCancellable. | [nullable] |
error | return location for a GError |
The (newly allocated) value, or NULL on error (G_KEY_FILE_ERROR_KEY_NOT_FOUND error if key is not set)
char ** +flatpak_installation_set_config_sync()for supported keys.Parameters
self
key
the name of the key to get
cancellable
a GCancellable.
[nullable] error
return location for a GError
Returns
The (newly allocated) value, or
NULLon error (G_KEY_FILE_ERROR_KEY_NOT_FOUNDerror if key is not set)
char ** flatpak_installation_get_default_languages (FlatpakInstallation *self,GError **error);
Get the default languages used by the installation to decide which subpaths to install of locale extensions. This list may also be used by frontends like GNOME Software to decide which language-specific apps -to display. An empty array means that all languages should be installed.
A possibly empty array of strings, or NULL on error.
[array zero-terminated=1][element-type utf8][transfer full]
Since: 1.5.0
char ** +to display. An empty array means that all languages should be installed.Returns
A possibly empty array of strings, or
NULLon error.[array zero-terminated=1][element-type utf8][transfer full]
Since: 1.5.0
char ** flatpak_installation_get_default_locales (FlatpakInstallation *self,GError **error);
Like flatpak_installation_get_default_languages() but includes territory
information (e.g. en_US rather than en) which may be included in the
extra-languages configuration.
Strings returned by this function are in the format specified by
-setlocale(): language[_territory][.codeset][@modifier].
A possibly empty array of locale strings, or NULL on error.
[array zero-terminated=1][element-type utf8][transfer full]
Since: 1.5.1
gboolean +setlocale():language[_territory][.codeset][@modifier].Returns
A possibly empty array of locale strings, or
NULLon error.[array zero-terminated=1][element-type utf8][transfer full]
Since: 1.5.1
gboolean flatpak_installation_prune_local_repo (FlatpakInstallation *self,GCancellable *cancellable,GError **error);
Remove all orphaned OSTree objects from the underlying OSTree repo in
self
-.
Since: 0.10.0
gboolean +.Since: 0.10.0
gboolean flatpak_installation_remove_local_ref_sync (FlatpakInstallation *self,const char *remote_name, @@ -530,7 +533,7 @@ from taking up disk space. Note that this will not remove the objects referred to byreffrom the underlying OSTree repo, you should use -flatpak_installation_prune_local_repo()to do that.Parameters
self
remote_name
the name of the remote
ref
the ref
cancellable
a GCancellable.
[nullable] error
return location for a GError
Since: 0.10.0
gboolean +flatpak_installation_prune_local_repo()to do that.Parameters
self
remote_name
the name of the remote
ref
the ref
cancellable
a GCancellable.
[nullable] error
return location for a GError
Since: 0.10.0
gboolean flatpak_installation_set_config_sync (FlatpakInstallation *self,const char *key,const char *value, @@ -539,7 +542,7 @@ the only supported keys arelanguages, which is a semicolon-separated list of language codes like"sv;en;pl", or""to mean all languages, andextra-languages, which is a semicolon-separated list of locale -identifiers like"en;en_DK;zh_HK.big5hkscs;uz_UZ.utf8@cyrillic".Parameters
self
key
the name of the key to set
value
the new value, or
NULLto unsetcancellable
a GCancellable.
[nullable] error
return location for a GError
gboolean +identifiers like"en;en_DK;zh_HK.big5hkscs;uz_UZ.utf8@cyrillic".Parameters
self
key
the name of the key to set
value
the new value, or
NULLto unsetcancellable
a GCancellable.
[nullable] error
return location for a GError
gboolean flatpak_installation_update_appstream_full_sync (FlatpakInstallation *self,const char *remote_name, @@ -550,8 +553,8 @@GCancellable *cancellable,GError **error);
Updates the local copy of appstream for remote_name
for the specified arch
-.
self | ||
remote_name | the name of the remote | |
arch | Architecture to update, or | [nullable] |
progress | progress callback. | [scope call][nullable] |
progress_data | user data passed to | [closure progress][nullable] |
out_changed | Set to | [nullable] |
cancellable | a GCancellable. | [nullable] |
error | return location for a GError |
gboolean +.Parameters
self
remote_name
the name of the remote
arch
Architecture to update, or
NULLfor the local machine arch.[nullable] progress
progress callback.
[scope call][closure progress_data][nullable] progress_data
user data passed to
progress+.[nullable] out_changed
Set to
TRUEif the contents of the appstream changed,FALSEif nothing changed.[nullable] cancellable
a GCancellable.
[nullable] error
return location for a GError
gboolean flatpak_installation_run_triggers (FlatpakInstallation *self,GCancellable *cancellable,GError **error);
Run the trigger commands to update the files exported by the apps in
@@ -559,27 +562,28 @@
. Should be used after one or more app install, upgrade or
uninstall operations with the FLATPAK_INSTALL_FLAGS_NO_TRIGGERS,
FLATPAK_UPDATE_FLAGS_NO_TRIGGERS or FLATPAK_UNINSTALL_FLAGS_NO_TRIGGERS
-flags set.
Since: 1.0.3
const char *
-flatpak_get_default_arch (void);Returns the canonical name for the arch of the current machine.
const char *const * +flags set.Since: 1.0.3
const char *
+flatpak_get_default_arch (void);Returns the canonical name for the arch of the current machine.
const char *const *
flatpak_get_supported_arches (void);Returns the canonical names for the arches that are supported (i.e. can run) -on the current machine, in order of priority (default is first).
GPtrArray * +on the current machine, in order of priority (default is first).
GPtrArray * flatpak_get_system_installations (GCancellable *cancellable,GError **error);
Lists the system installations according to the current configuration and current availability (e.g. doesn't return a configured installation if not reachable).
a GPtrArray of -FlatpakInstallation instances.
[transfer container][element-type FlatpakInstallation]
Since: 0.8
void +FlatpakInstallation instances.[transfer container][element-type FlatpakInstallation]
Since: 0.8
void (*FlatpakProgressCallback) (const char *status,guint progress,gboolean estimating,gpointer user_data);
The progress callback is called repeatedly during long-running operations such as installations or updates, and can be used to update progress information in a user interface.
The callback occurs in the thread-default context of the caller.
Flags to alter the behavior of e.g flatpak_installation_list_remote_refs_sync_full().
Flags to alter the behavior of e.g flatpak_installation_list_remote_refs_sync_full().
Default | ||
Don't do any network i/o, but only return cached data. This can return stale data, or a FLATPAK_ERROR_NOT_CACHED error, however it is a lot more efficient if you're doing many requests. | ||
Only list refs available from sideload -repos; see flatpak(1). (Snce: 1.7) - |
Since: 1.3.3
Flags to alter the behavior of flatpak_installation_update().
Since: 1.3.3
Flags to alter the behavior of flatpak_installation_update().
Fetch remote builds and install the latest one (default) | ||
Don't install any new builds that might be fetched | ||
Don't try to fetch new builds from the remote repo | ||
Don't use static deltas when pulling @@ -587,22 +591,22 @@ | ||
Don't call triggers after updating. If used,
the caller must later call |
Flags to alter the behavior of flatpak_installation_install_full().
Default | ||
Don't use static deltas when pulling | ||
Don't install any new builds that might be fetched | ||
Don't try to fetch new builds from the remote repo | ||
Don't call triggers after installing. If used,
the caller must later call |
Flags to alter the behavior of flatpak_installation_uninstall_full().
Default | ||
Don't prune the local OSTree repository after uninstalling | ||
Don't call triggers after uninstalling. If used,
the caller must later call |
Since: 0.11.8
Flags to alter the behavior of flatpak_installation_launch_full().
Since: 0.11.8
Flags to alter the behavior of flatpak_installation_launch_full().
Default | ||
Do not reap the child. Use this if you want to wait
-for the child with |
Information about the storage of an installation.
default | ||
installation is on a hard disk | ||
installation is on a SD card | ||
installation is on an MMC @@ -644,7 +648,7 @@ | flatpak_remote_get_filter () | |
| void | flatpak_remote_set_filter () | |
| char * | flatpak_remote_get_main_ref () | |
| void - | flatpak_remote_set_main_ref () |
A FlatpakRemote object provides information about a remote repository (or short: remote) that has been configured.
At its most basic level, a remote has a name and the URL for @@ -653,116 +657,116 @@ in a UI, such as a title, a priority or a "don't enumerate" flags.
To obtain FlatpakRemote objects for the configured remotes
on a system, use flatpak_installation_list_remotes() or
-flatpak_installation_get_remote_by_name().
FlatpakRemote *
flatpak_remote_new (const char *name);Returns a new remote object which can be used to configure a new remote.
Note: This is a local configuration object, you must commit changes
using flatpak_installation_modify_remote() or flatpak_installation_add_remote() for the changes to take
-effect.
FlatpakRemote * flatpak_remote_new_from_file (const char *name,GBytes *data,GError **error);
Returns a new pre-filled remote object which can be used to configure a new remote. The fields in the remote are filled in according to the values in the passed in flatpakrepo file.
Note: This is a local configuration object, you must commit changes
using flatpak_installation_modify_remote() or flatpak_installation_add_remote() for the changes to take
-effect.
Since: 1.3.4
const char *
-flatpak_remote_get_name (FlatpakRemote *self);Returns the name of the remote repository.
const char *
+flatpak_remote_get_name (FlatpakRemote *self);Returns the name of the remote repository.
GFile * flatpak_remote_get_appstream_dir (FlatpakRemote *self,const char *arch);
Returns the directory where this remote will store locally cached
appstream information for the specified arch
-.
GFile * +.
GFile * flatpak_remote_get_appstream_timestamp (FlatpakRemote *self,const char *arch);
Returns the timestamp file that will be updated whenever the appstream information
has been updated (or tried to update) for the specified arch
-.
char *
-flatpak_remote_get_collection_id (FlatpakRemote *self);Returns the repository collection ID of this remote, if set.
void +.
char *
+flatpak_remote_get_collection_id (FlatpakRemote *self);Returns the repository collection ID of this remote, if set.
void flatpak_remote_set_collection_id (FlatpakRemote *self,const char *collection_id);
Sets the repository collection ID of this remote.
Note: This is a local modification of this object, you must commit changes
using flatpak_installation_modify_remote() for the changes to take
-effect.
char *
-flatpak_remote_get_default_branch (FlatpakRemote *self);Returns the default branch configured for the remote.
Since: 0.6.12
char *
+flatpak_remote_get_default_branch (FlatpakRemote *self);Returns the default branch configured for the remote.
Since: 0.6.12
void flatpak_remote_set_default_branch (FlatpakRemote *self,const char *default_branch);
Sets the default branch configured for this remote.
Note: This is a local modification of this object, you must commit changes
using flatpak_installation_modify_remote() for the changes to take
-effect.
Since: 0.6.12
gboolean
-flatpak_remote_get_gpg_verify (FlatpakRemote *self);Returns whether GPG verification is enabled for the remote.
gboolean
+flatpak_remote_get_gpg_verify (FlatpakRemote *self);Returns whether GPG verification is enabled for the remote.
void flatpak_remote_set_gpg_verify (FlatpakRemote *self,gboolean gpg_verify);
Sets the gpg_verify config of this remote. See flatpak_remote_get_gpg_verify().
Note: This is a local modification of this object, you must commit changes
using flatpak_installation_modify_remote() for the changes to take
-effect.
void flatpak_remote_set_gpg_key (FlatpakRemote *self,GBytes *gpg_key);
Sets the trusted gpg key for this remote.
Note: This is a local modification of this object, you must commit changes
using flatpak_installation_modify_remote() for the changes to take
-effect.
gboolean
-flatpak_remote_get_nodeps (FlatpakRemote *self);Returns whether this remote should be used to find dependencies.
gboolean
+flatpak_remote_get_nodeps (FlatpakRemote *self);Returns whether this remote should be used to find dependencies.
void flatpak_remote_set_nodeps (FlatpakRemote *self,gboolean nodeps);
Sets the nodeps config of this remote. See flatpak_remote_get_nodeps().
Note: This is a local modification of this object, you must commit changes
using flatpak_installation_modify_remote() for the changes to take
-effect.
gboolean
-flatpak_remote_get_noenumerate (FlatpakRemote *self);Returns whether this remote should be used to list applications.
gboolean
+flatpak_remote_get_noenumerate (FlatpakRemote *self);Returns whether this remote should be used to list applications.
void flatpak_remote_set_noenumerate (FlatpakRemote *self,gboolean noenumerate);
Sets the noenumeration config of this remote. See flatpak_remote_get_noenumerate().
Note: This is a local modification of this object, you must commit changes
using flatpak_installation_modify_remote() for the changes to take
-effect.
int
-flatpak_remote_get_prio (FlatpakRemote *self);Returns the priority for the remote.
int
+flatpak_remote_get_prio (FlatpakRemote *self);Returns the priority for the remote.
void flatpak_remote_set_prio (FlatpakRemote *self,int prio);
Sets the prio config of this remote. See flatpak_remote_get_prio().
Note: This is a local modification of this object, you must commit changes
using flatpak_installation_modify_remote() for the changes to take
-effect.
FlatpakRemoteType
-flatpak_remote_get_remote_type (FlatpakRemote *self);Get the value of “type”.
Since: 0.9.8
char *
-flatpak_remote_get_title (FlatpakRemote *self);Returns the title of the remote.
FlatpakRemoteType
+flatpak_remote_get_remote_type (FlatpakRemote *self);Get the value of “type”.
Since: 0.9.8
char *
+flatpak_remote_get_title (FlatpakRemote *self);Returns the title of the remote.
void flatpak_remote_set_title (FlatpakRemote *self,const char *title);
Sets the repository title of this remote.
Note: This is a local modification of this object, you must commit changes
using flatpak_installation_modify_remote() for the changes to take
-effect.
char *
-flatpak_remote_get_comment (FlatpakRemote *self);Returns the comment of the remote.
Since: 1.4
char *
+flatpak_remote_get_comment (FlatpakRemote *self);Returns the comment of the remote.
Since: 1.4
void flatpak_remote_set_comment (FlatpakRemote *self,const char *comment);
Sets the comment of this remote.
Note: This is a local modification of this object, you must commit changes
using flatpak_installation_modify_remote() for the changes to take
-effect.
Since: 1.4
char *
-flatpak_remote_get_description (FlatpakRemote *self);Returns the description of the remote.
Since: 1.4
char *
+flatpak_remote_get_description (FlatpakRemote *self);Returns the description of the remote.
Since: 1.4
void flatpak_remote_set_description (FlatpakRemote *self,const char *description);
Sets the description of this remote.
Note: This is a local modification of this object, you must commit changes
using flatpak_installation_modify_remote() for the changes to take
-effect.
Since: 1.4
char *
-flatpak_remote_get_homepage (FlatpakRemote *self);Returns the homepage url of the remote.
Since: 1.4
char *
+flatpak_remote_get_homepage (FlatpakRemote *self);Returns the homepage url of the remote.
Since: 1.4
void flatpak_remote_set_homepage (FlatpakRemote *self,const char *homepage);
Sets the homepage of this remote.
Note: This is a local modification of this object, you must commit changes
using flatpak_installation_modify_remote() for the changes to take
-effect.
Since: 1.4
char *
-flatpak_remote_get_icon (FlatpakRemote *self);Returns the icon url of the remote.
Since: 1.4
char *
+flatpak_remote_get_icon (FlatpakRemote *self);Returns the icon url of the remote.
Since: 1.4
void flatpak_remote_set_icon (FlatpakRemote *self,const char *icon);
Sets the homepage of this remote.
Note: This is a local modification of this object, you must commit changes
using flatpak_installation_modify_remote() for the changes to take
-effect.
Since: 1.4
char *
-flatpak_remote_get_url (FlatpakRemote *self);Returns the repository URL of this remote.
char *
+flatpak_remote_get_url (FlatpakRemote *self);Returns the repository URL of this remote.
void flatpak_remote_set_url (FlatpakRemote *self,const char *url);
Sets the repository URL of this remote.
Note: This is a local modification of this object, you must commit changes
using flatpak_installation_modify_remote() for the changes to take
-effect.
gboolean
-flatpak_remote_get_disabled (FlatpakRemote *self);Returns whether this remote is disabled.
gboolean
+flatpak_remote_get_disabled (FlatpakRemote *self);Returns whether this remote is disabled.
void flatpak_remote_set_disabled (FlatpakRemote *self,gboolean disabled);
Sets the disabled config of this remote. See flatpak_remote_get_disabled().
Note: This is a local modification of this object, you must commit changes
using flatpak_installation_modify_remote() for the changes to take
-effect.
char *
-flatpak_remote_get_filter (FlatpakRemote *self);Returns the filter file of the remote.
Since: 1.4
char *
+flatpak_remote_get_filter (FlatpakRemote *self);Returns the filter file of the remote.
Since: 1.4
void flatpak_remote_set_filter (FlatpakRemote *self,const char *filter_path);
Sets a filter for this remote.
Note: This is a local modification of this object, you must commit changes
using flatpak_installation_modify_remote() for the changes to take
-effect.
Since: 1.4
char *
flatpak_remote_get_main_ref (FlatpakRemote *self);Returns the main ref of this remote, if set. The main ref is the ref that an -origin remote is created for.
Since: 1.1.1
void flatpak_remote_set_main_ref (FlatpakRemote *self,const char *main_ref);
Sets the main ref of this remote. The main ref is the ref that an origin remote is created for.
Note: This is a local modification of this object, you must commit changes
using flatpak_installation_modify_remote() for the changes to take
-effect.
Since: 1.1.1
“name” property“name” gchar *
Name of the remote, as used in configuration files and when interfacing +
“name” property“name” char *
Name of the remote, as used in configuration files and when interfacing
with OSTree. This is typically human readable, but could be generated, and
must conform to ostree_validate_remote_name(). It should typically not be
-presented in the UI.
Owner: FlatpakRemote
Flags: Read / Write
Default value: NULL
“type” property“type” FlatpakRemoteType
The type of the remote: whether it comes from static configuration files +presented in the UI.
Owner: FlatpakRemote
Flags: Read / Write
Default value: NULL
“type” property“type” FlatpakRemoteType
The type of the remote: whether it comes from static configuration files
(FLATPAK_REMOTE_TYPE_STATIC
) or has been dynamically found from the local
network or a mounted USB drive (FLATPAK_REMOTE_TYPE_LAN
@@ -783,41 +787,41 @@
╰── FlatpakTransactionOperation
FlatpakTransactionOperation is an object that represents a single operation in a transaction. You receive a FlatpakTransactionOperation object with the -“new-operation” signal.
GFile *
flatpak_transaction_operation_get_bundle_path
- (FlatpakTransactionOperation *self);Gets the path to the bundle.
const char *
+ (FlatpakTransactionOperation *self);Gets the path to the bundle.
const char *
flatpak_transaction_operation_get_commit
(FlatpakTransactionOperation *self);Gets the commit ID for the operation.
This information is available when the transaction is resolved, -i.e. when “ready” is emitted.
FlatpakTransactionOperationType +i.e. when “ready” is emitted.
FlatpakTransactionOperationType
flatpak_transaction_operation_get_operation_type
- (FlatpakTransactionOperation *self);Gets the type of the operation.
const char *
-flatpak_transaction_operation_get_ref (FlatpakTransactionOperation *self);Gets the ref that the operation applies to.
const char *
+ (FlatpakTransactionOperation *self);Gets the type of the operation.
const char *
+flatpak_transaction_operation_get_ref (FlatpakTransactionOperation *self);Gets the ref that the operation applies to.
const char *
flatpak_transaction_operation_get_remote
- (FlatpakTransactionOperation *self);Gets the remote that the operation applies to.
GKeyFile *
+ (FlatpakTransactionOperation *self);Gets the remote that the operation applies to.
GKeyFile *
flatpak_transaction_operation_get_metadata
(FlatpakTransactionOperation *self);Gets the metadata that will be applicable when the operation is done.
This can be compared to the current metadata returned
by flatpak_transaction_operation_get_old_metadata()
to find new required permissions and similar changes.
This information is available when the transaction is resolved, -i.e. when “ready” is emitted.
GKeyFile *
flatpak_transaction_operation_get_old_metadata
(FlatpakTransactionOperation *self);Gets the metadata current metadata for the ref that self
works on.
Also see flatpak_transaction_operation_get_metadata().
This information is available when the transaction is resolved, -i.e. when “ready” is emitted.
guint64
flatpak_transaction_operation_get_download_size
(FlatpakTransactionOperation *self);Gets the maximum download size for the operation.
Note that this does not include the size of dependencies, and the actual download may be smaller, if some of the data is already available locally.
For uninstall operations, this returns 0.
This information is available when the transaction is resolved, -i.e. when “ready” is emitted.
Since: 1.1.2
guint64 +i.e. when “ready” is emitted.Since: 1.1.2
guint64
flatpak_transaction_operation_get_installed_size
(FlatpakTransactionOperation *self);Gets the installed size for the operation.
Note that even for a new install, the extra space required on disk may be smaller than this number, if some of the data is already available locally.
For uninstall operations, this returns 0.
This information is available when the transaction is resolved, -i.e. when “ready” is emitted.
Since: 1.1.2
const char * +i.e. when “ready” is emitted.Since: 1.1.2
const char *
flatpak_transaction_operation_type_to_string
(FlatpakTransactionOperationType kind);Converts the operation type to a string.
FlatpakTransactionProgress — Progress of an operation
| gboolean
+. [transfer none] NameFlatpakTransactionProgress — Progress of an operation Functions
Properties
SignalsImplemented InterfacesFlatpakTransaction implements @@ -900,7 +905,7 @@ there is no good way to work around this in a threadsafe, local way, so such setups will break by default. The flatpak commandline app works around this by calling umask(022) in the early setup, and it is recommended -that other apps using libflatpak do this too. Functionsflatpak_transaction_new_for_installation ()FlatpakTransaction * +that other apps using libflatpak do this too. Functionsflatpak_transaction_new_for_installation ()FlatpakTransaction * flatpak_transaction_new_for_installation ( flatpak_transaction_add_install ()gboolean
+flatpak_transaction_add_install ()gboolean flatpak_transaction_add_install ( flatpak_transaction_add_install_bundle ()gboolean flatpak_transaction_add_install_bundle ( Adds installing the given bundle to this transaction. flatpak_transaction_add_install_flatpakref ()gboolean flatpak_transaction_add_install_flatpakref ( Adds installing the given flatpakref to this transaction. flatpak_transaction_add_rebase ()gboolean flatpak_transaction_add_rebase ( Adds updating the See If you want to rebase the ref and uninstall the old version of it, consider
+using See Parameters
Since: 1.3.3. Since: 1.3.3. flatpak_transaction_add_rebase_and_uninstall ()gboolean +flatpak_transaction_add_rebase_and_uninstall + ( Adds updating the Also adds an operation to uninstall If See Parameters
Since: 1.15.4 flatpak_transaction_add_update ()gboolean flatpak_transaction_add_update ( Adds updating the given ref to this transaction. | [nullable][array zero-terminated=1] | |||||||||||||||||||||||||||||||||||||||||||||||||||||
commit | the commit to update to, or | [nullable] | ||||||||||||||||||||||||||||||||||||||||||||||||||||
error | return location for a GError |
gboolean flatpak_transaction_add_uninstall (FlatpakTransaction *self,const char *ref, -GError **error);
Adds uninstalling the given ref to this transaction.
void
+ GError **error);Adds uninstalling the given ref to this transaction. If the transaction is +set to not deploy updates, the request is ignored.
void
flatpak_transaction_add_default_dependency_sources
(FlatpakTransaction *self);Similar to flatpak_transaction_add_dependency_source(), but adds
all the default installations, which means all the defined system-wide
-(but not per-user) installations.
void flatpak_transaction_add_dependency_source (FlatpakTransaction *self,FlatpakInstallation *installation);
Adds an extra installation as a source for application dependencies. This means that applications can be installed in this transaction relying on runtimes from this additional installation (whereas it would normally install required runtimes that are not installed in the installation -the transaction works on).
Also see flatpak_transaction_add_default_dependency_sources().
gboolean +the transaction works on).Also see
flatpak_transaction_add_default_dependency_sources().
gboolean flatpak_transaction_run (FlatpakTransaction *transaction,GCancellable *cancellable,GError **error);
Executes the transaction.
During the course of the execution, various signals will get emitted. @@ -980,86 +1016,86 @@ the transaction has been fully resolved, and “new-operation” and “operation-done” are emitted while the operations are carried out. If an error occurs at any point during the execution, -“operation-error” is emitted.
Note that this call blocks until the transaction is done.
FlatpakTransactionOperation * +“operation-error” is emitted.Note that this call blocks until the transaction is done.
FlatpakTransactionOperation *
flatpak_transaction_get_current_operation
- (FlatpakTransaction *self);Gets the current operation.
FlatpakInstallation *
-flatpak_transaction_get_installation (FlatpakTransaction *self);Gets the installation this transaction was created for.
GList *
+ (FlatpakTransaction *self);Gets the current operation.
FlatpakInstallation *
+flatpak_transaction_get_installation (FlatpakTransaction *self);Gets the installation this transaction was created for.
GList *
flatpak_transaction_get_operations (FlatpakTransaction *self);Gets the list of operations. Skipped operations are not included. The order -of the list is the order in which the operations are executed.
gboolean
-flatpak_transaction_is_empty (FlatpakTransaction *self);Returns whether the transaction contains any non-skipped operations.
void +of the list is the order in which the operations are executed.
gboolean
+flatpak_transaction_is_empty (FlatpakTransaction *self);Returns whether the transaction contains any non-skipped operations.
void flatpak_transaction_set_disable_dependencies (FlatpakTransaction *self,gboolean disable_dependencies);
Sets whether the transaction should ignore runtime dependencies -when resolving operations for applications.
void flatpak_transaction_set_disable_prune (FlatpakTransaction *self,gboolean disable_prune);
Sets whether the transaction should avoid pruning the local OSTree -repository after updating.
void flatpak_transaction_set_disable_related (FlatpakTransaction *self,gboolean disable_related);
Sets whether the transaction should avoid adding related refs when resolving operations. Related refs are extensions that are -suggested by apps, such as locales.
void flatpak_transaction_set_disable_static_deltas (FlatpakTransaction *self,gboolean disable_static_deltas);
Sets whether the transaction should avoid using static -deltas when pulling.
void flatpak_transaction_set_no_deploy (FlatpakTransaction *self,gboolean no_deploy);
Sets whether the transaction should download updates, but -not deploy them.
gboolean
flatpak_transaction_get_no_deploy (FlatpakTransaction *self);Gets whether the transaction is only downloading updates, -and not deploying them.
Since: 1.5.1
void flatpak_transaction_set_no_pull (FlatpakTransaction *self,gboolean no_pull);
Sets whether the transaction should operate only on locally -available data.
gboolean
flatpak_transaction_get_no_pull (FlatpakTransaction *self);Gets whether the transaction should operate only on locally -available data.
Since: 1.5.1
void flatpak_transaction_set_reinstall (FlatpakTransaction *self,gboolean reinstall);
Sets whether the transaction should uninstall first if a -ref is already installed.
void flatpak_transaction_set_force_uninstall (FlatpakTransaction *self,gboolean force_uninstall);
Sets whether the transaction should uninstall files even -if they're used by a running application.
void flatpak_transaction_set_default_arch (FlatpakTransaction *self, -const char *arch);
Sets the architecture to default to where it is unspecified.
void
+ const char *arch);Sets the architecture to default to where it is unspecified.
void flatpak_transaction_set_parent_window (FlatpakTransaction *self,const char *parent_window);
Sets the parent window (if any) to use for any UI show by this transaction. This is used by authenticators if they need to interact with the user during authentication.
The format of this string depends on the display system in use, and is the same as used by xdg-desktop-portal.
On X11 it should be of the form x11:$xid where $xid is the hex version of the xwindows id.
On wayland is should be wayland:$handle where handle is gotten by -using the export call of the xdg-foreign-unstable wayland extension.
Since: 1.5.1
const char * +using the export call of the xdg-foreign-unstable wayland extension.Since: 1.5.1
const char *
flatpak_transaction_get_parent_window (FlatpakTransaction *self);Gets the parent window set for this transaction, or NULL if unset. See
-flatpak_transaction_get_parent_window().
Since: 1.5.1
void flatpak_transaction_abort_webflow (FlatpakTransaction *self,guint id);
Cancel an ongoing webflow authentication request. This can be call
in the time between “webflow-start” returned
TRUE, and “webflow-done” is emitted. It will
cancel the ongoing authentication operation.
This is useful for example if you're showing an authenticaion -window with a browser, but the user closed it before it was finished.
Since: 1.5.1
The type of a FlatpakTransactionOperation.
Install a ref from a remote +window with a browser, but the user closed it before it was finished.Since: 1.5.1 Types and Valuesenum FlatpakTransactionOperationTypeThe type of a FlatpakTransactionOperation. Property DetailsThe |
“installation” property“installation” FlatpakInstallation *
The installation that the transaction operates on.
Owner: FlatpakTransaction
Flags: Read / Write / Construct Only
“no-interaction” property“no-interaction” gboolean
TRUE if the transaction is not interactive, FALSE otherwise.
See flatpak_transaction_set_no_interaction().
Owner: FlatpakTransaction
Flags: Read / Write
Default value: FALSE
Since: 1.13.0
“add-new-remote” signalgboolean user_function (FlatpakTransaction *object, - gint reason, - gchar *from_id, - gchar *suggested_remote_name, - gchar *url, + int reason, + char *from_id, + char *suggested_remote_name, + char *url, gpointer user_data)
The ::add-new-remote signal gets emitted if, as part of the transaction,
it is required or recommended that a new remote is added, for the reason
described in reason
-.
object | ||
reason | A FlatpakTransactionRemoteReason for this suggestion. | [type FlatpakTransactionRemoteReason] |
from_id | The id of the app/runtime | |
suggested_remote_name | The suggested remote name | |
url | The repo url | |
user_data | user data set when the signal handler was connected. |
Flags: Run Last
“basic-auth-start” signalgboolean +.Parameters
object
reason
A FlatpakTransactionRemoteReason for this suggestion.
[type FlatpakTransactionRemoteReason] from_id
The id of the app/runtime
suggested_remote_name
The suggested remote name
url
The repo url
user_data
user data set when the signal handler was connected.
Flags: Run Last
“basic-auth-start” signalgboolean user_function (FlatpakTransaction *object, - gchar *remote, - gchar *realm, + char *remote, + char *realm, GVariant *options, - gint id, + int id, gpointer user_data)
The ::basic-auth-start signal gets emitted when a basic user/password
authentication is needed during the operation. If the caller handles this
it should ask the user for the user and password and return TRUE. Once
@@ -1067,82 +1103,89 @@
with it.
If the client does not support basic auth then return FALSE from this signal
(or don't implement it). This will abort the authentication and likely
result in the transaction failing (unless the authentication was somehow
-optional).
object | ||
remote | The remote we're authenticating with | |
realm | The url to show | |
options | Extra options, currently unused | |
id | The id of the operation, can be used to finish it | |
user_data | user data set when the signal handler was connected. |
Flags: Run Last
Since: 1.5.2
“choose-remote-for-ref” signalgint +optional).Parameters
object
remote
The remote we're authenticating with
realm
The url to show
options
Extra options, currently unused
id
The id of the operation, can be used to finish it
user_data
user data set when the signal handler was connected.
Flags: Run Last
Since: 1.5.2
“choose-remote-for-ref” signalint user_function (FlatpakTransaction *object, - gchar *for_ref, - gchar *runtime_ref, + char *for_ref, + char *runtime_ref, GStrv remotes, gpointer user_data)
The ::choose-remote-for-ref signal gets emitted when a -remote needs to be selected during the execution of the transaction.
object | ||
for_ref | The ref we are installing | |
runtime_ref | The ref we are looking for | |
remotes | the remotes that has the ref, sorted in prio order | |
user_data | user data set when the signal handler was connected. |
Flags: Run Last
“end-of-lifed” signalvoid +remote needs to be selected during the execution of the transaction.Parameters
object
for_ref
The ref we are installing
runtime_ref
The ref we are looking for
remotes
the remotes that has the ref, sorted in prio order
user_data
user data set when the signal handler was connected.
Flags: Run Last
“end-of-lifed” signalvoid user_function (FlatpakTransaction *object, - gchar *ref, - gchar *reason, - gchar *rebase, + char *ref, + char *reason, + char *rebase, gpointer user_data)
The ::end-of-lifed signal gets emitted when a ref is found to -be marked as end-of-life during the execution of the transaction.
Flags: Run Last
“end-of-lifed-with-rebase” signalgboolean +be marked as end-of-life during the execution of the transaction.Parameters
Flags: Run Last
“end-of-lifed-with-rebase” signalgboolean user_function (FlatpakTransaction *object, - gchar *remote, - gchar *ref, - gchar *reason, - gchar *rebased_to_ref, + char *remote, + char *ref, + char *reason, + char *rebased_to_ref, GStrv previous_ids, gpointer user_data)
The ::end-of-lifed-with-rebase signal gets emitted when a ref is found to be marked as end-of-life before the transaction begins. Unlike “end-of-lifed”, this signal allows for the transaction to be modified in order to e.g. install the rebased -ref.
object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
remote | The remote for the ref we are processing | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ref | The ref we are processing | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reason | The eol reason, or | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
rebased_to_ref | The new name, if rebased, or | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
previous_ids | The previous names for the rebased ref (if any), including the one from If the caller wants to install the rebased ref, they should call
+ Parameters
Returns Flags: Run Last The |
object | ||
remote | The remote name | |
authenticator_ref | The ref for the authenticator | |
user_data | user data set when the signal handler was connected. |
Flags: Run Last
Since: 1.7.4
“new-operation” signalvoid +the signal handler fails the transaction will error out.Parameters
object
remote
The remote name
authenticator_ref
The ref for the authenticator
user_data
user data set when the signal handler was connected.
Flags: Run Last
Since: 1.8.0
“new-operation” signalvoid user_function (FlatpakTransaction *object, FlatpakTransactionOperation *operation, FlatpakTransactionProgress *progress, gpointer user_data)
The ::new-operation signal gets emitted during the execution of the transaction when a new operation is beginning.
object | ||
operation | The new FlatpakTransactionOperation | |
progress | A FlatpakTransactionProgress for | |
user_data | user data set when the signal handler was connected. |
Flags: Run Last
user_data
user data set when the signal handler was connected.
Flags: Run Last
“operation-done” signalvoid user_function (FlatpakTransaction *object, FlatpakTransactionOperation *operation, - gchar *commit, - gint result, + char *commit, + int result, gpointer user_data)
The ::operation-done signal gets emitted during the execution of -the transaction when an operation is finished.
object | ||
operation | The FlatpakTransactionOperation which finished | |
commit | The commit | |
result | A FlatpakTransactionResult giving details about the result. | [type FlatpakTransactionResult] |
user_data | user data set when the signal handler was connected. |
Flags: Run Last
“operation-error” signalgboolean +the transaction when an operation is finished.Parameters
object
operation
The FlatpakTransactionOperation which finished
commit
The commit.
[nullable] result
A FlatpakTransactionResult giving details about the result.
[type FlatpakTransactionResult] user_data
user data set when the signal handler was connected.
Flags: Run Last
“operation-error” signalgboolean user_function (FlatpakTransaction *object, FlatpakTransactionOperation *operation, GError *error, - gint details, + int details, gpointer user_data)
The ::operation-error signal gets emitted when an error occurs during the -execution of the transaction.
object | ||
operation | The FlatpakTransactionOperation which failed | |
error | A GError | |
details | A FlatpakTransactionErrorDetails with details about the error. | [type FlatpakTransactionErrorDetails] |
user_data | user data set when the signal handler was connected. |
Flags: Run Last
“ready” signalgboolean +execution of the transaction.Parameters
object
operation
The FlatpakTransactionOperation which failed
error
A GError
details
A FlatpakTransactionErrorDetails with details about the error.
[type FlatpakTransactionErrorDetails] user_data
user data set when the signal handler was connected.
Flags: Run Last
“ready” signalgboolean user_function (FlatpakTransaction *object, gpointer user_data)
The ::ready signal is emitted when all the refs involved in the operation
have been resolved to commits, and the required authentication for all ops is gotten.
At this point flatpak_transaction_get_operations() will return all the operations
-that will be executed as part of the transaction.
Flags: Run Last
“ready-pre-auth” signalgboolean +that will be executed as part of the transaction.Flags: Run Last
“ready-pre-auth” signalgboolean user_function (FlatpakTransaction *object, - gpointer user_data)
The ::ready-pre-auth signal is emitted when all the refs involved in the operation -have been resolved to commits, but all we might not necessarily have asked for authenticaion -for all there required operations. This is very similar to the ::ready signal, and you can -chose which one (or both) to use depending on how you want to handle authentication in your user -interface.
At this point flatpak_transaction_get_operations() will return all the operations
-that will be executed as part of the transaction. You can call flatpak_transaction_operation_get_requires_authentication()
-to see which will require authentication.
Flags: Run Last
“webflow-done” signalvoid + gpointer user_data)
The ::ready-pre-auth signal is emitted when all the refs involved in the +transaction have been resolved to commits, but we might not necessarily +have asked for authentication for all their required operations. This is +very similar to the ::ready signal, and you can choose which one (or both) +to use depending on how you want to handle authentication in your user +interface.
At this point flatpak_transaction_get_operations() will return all the
+operations that will be executed as part of the transaction. You can call
+flatpak_transaction_operation_get_requires_authentication() to see which
+will require authentication.
Flags: Run Last
Since: 1.9.1
“webflow-done” signalvoid user_function (FlatpakTransaction *object, GVariant *options, - gint id, + int id, gpointer user_data)
The ::webflow-done signal gets emitted when the authentication finished the webflow, independent of the reason and results. If -you for were showing a web-browser window it can now be closed.
object | ||
options | Extra options, currently unused | |
id | The id of the operation | |
user_data | user data set when the signal handler was connected. |
Flags: Run Last
Since: 1.5.1
“webflow-start” signalgboolean +you for were showing a web-browser window it can now be closed.Parameters
object
options
Extra options, currently unused
id
The id of the operation
user_data
user data set when the signal handler was connected.
Flags: Run Last
Since: 1.5.1
“webflow-start” signalgboolean user_function (FlatpakTransaction *object, - gchar *remote, - gchar *url, + char *remote, + char *url, GVariant *options, - gint id, + int id, gpointer user_data)
The ::webflow-start signal gets emitted when some kind of user
authentication is needed during the operation. If the caller handles this
it should show the url in a webbrowser and return TRUE. This will
@@ -1161,7 +1204,7 @@
GObject ╰── FlatpakRef ├── FlatpakBundleRef ├── FlatpakInstalledRef @@ -1173,22 +1216,27 @@ can refer to either of these.Both applications and runtimes are identified by a 4-tuple of strings: kind, name, arch and branch, e.g. app/org.gnome.evince/x86_64/master. The functions
flatpak_ref_parse()andflatpak_ref_format_ref()can be used to convert -FlatpakRef objects into this string representation and back.FlatpakRef objects are immutable and can be passed freely between threads.
To uniquely identify a particular version of an application or runtime, you +FlatpakRef objects into this string representation and back.
Note that the identifiers must be unique within a repo (e.g. Flathub) based +only on the name, arch, and branch 3-tuple, without regard to the kind. In +other words if app/org.gnome.evince/x86_64/master exists, +runtime/org.gnome.evince/x86_64/master must not exist. This requirement is +not enforced by libflatpak but is enforced by GNOME Software's use of +libappstream, since Appstream IDs are assumed to be unique.
FlatpakRef objects are immutable and can be passed freely between threads.
To uniquely identify a particular version of an application or runtime, you need a commit.
The subclasses FlatpakInstalledRef and FlatpakRemoteRef provide more information -for artifacts that are locally installed or available from a remote repository.
char * +for artifacts that are locally installed or available from a remote repository.
char *
flatpak_ref_format_ref (FlatpakRef *self);Convert an FlatpakRef object into a string representation that
-can be parsed by flatpak_ref_parse().
const char *
-flatpak_ref_get_arch (FlatpakRef *self);Gets the arch or the ref.
const char *
-flatpak_ref_get_branch (FlatpakRef *self);Gets the branch of the ref.
const char *
-flatpak_ref_get_collection_id (FlatpakRef *self);Gets the collection ID of the ref.
const char *
-flatpak_ref_get_commit (FlatpakRef *self);Gets the commit of the ref.
FlatpakRefKind
-flatpak_ref_get_kind (FlatpakRef *self);Gets the kind of artifact that this ref refers to.
const char *
-flatpak_ref_get_name (FlatpakRef *self);Gets the name of the ref.
const char *
+flatpak_ref_get_arch (FlatpakRef *self);Gets the arch or the ref.
const char *
+flatpak_ref_get_branch (FlatpakRef *self);Gets the branch of the ref.
const char *
+flatpak_ref_get_collection_id (FlatpakRef *self);Gets the collection ID of the ref.
const char *
+flatpak_ref_get_commit (FlatpakRef *self);Gets the commit of the ref.
FlatpakRefKind
+flatpak_ref_get_kind (FlatpakRef *self);Gets the kind of artifact that this ref refers to.
const char *
+flatpak_ref_get_name (FlatpakRef *self);Gets the name of the ref.
FlatpakRef * flatpak_ref_parse (const char *ref,GError **error);
Tries to parse a full ref name and return a FlatpakRef (without a -commit set) or fail if the ref is invalid somehow.
ref | A string ref name, such as "app/org.test.App/x86_64/master" | |
error | return location for a GError |
The kind of artifact that a FlatpakRef refers to.
An application +commit set) or fail if the ref is invalid somehow.Parameters
Property DetailsThe |
| const char * | flatpak_installed_ref_get_deploy_dir () |
| guint64 | flatpak_installed_ref_get_installed_size () |
| gboolean | flatpak_installed_ref_get_is_current () |
| const char * @@ -1204,48 +1252,49 @@ | flatpak_installed_ref_get_appdata_content_rating_type () |
| const char * const * | flatpak_installed_ref_get_subpaths () |
| const char * | flatpak_installed_ref_get_eol () |
| const char * - | flatpak_installed_ref_get_eol_rebase () |
| GHashTable * | appdata-content-rating | Read / Write / Construct Only |
| gchar * | appdata-content-rating-type | Read / Write / Construct Only |
| gchar * | appdata-license | Read / Write / Construct Only |
| gchar * | appdata-name | Read / Write / Construct Only |
| gchar * | appdata-summary | Read / Write / Construct Only |
| gchar * | appdata-version | Read / Write / Construct Only |
| gchar * | deploy-dir | Read / Write |
| gchar * | end-of-life | Read / Write / Construct Only |
| gchar * | end-of-life-rebase | Read / Write / Construct Only |
| guint64 | installed-size | Read / Write |
| gboolean | is-current | Read / Write |
| gchar * | latest-commit | Read / Write |
| gchar * | origin | Read / Write |
| GStrv | subpaths | Read / Write |
| GHashTable * | appdata-content-rating | Read / Write / Construct Only |
| char * | appdata-content-rating-type | Read / Write / Construct Only |
| char * | appdata-license | Read / Write / Construct Only |
| char * | appdata-name | Read / Write / Construct Only |
| char * | appdata-summary | Read / Write / Construct Only |
| char * | appdata-version | Read / Write / Construct Only |
| char * | deploy-dir | Read / Write |
| char * | end-of-life | Read / Write / Construct Only |
| char * | end-of-life-rebase | Read / Write / Construct Only |
| guint64 | installed-size | Read / Write |
| gboolean | is-current | Read / Write |
| char * | latest-commit | Read / Write |
| char * | origin | Read / Write |
| GStrv | subpaths | Read / Write |
A FlatpakInstalledRef provides information about an installed application or runtime (in short: ref), such as the available -builds, its size, location, etc.
const char *
-flatpak_installed_ref_get_deploy_dir (FlatpakInstalledRef *self);Gets the deploy dir of the ref.
const char *
+flatpak_installed_ref_get_deploy_dir (FlatpakInstalledRef *self);Gets the deploy dir of the ref.
guint64
flatpak_installed_ref_get_installed_size
- (FlatpakInstalledRef *self);Returns the installed size of the ref.
gboolean
-flatpak_installed_ref_get_is_current (FlatpakInstalledRef *self);Returns whether the ref is current.
const char *
+ (FlatpakInstalledRef *self);Returns the installed size of the ref.
gboolean
+flatpak_installed_ref_get_is_current (FlatpakInstalledRef *self);Returns whether the ref is current.
const char *
flatpak_installed_ref_get_latest_commit
- (FlatpakInstalledRef *self);Gets the latest commit of the ref.
const char *
-flatpak_installed_ref_get_origin (FlatpakInstalledRef *self);Gets the origin of the ref.
GBytes *
+ (FlatpakInstalledRef *self);Gets the latest commit of the ref.
const char *
+flatpak_installed_ref_get_origin (FlatpakInstalledRef *self);Gets the origin of the ref.
GBytes * flatpak_installed_ref_load_appdata (FlatpakInstalledRef *self,GCancellable *cancellable,GError **error);
Loads the compressed xml appdata for this ref (if it exists).
a GBytes containing the compressed appdata file,
-or NULL if an error occurred.
[transfer full]
Since: 1.1.2
Since: 1.1.2
GBytes * flatpak_installed_ref_load_metadata (FlatpakInstalledRef *self,GCancellable *cancellable,GError **error);
Loads the metadata file for this ref.
const char *
flatpak_installed_ref_get_appdata_license
- (FlatpakInstalledRef *self);Returns the license field from the appdata.
Since: 1.1.2
const char *
+ (FlatpakInstalledRef *self);Returns the license field from the appdata.
Since: 1.1.2
const char *
flatpak_installed_ref_get_appdata_name
- (FlatpakInstalledRef *self);Returns the name field from the appdata.
The returned string is localized.
Since: 1.1.2
const char *
+ (FlatpakInstalledRef *self);Returns the name field from the appdata.
The returned string is localized.
Since: 1.1.2
const char *
flatpak_installed_ref_get_appdata_summary
- (FlatpakInstalledRef *self);Returns the summary field from the appdata.
The returned string is localized.
Since: 1.1.2
const char *
+ (FlatpakInstalledRef *self);Returns the summary field from the appdata.
The returned string is localized.
Since: 1.1.2
const char *
flatpak_installed_ref_get_appdata_version
- (FlatpakInstalledRef *self);Returns the default version field from the appdata.
Since: 1.1.2
GHashTable *
+ (FlatpakInstalledRef *self);Returns the default version field from the appdata.
Since: 1.1.2
GHashTable *
flatpak_installed_ref_get_appdata_content_rating
(FlatpakInstalledRef *self);Returns the content rating field from the appdata. This is a potentially
empty mapping of content rating attribute IDs to values, to be interpreted
by the semantics of the content rating type (see
-flatpak_installed_ref_get_appdata_content_rating_type()).
Since: 1.4.2
const char * +flatpak_installed_ref_get_appdata_content_rating_type()).Since: 1.4.2
const char *
flatpak_installed_ref_get_appdata_content_rating_type
(FlatpakInstalledRef *self);Returns the content rating type from the appdata. For example, oars-1.0 or
-oars-1.1.
Since: 1.4.2
const char * const *
-flatpak_installed_ref_get_subpaths (FlatpakInstalledRef *self);Returns the subpaths that are installed, or NULL if all files installed.
const char * const *
+flatpak_installed_ref_get_subpaths (FlatpakInstalledRef *self);Returns the subpaths that are installed, or NULL if all files installed.
const char *
flatpak_installed_ref_get_eol (FlatpakInstalledRef *self);Returns the end-of-life reason string, or NULL if the
-ref is not end-of-lifed.
const char *
flatpak_installed_ref_get_eol_rebase (FlatpakInstalledRef *self);Returns the end-of-life rebased ref, or NULL if the
-ref is not end-of-lifed.
“appdata-content-rating” property“appdata-content-rating” GHashTable *
The content rating data from the appdata.
Owner: FlatpakInstalledRef
Flags: Read / Write / Construct Only
“appdata-content-rating-type” property“appdata-content-rating-type” gchar *
The type of the content rating data from the appdata.
Owner: FlatpakInstalledRef
Flags: Read / Write / Construct Only
Default value: NULL
“appdata-license” property“appdata-license” gchar *
The license from the appdata.
Owner: FlatpakInstalledRef
Flags: Read / Write / Construct Only
Default value: NULL
“appdata-name” property“appdata-name” gchar *
The localized name field from the appdata.
Owner: FlatpakInstalledRef
Flags: Read / Write / Construct Only
Default value: NULL
“appdata-summary” property“appdata-summary” gchar *
The localized summary field from the appdata.
Owner: FlatpakInstalledRef
Flags: Read / Write / Construct Only
Default value: NULL
“appdata-version” property“appdata-version” gchar *
The default version field from the appdata.
Owner: FlatpakInstalledRef
Flags: Read / Write / Construct Only
Default value: NULL
“deploy-dir” property“deploy-dir” gchar *
Where the application is installed.
Owner: FlatpakInstalledRef
Flags: Read / Write
Default value: NULL
“end-of-life” property“end-of-life” gchar *
The reason for the ref to be end of life.
Owner: FlatpakInstalledRef
Flags: Read / Write / Construct Only
Default value: NULL
“end-of-life-rebase” property“end-of-life-rebase” gchar *
The new ref for the end-of-lifed ref.
Owner: FlatpakInstalledRef
Flags: Read / Write / Construct Only
Default value: NULL
“installed-size” property“installed-size” guint64
The installed size of the application.
Owner: FlatpakInstalledRef
Flags: Read / Write
Default value: 0
“is-current” property“is-current” gboolean
Whether the application is current.
Owner: FlatpakInstalledRef
Flags: Read / Write
Default value: FALSE
“latest-commit” property“latest-commit” gchar *
The latest commit.
Owner: FlatpakInstalledRef
Flags: Read / Write
Default value: NULL
“origin” property“origin” gchar *
The origin.
Owner: FlatpakInstalledRef
Flags: Read / Write
Default value: NULL
“subpaths” property“subpaths” GStrv
The subpaths for a partially installed ref.
Owner: FlatpakInstalledRef
Flags: Read / Write
FlatpakRelatedRef — Related application reference
FlatpakRelatedRef *
+ref is not end-of-lifed.Property DetailsThe |
| FlatpakRelatedRef * | flatpak_related_ref_new () |
| const char * const * | flatpak_related_ref_get_subpaths () |
| gboolean | flatpak_related_ref_should_download () |
| gboolean @@ -1253,37 +1302,37 @@ | flatpak_related_ref_should_autoprune () |
| gboolean | should-autoprune | Read / Write / Construct Only |
| gboolean | should-delete | Read / Write / Construct Only |
| gboolean | should-download | Read / Write / Construct Only |
| GStrv | subpaths | Read / Write / Construct Only |
A FlatpakRelatedRef provides information about an ref that is related -to another ref. For instance, the local extension ref of an app.
A FlatpakRelatedRef provides information about a ref that is related +to another ref. For instance, the local extension ref of an app.
FlatpakRelatedRef * flatpak_related_ref_new (const char *full_ref,const char *commit,char **subpaths,gboolean download, -gboolean delete);
Creates a new FlatpakRelatedRef object.
const char * const *
+ gboolean delete);Creates a new FlatpakRelatedRef object.
const char * const *
flatpak_related_ref_get_subpaths (FlatpakRelatedRef *self);Returns the subpaths that should be installed/updated for the ref.
-This returns NULL if all files should be installed.
Since: 0.6.7
gboolean
-flatpak_related_ref_should_download (FlatpakRelatedRef *self);Returns whether to auto-download the ref with the main ref.
Since: 0.6.7
gboolean
-flatpak_related_ref_should_delete (FlatpakRelatedRef *self);Returns whether to auto-delete the ref with the main ref.
Since: 0.6.7
gboolean
-flatpak_related_ref_should_autoprune (FlatpakRelatedRef *self);Returns whether to delete when pruning unused refs.
Since: 0.11.8
“should-autoprune” property“should-autoprune” gboolean
Whether to delete when pruning unused refs.
Owner: FlatpakRelatedRef
Flags: Read / Write / Construct Only
Default value: FALSE
“should-delete” property“should-delete” gboolean
Whether to auto-delete the ref with the main ref.
Owner: FlatpakRelatedRef
Flags: Read / Write / Construct Only
Default value: FALSE
“should-download” property“should-download” gboolean
Whether to auto-download the ref with the main ref.
Owner: FlatpakRelatedRef
Flags: Read / Write / Construct Only
Default value: FALSE
“subpaths” property“subpaths” GStrv
The subpaths for a partially installed ref.
Owner: FlatpakRelatedRef
Flags: Read / Write / Construct Only
FlatpakRemoteRef — Remote application reference
const char *
+This returns NULL if all files should be installed.Since: 0.6.7 flatpak_related_ref_should_download ()gboolean
+flatpak_related_ref_should_download (Returns whether to auto-download the ref with the main ref. Since: 0.6.7 flatpak_related_ref_should_delete ()gboolean
+flatpak_related_ref_should_delete (Returns whether to auto-delete the ref with the main ref. Since: 0.6.7 flatpak_related_ref_should_autoprune ()gboolean
+flatpak_related_ref_should_autoprune (Returns whether to delete when pruning unused refs. Since: 0.11.8 Property DetailsThe |
| guint64 | download-size | Read / Write / Construct Only |
| gchar * | end-of-life | Read / Write / Construct Only |
| gchar * | end-of-life-rebase | Read / Write / Construct Only |
| guint64 | installed-size | Read / Write / Construct Only |
| GBytes * | metadata | Read / Write / Construct Only |
| gchar * | remote-name | Read / Write / Construct Only |
| guint64 | download-size | Read / Write / Construct Only |
| char * | end-of-life | Read / Write / Construct Only |
| char * | end-of-life-rebase | Read / Write / Construct Only |
| guint64 | installed-size | Read / Write / Construct Only |
| GBytes * | metadata | Read / Write / Construct Only |
| char * | remote-name | Read / Write / Construct Only |
A FlatpakRemoteRef provides information about an application or runtime -(in short: ref) that is available from a remote repository.
const char *
-flatpak_remote_ref_get_remote_name (FlatpakRemoteRef *self);Gets the remote name of the ref.
guint64
-flatpak_remote_ref_get_download_size (FlatpakRemoteRef *self);Returns the download size of the ref.
const char * +(in short: ref) that is available from a remote repository.
const char *
+flatpak_remote_ref_get_remote_name (FlatpakRemoteRef *self);Gets the remote name of the ref.
guint64
+flatpak_remote_ref_get_download_size (FlatpakRemoteRef *self);Returns the download size of the ref.
const char *
flatpak_remote_ref_get_eol (FlatpakRemoteRef *self);Returns the end-of-life reason string, or NULL if the
-ref is not end-of-lifed.
const char *
flatpak_remote_ref_get_eol_rebase (FlatpakRemoteRef *self);Returns the end-of-life rebased ref, or NULL if the
-ref is not end-of-lifed.
guint64
-flatpak_remote_ref_get_installed_size (FlatpakRemoteRef *self);Returns the installed size of the ref.
guint64
+flatpak_remote_ref_get_installed_size (FlatpakRemoteRef *self);Returns the installed size of the ref.
GBytes *
flatpak_remote_ref_get_metadata (FlatpakRemoteRef *self);Returns the app metadata from the metadata cache of the ref.
“download-size” property“download-size” guint64
The download size of the application.
Owner: FlatpakRemoteRef
Flags: Read / Write / Construct Only
Default value: 0
“end-of-life” property“end-of-life” gchar *
The reason for the ref to be end of life.
Owner: FlatpakRemoteRef
Flags: Read / Write / Construct Only
Default value: NULL
“end-of-life-rebase” property“end-of-life-rebase” gchar *
The new ref for the end of lifeed ref.
Owner: FlatpakRemoteRef
Flags: Read / Write / Construct Only
Default value: NULL
“installed-size” property“installed-size” guint64
The installed size of the application.
Owner: FlatpakRemoteRef
Flags: Read / Write / Construct Only
Default value: 0
“metadata” property“metadata” GBytes *
The metadata info for the application.
Owner: FlatpakRemoteRef
Flags: Read / Write / Construct Only
“remote-name” property“remote-name” gchar *
The name of the remote.
Owner: FlatpakRemoteRef
Flags: Read / Write / Construct Only
Default value: NULL
FlatpakBundleRef — Application bundle reference
FlatpakBundleRef *
+contents or NULL. [transfer none][nullable] Property DetailsThe |
| FlatpakBundleRef * | flatpak_bundle_ref_new () | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| GFile * | flatpak_bundle_ref_get_file () | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| GBytes * | flatpak_bundle_ref_get_metadata () | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GBytes *
@@ -1295,18 +1344,18 @@
╰── FlatpakRef
╰── FlatpakBundleRef
FunctionsFunctionsflatpak_bundle_ref_new ()FlatpakBundleRef * flatpak_bundle_ref_new ( Creates a new bundle ref for the given file. flatpak_bundle_ref_get_file ()GFile *
-flatpak_bundle_ref_get_file (Get the file this bundle is stored in. flatpak_bundle_ref_get_metadata ()GBytes *
-flatpak_bundle_ref_get_metadata (Get the metadata for the app/runtime flatpak_bundle_ref_get_appstream ()GBytes *
-flatpak_bundle_ref_get_appstream (Get the compressed appstream for the app/runtime flatpak_bundle_ref_get_icon ()GBytes *
+ Creates a new bundle ref for the given file. flatpak_bundle_ref_get_file ()GFile *
+flatpak_bundle_ref_get_file (Get the file this bundle is stored in. flatpak_bundle_ref_get_metadata ()GBytes *
+flatpak_bundle_ref_get_metadata (Get the metadata for the app/runtime flatpak_bundle_ref_get_appstream ()GBytes *
+flatpak_bundle_ref_get_appstream (Get the compressed appstream for the app/runtime flatpak_bundle_ref_get_icon ()GBytes * flatpak_bundle_ref_get_icon ( Get the icon png data for the app/runtime flatpak_bundle_ref_get_origin ()char *
-flatpak_bundle_ref_get_origin (Get the origin url stored in the bundle flatpak_bundle_ref_get_installed_size ()guint64
-flatpak_bundle_ref_get_installed_size (Returns the installed size for the bundle. flatpak_bundle_ref_get_runtime_repo_url ()char *
+ Get the icon png data for the app/runtime flatpak_bundle_ref_get_origin ()char *
+flatpak_bundle_ref_get_origin (Get the origin url stored in the bundle flatpak_bundle_ref_get_installed_size ()guint64
+flatpak_bundle_ref_get_installed_size (Returns the installed size for the bundle. flatpak_bundle_ref_get_runtime_repo_url ()char *
flatpak_bundle_ref_get_runtime_repo_url
- (Get the runtime flatpakrepo url stored in the bundle (if any) Since: 0.8.0 Property DetailsThe |
GPtrArray *
+ (FlatpakBundleRef *self);Get the runtime flatpakrepo url stored in the bundle (if any) Since: 0.8.0 Property DetailsThe |
| GPtrArray * | flatpak_instance_get_all () | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const char * | flatpak_instance_get_id () | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const char * | flatpak_instance_get_app () | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const char *
@@ -1326,27 +1375,27 @@
processes in the sandbox. One way to obtain FlatpakInstances is to use Note that process lifecycle tracking is fundamentally racy. You have to be prepared for the sandbox and the processes -represented by a FlatpakInstance to not be around anymore. The FlatpakInstance api was added in Flatpak 1.1. Functionsflatpak_instance_get_all ()GPtrArray * +represented by a FlatpakInstance to not be around anymore. Functionsflatpak_instance_get_all ()GPtrArray *
flatpak_instance_get_all (Gets FlatpakInstance objects for all running sandboxes in the current session. Since: 1.1 flatpak_instance_get_id ()const char * +FlatpakInstance objects. Since: 1.1 flatpak_instance_get_id ()const char *
flatpak_instance_get_id (Gets the instance ID. The ID is used by Flatpak for bookkeeping -purposes and has no further relevance. Since: 1.1 flatpak_instance_get_app ()const char *
-flatpak_instance_get_app (Gets the application ID of the application running in the instance. Note that this may return Since: 1.1 flatpak_instance_get_arch ()const char *
-flatpak_instance_get_arch (Gets the architecture of the application running in the instance. Since: 1.1 flatpak_instance_get_branch ()const char *
-flatpak_instance_get_branch (Gets the branch of the application running in the instance. Since: 1.1 flatpak_instance_get_commit ()const char *
-flatpak_instance_get_commit (Gets the commit of the application running in the instance. Since: 1.1 flatpak_instance_get_runtime ()const char *
-flatpak_instance_get_runtime (Gets the ref of the runtime used in the instance. Since: 1.1 flatpak_instance_get_runtime_commit ()const char *
-flatpak_instance_get_runtime_commit (Gets the commit of the runtime used in the instance. Since: 1.1 flatpak_instance_get_app ()const char *
+flatpak_instance_get_app (Gets the application ID of the application running in the instance. Note that this may return Since: 1.1 flatpak_instance_get_arch ()const char *
+flatpak_instance_get_arch (Gets the architecture of the application running in the instance. Since: 1.1 flatpak_instance_get_branch ()const char *
+flatpak_instance_get_branch (Gets the branch of the application running in the instance. Since: 1.1 flatpak_instance_get_commit ()const char *
+flatpak_instance_get_commit (Gets the commit of the application running in the instance. Since: 1.1 flatpak_instance_get_runtime ()const char *
+flatpak_instance_get_runtime (Gets the ref of the runtime used in the instance. Since: 1.1 flatpak_instance_get_runtime_commit ()const char *
+flatpak_instance_get_runtime_commit (Gets the commit of the runtime used in the instance. Since: 1.1 flatpak_instance_get_pid ()int
flatpak_instance_get_pid (Gets the PID of the outermost process in the sandbox. This is not the -application process itself, but a bubblewrap 'babysitter' process. See Since: 1.1 flatpak_instance_get_child_pid ()int +application process itself, but a bubblewrap 'babysitter' process. flatpak_instance_get_child_pid ()int
flatpak_instance_get_child_pid (Gets the PID of the application process in the sandbox. See Note that this function may return 0 immediately after launching -a sandbox, for a short amount of time. Since: 1.1 flatpak_instance_get_info ()GKeyFile *
flatpak_instance_get_info (Gets a keyfile that holds information about the running sandbox. This file is available as /.flatpak-info inside the sandbox as well. The most important data in the keyfile is available with separate getters, -but there may be more information in the keyfile. Since: 1.1 flatpak_instance_is_running ()gboolean
flatpak_instance_is_running (Finds out if the sandbox represented by NameError codes Types and Values
DescriptionThe FlatpakError and FlatpakPortalError enumerations contain error codes -for some common errors. Types and ValuesFLATPAK_ERROR#define FLATPAK_ERROR flatpak_error_quark () - The error domain for FlatpakError errors. enum FlatpakErrorError codes for library functions. Members
NameVersion information Types and Values
Table of Contents
Table of Contents
Nameorg.freedesktop.Flatpak.Authenticator MethodsRequestRefTokens (IN s handle_token, IN a{sv} authenticator_options, IN s remote, @@ -1402,9 +1451,11 @@ IN a{sv} options, IN s parent_window, OUT o handle); - Method DetailsMethod DetailsThe RequestRefTokens() method
RequestRefTokens (IN s handle_token,
IN a{sv} authenticator_options,
IN s remote,
@@ -1413,50 +1464,167 @@
IN a{sv} options,
IN s parent_window,
OUT o handle);
- object path element. See the org.freedesktop.Flatpak.AuthenticatorRequest documentation for
- more information about the Starts a request for resolving the tokens to use for This is not a regular dbus call that blocks until the result is done, instead it creates
- a org.freedesktop.Flatpak.AuthenticatorRequest object representing the ongoing operation and
- returns an object path The
- On success (response 0) the returned details should have: -
- For other response types, see the org.freedesktop.Flatpak.AuthenticatorRequest docs. - Exactly how the authenticator decides on what token to use is up to each implementation, but typically it needs to talk to - some kind of network service which in turn may need interaction such as login or entering credit card details. - This can be done in two ways: - The authenticator can use a native ui toolkit directly (as its running in the session). To make this work well the
- flatpak client can (if its has a UI) pass in the Alternatively, if the interaction is web-based, then rather than showing a web browser itself it can emit - the WebFlow signal on the request object, which lets the flatpak client show a webview embedded in its ui in a - way that works best with its user interface. - For simple user/password authentication (such as http basic authentication systems) there is also a BasicAuth signal - that can be used to get the user to interactively authenticate. This kind of authentication is quite limited, but - if used it can allow nice interactive authentication even in the command line case. - Currently used keys in the
-
Property DetailsThe "version" property+ +
+ object path element. See the org.freedesktop.Flatpak.AuthenticatorRequest documentation for
+ more information about the
+Starts a request for resolving the tokens to use for
+This is not a regular dbus call that blocks until the result is done, instead it creates
+a org.freedesktop.Flatpak.AuthenticatorRequest object representing the ongoing operation and
+returns an object path
+The
+ +On success (response 0) the returned details should have: +
+ +For other response types, see the org.freedesktop.Flatpak.AuthenticatorRequest docs. + +Exactly how the authenticator decides on what token to use is up to each implementation, but typically it needs to talk to +some kind of network service which in turn may need interaction such as login or entering credit card details. +This can be done in two ways: +
+The authenticator can use a native ui toolkit directly (as its running in the session). To make this work well the
+flatpak client can (if its has a UI) pass in the +Alternatively, if the interaction is web-based, then rather than showing a web browser itself it can emit +the WebFlow signal on the request object, which lets the flatpak client show a webview embedded in its ui in a +way that works best with its user interface. + +For simple user/password authentication (such as http basic authentication systems) there is also a BasicAuth signal +that can be used to get the user to interactively authenticate. This kind of authentication is quite limited, but +if used it can allow nice interactive authentication even in the command line case. +
+Currently used keys in the
+
Nameorg.freedesktop.Flatpak.AuthenticatorRequest Methods+Close (); +BasicAuthReply (IN s user, + IN s password, + IN a{sv} options); + Signals+Webflow (s uri, + a{sv} options); +WebflowDone (a{sv} options); +BasicAuth (s realm, + a{sv} options); +Response (u response, + a{sv} results); + Method DetailsThe Close() method+Close (); + +Closes the authenticator request to which this object refers and ends all +related user interaction (dialogs, webflows etc). + +A Response signal with the cancelled response will be emitted if the operation +was cancelled. There is still a posibility of a race, so the operation might succeed +or fail before processing the close request, so there is no guarantee that the +operation will be cancelled. + Signal DetailsThe "Webflow" signal
+Webflow (s uri,
+ a{sv} options);
++Emitted by the authenticator when it needs to do web-based interaction. The +client handles this by showing the URI in a graphical web view. Typically the uri +includes information about a final redirect to a localhost uri that will happen +when the operation is finished allowing the authenticator to get the result of +the operation. This is similar to how OAUTH2 webflows typically work. + +If at any point the user closes or otherwise dismisses the web view the client +should call the org.freedesktop.Flatpak.AuthenticatorRequest.Close method to +tell the authenticator that the operation is aborted. +
The "WebflowDone" signal
+WebflowDone (a{sv} options);
++Emitted by the authenticator when the web view is done, at this point the client +can close the WebView. +
The "BasicAuth" signal
+BasicAuth (s realm,
+ a{sv} options);
++Emitted by the authenticator when it needs to do a simple user + password authentication. +This is only useful for very simple authentication interaction, but this is still used (for +instance for http basic access authentication), and for those cases this allows a nicely +integrated UI and CLI experience. +
The "Response" signal
+Response (u response,
+ a{sv} results);
++
+Emitted when the user interaction for a portal request is over.
+The
+In the case of an error (response 2)
Nameorg.freedesktop.Flatpak.Development — Flatpak development interface MethodsHostCommand (IN ay cwd_path, IN aay argv, IN a{uh} fds, @@ -1466,103 +1634,147 @@ HostCommandSignal (IN u pid, IN u signal, IN b to_process_group); - DescriptionThe Development interface lets any client, possibly in a sandbox if - it has access to the session helper, spawn a process on the host, - outside any sandbox. - Clearly this is not something you typically want a sandboxed app to - do: it is a sandbox escape allowing arbitrary code execution, - and must not be allowed for applications where sandboxing is - intended to be a security boundary. - However, it is very useful when using Flatpak for distribution and - choice of runtime library stack, without intending to create a - security boundary. For instance, if an IDE like GNOME Builder is - distributed as a trusted Flatpak app and will be used to build other - Flatpak apps, it needs to use this facility to launch a Flatpak - build operation inside the sandbox, because otherwise recursive - calls to flatpak will not work. - This interface is provided on the D-Bus session bus by the - well-known D-Bus name org.freedesktop.Flatpak, - at the object path /org/freedesktop/Flatpak/Development. - This documentation describes version 1 of this interface. - Method DetailsDescription+The Development interface lets any client, possibly in a sandbox if +it has access to the session helper, spawn a process on the host, +outside any sandbox. + +Clearly this is not something you typically want a sandboxed app to +do: it is a sandbox escape allowing arbitrary code execution, +and must not be allowed for applications where sandboxing is +intended to be a security boundary. + +However, it is very useful when using Flatpak for distribution and +choice of runtime library stack, without intending to create a +security boundary. For instance, if an IDE like GNOME Builder is +distributed as a trusted Flatpak app and will be used to build other +Flatpak apps, it needs to use this facility to launch a Flatpak +build operation inside the sandbox, because otherwise recursive +calls to flatpak will not work. + +This interface is provided on the D-Bus session bus by the +well-known D-Bus name org.freedesktop.Flatpak, +at the object path /org/freedesktop/Flatpak/Development. + +This documentation describes version 1 of this interface. + Method DetailsThe HostCommand() method
HostCommand (IN ay cwd_path,
IN aay argv,
IN a{uh} fds,
IN a{ss} envs,
IN u flags,
OUT u pid);
-This method lets trusted applications (insider or outside a - sandbox) run arbitrary commands in the user's session, outside - any sandbox. - The following flags values are supported: -
- Unknown (unsupported) flags are an error and will cause HostCommand() - to fail. - Note that unlike org.freedesktop.portal.Flatpak.Spawn(), there - is no options parameter here. -
The HostCommandSignal() method+ +This method lets trusted applications (insider or outside a +sandbox) run arbitrary commands in the user's session, outside +any sandbox. + +The following flags values are supported: + +
+ +Unknown (unsupported) flags are an error and will cause HostCommand() +to fail. + +Note that unlike Spawn(), there +is no options parameter here. +
The HostCommandSignal() method
HostCommandSignal (IN u pid,
IN u signal,
IN b to_process_group);
- This method lets you send a Unix signal to a process
- that was started with HostCommand().
- The
Signal DetailsThe "HostCommandExited" signal+
+This method lets you send a Unix signal to a process
+that was started with HostCommand().
+The
Signal DetailsThe "HostCommandExited" signal
HostCommandExited (u pid,
u exit_status);
- Emitted when a process started by
- HostCommand() exits.
- Use g_spawn_check_exit_status(), or the macros such as
- WIFEXITED documented in
- waitpid(2),
- to interpret the This signal is not emitted for processes that were not launched - directly by HostCommand(), for example if a process launched by - HostCommand() runs foreground or background child processes. -
Property DetailsThe "version" property+
+Emitted when a process started by
+HostCommand() exits.
+Use g_spawn_check_exit_status(), or the macros such as
+WIFEXITED documented in
+waitpid(2),
+to interpret the +This signal is not emitted for processes that were not launched +directly by HostCommand(), for example if a process launched by +HostCommand() runs foreground or background child processes. +
Nameorg.freedesktop.Flatpak.SessionHelper — Flatpak session service MethodsRequestSession (OUT a{sv} data); - DescriptionThe Flatpak session service is used by the - flatpak run command - to bridge various resources from the host system into Flatpak - sandboxes. It is not intended to be contacted by third-party - applications or libraries. - This interface is provided on the D-Bus session bus by the - well-known D-Bus name org.freedesktop.Flatpak, - at the object path /org/freedesktop/Flatpak/SessionHelper. - Note that the service owning the org.freedesktop.Flatpak - well-known name also exports the - org.freedesktop.Flatpak.Development interface. As a result, - letting a sandboxed application contact that well-known name - is a sandbox escape, which must only be allowed for trusted - applications where there is not intended to be any security - boundary between sandbox and host system. - This documentation describes version 1 of this interface. - Method DetailsDescription+The Flatpak session service is used by the +flatpak run command +to bridge various resources from the host system into Flatpak +sandboxes. It is not intended to be contacted by third-party +applications or libraries. + +This interface is provided on the D-Bus session bus by the +well-known D-Bus name org.freedesktop.Flatpak, +at the object path /org/freedesktop/Flatpak/SessionHelper. + +Note that the service owning the org.freedesktop.Flatpak +well-known name also exports the +org.freedesktop.Flatpak.Development interface. As a result, +letting a sandboxed application contact that well-known name +is a sandbox escape, which must only be allowed for trusted +applications where there is not intended to be any security +boundary between sandbox and host system. + +This documentation describes version 1 of this interface. + Nameorg.freedesktop.Flatpak.SystemHelper — Flatpak system service MethodsDeploy (IN ay repo_path, IN u flags, @@ -1620,26 +1832,29 @@ IN s installation, OUT h fd_index, OUT s src_dir); - DescriptionThe Flatpak system service is used by the libflatpak library - to manipulate Flatpak applications and runtimes that are installed - system-wide, for example when implementing - flatpak install. - It is not intended to be contacted by third-party applications - or libraries. See the Flatpak source code for more - details of this interface's methods. - This interface is provided on the D-Bus system bus by the - well-known D-Bus name org.freedesktop.Flatpak.SystemHelper, - at the object path /org/freedesktop/Flatpak/SystemHelper. - The system helper runs as a privileged user at the system level, - and receives method calls from less-privileged users. - Authorization for method calls on this interface is mediated by - polkit (formerly PolicyKit) using the policy configuration - org.freedesktop.Flatpak.policy, and can be configured by - system administrators in the same way as for any other system service - that uses polkit. - Method DetailsDescription+The Flatpak system service is used by the libflatpak library +to manipulate Flatpak applications and runtimes that are installed +system-wide, for example when implementing +flatpak install. +It is not intended to be contacted by third-party applications +or libraries. See the Flatpak source code for more +details of this interface's methods. + +This interface is provided on the D-Bus system bus by the +well-known D-Bus name org.freedesktop.Flatpak.SystemHelper, +at the object path /org/freedesktop/Flatpak/SystemHelper. + +The system helper runs as a privileged user at the system level, +and receives method calls from less-privileged users. +Authorization for method calls on this interface is mediated by +polkit (formerly PolicyKit) using the policy configuration +org.freedesktop.Flatpak.policy, and can be configured by +system administrators in the same way as for any other system service +that uses polkit. + Method DetailsThe Deploy() method
Deploy (IN ay repo_path,
IN u flags,
IN s ref,
@@ -1647,72 +1862,216 @@
IN as subpaths,
IN as previous_ids,
IN s installation);
-
The DeployAppstream() method+ + +
The DeployAppstream() method
DeployAppstream (IN ay repo_path,
IN u flags,
IN s origin,
IN s arch,
IN s installation);
-
The Uninstall() method+ + +
The Uninstall() method
Uninstall (IN u flags,
IN s ref,
IN s installation);
-
The InstallBundle() method
InstallBundle (IN ay bundle_path,
IN u flags,
IN s remote,
IN s installation,
OUT s ref);
-
The ConfigureRemote() method+ + +
The ConfigureRemote() method
ConfigureRemote (IN u flags,
IN s remote,
IN s config,
IN ay gpg_key,
IN s installation);
-
The Configure() method+ + +
The Configure() method
Configure (IN u flags,
IN s key,
IN s value,
IN s installation);
-
The UpdateRemote() method
UpdateRemote (IN u flags,
IN s remote,
IN s installation,
IN ay summary_path,
IN ay summary_sig_path);
-
The RemoveLocalRef() method+ + +
The RemoveLocalRef() method
RemoveLocalRef (IN u flags,
IN s remote,
IN s ref,
IN s installation);
-
The PruneLocalRepo() method
PruneLocalRepo (IN u flags,
IN s installation);
-
The RunTriggers() method
RunTriggers (IN u flags,
IN s installation);
-
The UpdateSummary() method
UpdateSummary (IN u flags,
IN s installation);
-
The GenerateOciSummary() method
GenerateOciSummary (IN u flags,
IN s origin,
IN s installation);
-
Nameorg.freedesktop.impl.portal.PermissionStore — Database to store permissions MethodsLookup (IN s table, IN s id, OUT a{sas} permissions, @@ -1738,81 +2097,156 @@ IN s app); List (IN s table, OUT as ids); - DescriptionThe permission store can be used by portals to store permissions - that sandboxed applications have to various resources, such as - files outside the sandbox. - Since the resources managed by portals can be varied, the permission - store is fairly free-form: there can be multiple tables; resources are - identified by an ID, as are applications, and permissions are stored as - string arrays. None of these strings are interpreted by the permission - store in any way. - In addition, the permission store allows to associate extra data - (in the form of a GVariant) with each resource. - This document describes version 2 of the permission store interface. - Method DetailsDescription+The permission store can be used by portals to store permissions +that sandboxed applications have to various resources, such as +files outside the sandbox. + +Since the resources managed by portals can be varied, the permission +store is fairly free-form: there can be multiple tables; resources are +identified by an ID, as are applications, and permissions are stored as +string arrays. None of these strings are interpreted by the permission +store in any way. + +In addition, the permission store allows to associate extra data +(in the form of a GVariant) with each resource. + +This document describes version 2 of the permission store interface. + Method DetailsThe Lookup() method
Lookup (IN s table,
IN s id,
OUT a{sas} permissions,
OUT v data);
-Looks up the entry for a resource in one of the tables and returns - all associated application permissions and data. -
The Set() method+ +Looks up the entry for a resource in one of the tables and returns +all associated application permissions and data. +
The Set() method
Set (IN s table,
IN b create,
IN s id,
IN a{sas} app_permissions,
IN v data);
-Writes the entry for a resource in the given table. -
The Delete() method+ +Writes the entry for a resource in the given table. +
The Delete() method
Delete (IN s table,
IN s id);
-Removes the entry for a resource in the given table. -
The SetValue() method+ +Removes the entry for a resource in the given table. +
The SetValue() method
SetValue (IN s table,
IN b create,
IN s id,
IN v data);
-Sets just the data for a resource in the given table. -
The SetPermission() method+ +Sets just the data for a resource in the given table. +
The SetPermission() method
SetPermission (IN s table,
IN b create,
IN s id,
IN s app,
IN as permissions);
-Sets the permissions for an application and a resource - in the given table. -
The DeletePermission() method+ +Sets the permissions for an application and a resource +in the given table. +
The DeletePermission() method
DeletePermission (IN s table,
IN s id,
IN s app);
-Removes the entry for an application and a resource - in the given table. - This method was added in version 2. -
Signal DetailsThe "Changed" signal
Changed (s table,
s id,
b deleted,
v data,
a{sas} permissions);
- The Changed signal is emitted when the entry for a resource
- is modified or deleted. If the entry was deleted, then
Property DetailsThe "version" property+
+The Changed signal is emitted when the entry for a resource
+is modified or deleted. If the entry was deleted, then
Nameorg.freedesktop.portal.Documents — Document portal MethodsGetMountPoint (OUT ay path); Add (IN h o_path_fd, IN b reuse_existing, @@ -1850,66 +2284,112 @@ OUT a{sas} apps); List (IN s app_id, OUT a{say} docs); - DescriptionThe document portal allows to make files from the outside world - available to sandboxed applications in a controlled way. - Exported files will be made accessible to the application via - a fuse filesystem that gets mounted at /run/user/$UID/doc/. The - filesystem gets mounted both outside and inside the sandbox, but - the view inside the sandbox is restricted to just those files - that the application is allowed to access. - Individual files will appear at /run/user/$UID/doc/$DOC_ID/filename, - where $DOC_ID is the ID of the file in the document store. It is - returned by the Add() and - AddNamed() calls. - The permissions that the application has for a document store entry - (see GrantPermissions()) are reflected - in the POSIX mode bits in the fuse filesystem. - The D-Bus interface for the document portal is available under the - bus name org.freedesktop.portal.Documents and the object path - /org/freedesktop/portal/documents. - This documentation describes version 3 of this interface. - Method DetailsDescription+The document portal allows to make files from the outside world +available to sandboxed applications in a controlled way. + +Exported files will be made accessible to the application via +a fuse filesystem that gets mounted at /run/user/$UID/doc/. The +filesystem gets mounted both outside and inside the sandbox, but +the view inside the sandbox is restricted to just those files +that the application is allowed to access. + +Individual files will appear at /run/user/$UID/doc/$DOC_ID/filename, +where $DOC_ID is the ID of the file in the document store. It is +returned by the Add() and +AddNamed() calls. + +The permissions that the application has for a document store entry +(see GrantPermissions()) are reflected +in the POSIX mode bits in the fuse filesystem. + +The D-Bus interface for the document portal is available under the +bus name org.freedesktop.portal.Documents and the object path +/org/freedesktop/portal/documents. + +This documentation describes version 3 of this interface. + Method DetailsThe GetMountPoint() methodGetMountPoint (OUT ay path); - Returns the path at which the document store fuse filesystem - is mounted. This will typically be /run/user/$UID/doc/. -
The Add() method+ +Returns the path at which the document store fuse filesystem +is mounted. This will typically be /run/user/$UID/doc/. +
The Add() method
Add (IN h o_path_fd,
IN b reuse_existing,
IN b persistent,
OUT s doc_id);
-Adds a file to the document store. The file is passed in the - form of an open file descriptor to prove that the caller has - access to the file. -
The AddNamed() method+ +Adds a file to the document store. The file is passed in the +form of an open file descriptor to prove that the caller has +access to the file. +
The AddNamed() method
AddNamed (IN h o_path_parent_fd,
IN ay filename,
IN b reuse_existing,
IN b persistent,
OUT s doc_id);
-Creates an entry in the document store for writing a new file. -
The AddFull() method+ +Creates an entry in the document store for writing a new file. +
The AddFull() method
AddFull (IN ah o_path_fds,
IN u flags,
IN s app_id,
IN as permissions,
OUT as doc_ids,
OUT a{sv} extra_out);
-Adds multiple files to the document store. The file is passed in the - form of an open file descriptor to prove that the caller has - access to the file. - If the as-needed-by-app flag is given, files will only be added to - the document store if the application does not already have access to them. - For files that are not added to the document store, the doc_ids array will - contain an empty string. - Additionally, if app_id is specified, it will be given the permissions - listed in GrantPermission. - The method also returns some extra info that can be used to avoid - multiple roundtrips. For now it only contains as "mountpoint", the - fuse mountpoint of the document portal. - This method was added in version 2 of the org.freedesktop.portal.Documents interface. -
The AddNamedFull() method+ +Adds multiple files to the document store. The file is passed in the +form of an open file descriptor to prove that the caller has +access to the file. + +If the as-needed-by-app flag is given, files will only be added to +the document store if the application does not already have access to them. +For files that are not added to the document store, the doc_ids array will +contain an empty string. + +Additionally, if app_id is specified, it will be given the permissions +listed in GrantPermission. + +The method also returns some extra info that can be used to avoid +multiple roundtrips. For now it only contains as "mountpoint", the +fuse mountpoint of the document portal. + +This method was added in version 2 of the org.freedesktop.portal.Documents interface. +
The AddNamedFull() method
AddNamedFull (IN h o_path_fd,
IN ay filename,
IN u flags,
@@ -1917,60 +2397,121 @@
IN as permissions,
OUT s doc_id,
OUT a{sv} extra_out);
-Creates an entry in the document store for writing a new file. - If the as-needed-by-app flag is given, file will only be added to - the document store if the application does not already have access to it. - For file that is not added to the document store, the doc_id will - contain an empty string. - Additionally, if app_id is specified, it will be given the permissions - listed in GrantPermission. - The method also returns some extra info that can be used to avoid - multiple roundtrips. For now it only contains as "mountpoint", the - fuse mountpoint of the document portal. - This method was added in version 3 of the org.freedesktop.portal.Documents interface. -
The GrantPermissions() method+ +Creates an entry in the document store for writing a new file. + +If the as-needed-by-app flag is given, file will only be added to +the document store if the application does not already have access to it. +For file that is not added to the document store, the doc_id will +contain an empty string. + +Additionally, if app_id is specified, it will be given the permissions +listed in GrantPermission. + +The method also returns some extra info that can be used to avoid +multiple roundtrips. For now it only contains as "mountpoint", the +fuse mountpoint of the document portal. + +This method was added in version 3 of the org.freedesktop.portal.Documents interface. +
The GrantPermissions() method
GrantPermissions (IN s doc_id,
IN s app_id,
IN as permissions);
-Grants access permissions for a file in the document store - to an application. - This call is available inside the sandbox if the application - has the 'grant-permissions' permission for the document. -
The RevokePermissions() method+ +Grants access permissions for a file in the document store +to an application. + +This call is available inside the sandbox if the application +has the 'grant-permissions' permission for the document. +
The RevokePermissions() method
RevokePermissions (IN s doc_id,
IN s app_id,
IN as permissions);
-Revokes access permissions for a file in the document store - from an application. - This call is available inside the sandbox if the application - has the 'grant-permissions' permission for the document. -
The Delete() method+ +Revokes access permissions for a file in the document store +from an application. + +This call is available inside the sandbox if the application +has the 'grant-permissions' permission for the document. +
The Delete() methodDelete (IN s doc_id); - Removes an entry from the document store. The file itself is - not deleted. - This call is available inside the sandbox if the application - has the 'delete' permission for the document. -
The Lookup() method+ +Removes an entry from the document store. The file itself is +not deleted. + +This call is available inside the sandbox if the application +has the 'delete' permission for the document. +
The Lookup() method
Lookup (IN ay filename,
OUT s doc_id);
-Looks up the document ID for a file. - This call is not available inside the sandbox. -
The Info() method+ +Looks up the document ID for a file. + +This call is not available inside the sandbox. +
The Info() method
Info (IN s doc_id,
OUT ay path,
OUT a{sas} apps);
-Gets the filesystem path and application permissions for a document store - entry. - This call is not available inside the sandbox. -
The List() method+ +Gets the filesystem path and application permissions for a document store +entry. + +This call is not available inside the sandbox. +
The List() method
List (IN s app_id,
OUT a{say} docs);
-Lists documents in the document store for an application (or for - all applications). - This call is not available inside the sandbox. -
Property DetailsThe "version" property+ +Lists documents in the document store for an application (or for +all applications). + +This call is not available inside the sandbox. +
Nameorg.freedesktop.portal.Flatpak — Flatpak portal MethodsSpawn (IN ay cwd_path, IN aay argv, IN a{uh} fds, @@ -1983,22 +2524,25 @@ IN b to_process_group); CreateUpdateMonitor (IN a{sv} options, OUT o handle); - DescriptionThe flatpak portal exposes some interactions with flatpak on the - host to the sandbox. For example, it allows you to restart the - applications or start a more sandboxed instance. - This portal is available on the D-Bus session bus under the - bus name org.freedesktop.portal.Flatpak and the object path - /org/freedesktop/portal/Flatpak. - This documentation describes version 4 of this interface. - Method DetailsDescription+The flatpak portal exposes some interactions with flatpak on the +host to the sandbox. For example, it allows you to restart the +applications or start a more sandboxed instance. + +This portal is available on the D-Bus session bus under the +bus name org.freedesktop.portal.Flatpak and the object path +/org/freedesktop/portal/Flatpak. + +This documentation describes version 7 of this interface. + Method DetailsThe Spawn() method
Spawn (IN ay cwd_path,
IN aay argv,
IN a{uh} fds,
@@ -2006,200 +2550,204 @@
IN u flags,
IN a{sv} options,
OUT u pid);
-This method lets you start a new instance of your - application, optionally enabling a tighter sandbox. - The following flags values are supported: -
- Unknown (unsupported) flags are an error and will cause Spawn() - to fail. - Unknown (unsupported) options are ignored. - The following options are supported: -
-
The SpawnSignal() method+ + +
The SpawnSignal() method
SpawnSignal (IN u pid,
IN u signal,
IN b to_process_group);
- This method lets you send a Unix signal to a process
- that was started with Spawn().
- The
The CreateUpdateMonitor() method+
+This method lets you send a Unix signal to a process
+that was started with Spawn().
+The
The CreateUpdateMonitor() method
CreateUpdateMonitor (IN a{sv} options,
OUT o handle);
-Creates an update monitor object that will emit - signals when an update for the caller becomes - available, and can be used to install it. - The handle will be of the form /org/freedesktop/portal/Flatpak/update_monitor/SENDER/TOKEN, - where SENDER is the caller's unique name, with the initial ':' removed and - all '.' replaced by '_', and TOKEN is a unique token that the caller can optionally provide - with the 'handle_token' key in the options vardict. - Currently, no other options are accepted. - This was added in version 2 of this interface (available from flatpak 1.5.0 and later). -
Signal DetailsThe "SpawnStarted" signal+ +Creates an update monitor object that will emit +signals when an update for the caller becomes +available, and can be used to install it. + +The handle will be of the form /org/freedesktop/portal/Flatpak/update_monitor/SENDER/TOKEN, +where SENDER is the caller's unique name, with the initial ':' removed and +all '.' replaced by '_', and TOKEN is a unique token that the caller can optionally provide +with the 'handle_token' key in the options vardict. + +Currently, no other options are accepted. + +This was added in version 2 of this interface (available from flatpak 1.5.0 and later). +
Signal DetailsThe "SpawnStarted" signal
SpawnStarted (u pid,
u relpid);
-This is only non-zero if the expose PIDs flag (32) was passed to - Spawn(), and it may still be zero if - the process exits before its relative PID could be read. - Emitted when a process started by Spawn() - has fully started. In other words, Spawn() returns once the sandbox - has been started, and this signal is emitted once the process inside - itself is started. - Only emitted by version 4 of this interface (available from flatpak - 1.8.0 and later) and if the notify start flag (64) was passed to - Spawn(). -
The "SpawnExited" signal+ + +This is only non-zero if the expose PIDs flag (32) or the share +PIDs flag (128) was passed to +Spawn(), and it may still be zero if +the process exits before its relative PID could be read. + +Emitted when a process started by Spawn() +has fully started. In other words, Spawn() returns once the sandbox +has been started, and this signal is emitted once the process inside +itself is started. + +Only emitted by version 4 of this interface (available from flatpak +1.8.0 and later) and if the notify start flag (64) was passed to +Spawn(). +
The "SpawnExited" signal
SpawnExited (u pid,
u exit_status);
- Emitted when a process started by Spawn()
- exits.
- Use g_spawn_check_exit_status(), or the macros such as
- WIFEXITED documented in
- waitpid(2),
- to interpret the This signal is not emitted for processes that were not launched - directly by Spawn(), for example if a process launched by - Spawn() runs foreground or background child processes. -
Property DetailsThe "version" property+
+Emitted when a process started by Spawn()
+exits.
+Use g_spawn_check_exit_status(), or the macros such as
+WIFEXITED documented in
+waitpid(2),
+to interpret the +This signal is not emitted for processes that were not launched +directly by Spawn(), for example if a process launched by +Spawn() runs foreground or background child processes. +
Property DetailsThe "supports" propertysupports readable u - Flags marking what optional features are available. - The following flags values are supported: -
- This was added in version 3 of this interface (available from flatpak 1.6.0 and later). + +Flags marking what optional features are available. + The following flags values are supported: +
+ + This was added in version 3 of this interface (available from flatpak 1.6.0 and later). Nameorg.freedesktop.portal.Flatpak.UpdateMonitor Method DetailsMethod DetailsThe Update() method
Update (IN s parent_window,
IN a{sv} options);
- see Common Conventions
- Asks to install an update of the calling app. - During the installation, - "Progress" - signals will be emitted to communicate the status - and progress. - Note that updates are only allowed if the new version - has the same permissions (or less) than the currently installed - version. If the new version requires a new permission then the - operation will fail with the error org.freedesktop.DBus.Error.NotSupported - and updates has to be done with the system tools. - Currently, no options are accepted. -
Signal DetailsThe "UpdateAvailable" signal+ +
+ see Common Conventions
+ +Asks to install an update of the calling app. +During the installation, +"Progress" +signals will be emitted to communicate the status +and progress. + +Note that updates are only allowed if the new version +has the same permissions (or less) than the currently installed +version. If the new version requires a new permission then the +operation will fail with the error org.freedesktop.DBus.Error.NotSupported +and updates has to be done with the system tools. + +Currently, no options are accepted. +
Signal DetailsThe "UpdateAvailable" signal
UpdateAvailable (a{sv} update_info);
-Gets emitted when a new update is available. This is only - sent once with the same information, but can be sent many - times if new updates appear. - The following information may be included in the
-
-
The "Progress" signal+ +Gets emitted when a new update is available. This is only +sent once with the same information, but can be sent many +times if new updates appear. +
+The following information may be included in the
+
+
The "Progress" signal
Progress (a{sv} info);
-Gets emitted to indicate progress of the installation. It's - undefined exactly how often this is sent, but it will be emitted - at least once at the end with non-zero status field. For each - successful operation in the update we're also guaranteed to send - one (and only one) signal with progress 100. - The following fields may be included in the info: -
-
+ +Gets emitted to indicate progress of the installation. It's +undefined exactly how often this is sent, but it will be emitted +at least once at the end with non-zero status field. For each +successful operation in the update we're also guaranteed to send +one (and only one) signal with progress 100. + +The following fields may be included in the info: +
+
GObject
├── FlatpakRef
│ ├── FlatpakBundleRef
@@ -2212,4 +2760,4 @@
├── FlatpakTransaction
├── FlatpakTransactionOperation
╰── FlatpakTransactionProgress
-B
C
E
G
I
L
M
P
Q
R
S
T
U
I
AB
C
E
G
I
L
M
P
Q
R
S
T
U
I
A |