:right-sidebar: True Installation =================================================================== .. currentmodule:: gi.repository.Flatpak .. class:: Installation(**properties: ~typing.Any) :no-contents-entry: Superclasses: :class:`~gi.repository.GObject.Object` :Constructors: :: Installation(**properties) new_for_path(path:Gio.File, user:bool, cancellable:Gio.Cancellable=None) -> Flatpak.Installation new_system(cancellable:Gio.Cancellable=None) -> Flatpak.Installation new_system_with_id(id:str=None, cancellable:Gio.Cancellable=None) -> Flatpak.Installation new_user(cancellable:Gio.Cancellable=None) -> Flatpak.Installation Constructors ------------ .. rst-class:: interim-class .. class:: Installation :no-index: .. classmethod:: new_for_path(path: ~gi.repository.Gio.File, user: bool, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> ~gi.repository.Flatpak.Installation Creates a new :obj:`~gi.repository.Flatpak.Installation` for the installation at the given ``path``\. :param path: a :obj:`~gi.repository.Gio.File` :param user: whether this is a user-specific location :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. classmethod:: new_system(cancellable: ~gi.repository.Gio.Cancellable | None = None) -> ~gi.repository.Flatpak.Installation Creates a new :obj:`~gi.repository.Flatpak.Installation` for the default system-wide installation. :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. classmethod:: new_system_with_id(id: str | None = None, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> ~gi.repository.Flatpak.Installation Creates a new :obj:`~gi.repository.Flatpak.Installation` for the system-wide installation ``id``\. .. versionadded:: 0.8 :param id: the ID of the system-wide installation :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. classmethod:: new_user(cancellable: ~gi.repository.Gio.Cancellable | None = None) -> ~gi.repository.Flatpak.Installation Creates a new :obj:`~gi.repository.Flatpak.Installation` for the per-user installation. :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` Methods ------- .. rst-class:: interim-class .. class:: Installation :no-index: .. method:: add_remote(remote: ~gi.repository.Flatpak.Remote, if_needed: bool, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> bool Adds a new ``remote`` object to the set of remotes. This is similar to :func:`~gi.repository.Flatpak.Installation.modify_remote` for non-existing remote names. However, if the named remote already exists then instead of modifying it it fails with :const:`~gi.repository.Flatpak.Error.ALREADY_INSTALLED`, or if ``if_needed`` is true it silently succeeds without doing anything. As an exception to the last, if the local config has a filter defined, but the new remote unsets the filter (for example, it comes from an unfiltered .flatpakref via :func:`~gi.repository.Flatpak.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. .. versionadded:: 1.3.4 :param remote: the new :obj:`~gi.repository.Flatpak.Remote` :param if_needed: if :const:`True`, only add if it doesn't exists :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. method:: cleanup_local_refs_sync(cancellable: ~gi.repository.Gio.Cancellable | None = None) -> bool Remove all OSTree refs from the local flatpak repository which are not in a deployed state. The next time the underlying OSTree repo is pruned, objects which were attached to that ref will be removed. This is useful if you pulled a flatpak refs using :func:`~gi.repository.Flatpak.Installation.install_full` and specified :const:`~gi.repository.Flatpak.InstallFlags.NO_DEPLOY` but then decided not to deploy the refs later on and want to remove the local refs to prevent them from taking up disk space. Note that this will not remove the objects referred to by ``ref`` from the underlying OSTree repo, you should use :func:`~gi.repository.Flatpak.Installation.prune_local_repo` to do that. .. versionadded:: 0.10.0 :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. method:: create_monitor(cancellable: ~gi.repository.Gio.Cancellable | None = None) -> ~gi.repository.Gio.FileMonitor Gets monitor object for the installation. The returned file monitor will emit the :obj:`~gi.repository.Gio.FileMonitor`\::changed signal whenever an application or runtime was installed, uninstalled or updated. :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. method:: drop_caches(cancellable: ~gi.repository.Gio.Cancellable | None = None) -> bool Drops all internal (in-memory) caches. For instance, this may be needed to pick up new or changed remotes configured outside this installation instance. :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. method:: fetch_remote_metadata_sync(remote_name: str, ref: ~gi.repository.Flatpak.Ref, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> ~gi.repository.GLib.Bytes 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. :param remote_name: the name of the remote :param ref: the ref :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. method:: fetch_remote_size_sync(remote_name: str, ref: ~gi.repository.Flatpak.Ref, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> ~typing.Tuple[bool, int, int] Gets information about the maximum amount of data that needs to be transferred to pull the ref from a remote repository, and about the amount of 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. :param remote_name: the name of the remote :param ref: the ref :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. method:: get_config(key: str, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> str Get a global configuration option for the installation, see :func:`~gi.repository.Flatpak.Installation.set_config_sync` for supported keys. :param key: the name of the key to get :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. method:: get_current_installed_app(name: str, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> ~gi.repository.Flatpak.InstalledRef Get the last build of reference ``name`` that was installed with :func:`~gi.repository.Flatpak.Installation.install`, or :const:`None` if the reference has never been installed locally. :param name: the name of the app :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. method:: get_default_languages() -> list[str] 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. .. versionadded:: 1.5.0 .. method:: get_default_locales() -> list[str] Like :func:`~gi.repository.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]``\. .. versionadded:: 1.5.1 .. method:: get_display_name() -> str Returns the display name of the installation for ``self``\. Note that this function may return :const:`None` if the installation does not have a display name. .. versionadded:: 0.8 .. method:: get_id() -> str 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". .. versionadded:: 0.8 .. method:: get_is_user() -> bool Returns whether the installation is for a user-specific location. .. method:: get_min_free_space_bytes() -> ~typing.Tuple[bool, int] 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. .. versionadded:: 1.1 .. method:: get_no_interaction() -> bool Returns the value set with :func:`~gi.repository.Flatpak.Installation.set_no_interaction`. .. versionadded:: 1.1.1 .. method:: get_path() -> ~gi.repository.Gio.File Returns the installation location for ``self``\. .. method:: get_priority() -> int Returns the numeric priority of the installation for ``self``\. .. versionadded:: 0.8 .. method:: get_remote_by_name(name: str, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> ~gi.repository.Flatpak.Remote Looks up a remote by name. :param name: a remote name :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. method:: get_storage_type() -> ~gi.repository.Flatpak.StorageType Returns the type of storage of the installation for ``self``\. .. versionadded:: 0.8 .. method:: install(remote_name: str, kind: ~gi.repository.Flatpak.RefKind, name: str, arch: str | None = None, branch: str | None = None, progress: ~typing.Callable[[str, int, bool, ~typing.Any], None] | None = None, progress_data: ~typing.Any = None, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> ~gi.repository.Flatpak.InstalledRef This is an old deprecated function, you should use :obj:`~gi.repository.Flatpak.Transaction` and :func:`~gi.repository.Flatpak.Transaction.add_install` instead. It has a lot more interesting features. Install a new application or runtime. Note that this function was originally written to always return a :obj:`~gi.repository.Flatpak.InstalledRef`\. Since 0.9.13, passing FLATPAK_INSTALL_FLAGS_NO_DEPLOY will only pull refs into the local flatpak repository without deploying them, however this function will be unable to provide information on the installed ref, so FLATPAK_ERROR_ONLY_PULLED will be set and the caller must respond accordingly. .. deprecated:: 1.7.0 Use :func:`~gi.repository.Flatpak.Transaction.add_install` instead. :param remote_name: name of the remote to use :param kind: what this ref contains (an :obj:`~gi.repository.Flatpak.RefKind`\) :param name: name of the app/runtime to fetch :param arch: which architecture to fetch (default: current architecture) :param branch: which branch to fetch (default: 'master') :param progress: progress callback :param progress_data: user data passed to ``progress`` :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. method:: install_bundle(file: ~gi.repository.Gio.File, progress: ~typing.Callable[[str, int, bool, ~typing.Any], None] | None = None, progress_data: ~typing.Any = None, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> ~gi.repository.Flatpak.InstalledRef This is an old deprecated function, you should use :obj:`~gi.repository.Flatpak.Transaction` and :func:`~gi.repository.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. .. deprecated:: 1.7.0 Use :func:`~gi.repository.Flatpak.Transaction.add_install_bundle` instead. :param file: a :obj:`~gi.repository.Gio.File` that is an flatpak bundle :param progress: progress callback :param progress_data: user data passed to ``progress`` :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. method:: install_full(flags: ~gi.repository.Flatpak.InstallFlags, remote_name: str, kind: ~gi.repository.Flatpak.RefKind, name: str, arch: str | None = None, branch: str | None = None, subpaths: list[str] | None = None, progress: ~typing.Callable[[str, int, bool, ~typing.Any], None] | None = None, progress_data: ~typing.Any = None, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> ~gi.repository.Flatpak.InstalledRef This is an old deprecated function, you should use :obj:`~gi.repository.Flatpak.Transaction` and :func:`~gi.repository.Flatpak.Transaction.add_install` instead. It has a lot more interesting features. Install a new application or runtime. Note that this function was originally written to always return a :obj:`~gi.repository.Flatpak.InstalledRef`\. Since 0.9.13, passing FLATPAK_INSTALL_FLAGS_NO_DEPLOY will only pull refs into the local flatpak repository without deploying them, however this function will be unable to provide information on the installed ref, so FLATPAK_ERROR_ONLY_PULLED will be set and the caller must respond accordingly. .. deprecated:: 1.7.0 Use :func:`~gi.repository.Flatpak.Transaction.add_install` instead. :param flags: set of :obj:`~gi.repository.Flatpak.InstallFlags` flag :param remote_name: name of the remote to use :param kind: what this ref contains (an :obj:`~gi.repository.Flatpak.RefKind`\) :param name: name of the app/runtime to fetch :param arch: which architecture to fetch (default: current architecture) :param branch: which branch to fetch (default: 'master') :param subpaths: A list of subpaths to fetch, or :const:`None` for everything :param progress: progress callback :param progress_data: user data passed to ``progress`` :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. method:: launch(name: str, arch: str | None = None, branch: str | None = None, commit: str | None = None, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> bool Launch an installed application. You can use :func:`~gi.repository.Flatpak.Installation.get_installed_ref` or :func:`~gi.repository.Flatpak.Installation.get_current_installed_app` to find out what builds are available, in order to get a value for ``commit``\. :param name: name of the app to launch :param arch: which architecture to launch (default: current architecture) :param branch: which branch of the application (default: "master") :param commit: the commit of ``branch`` to launch :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. method:: launch_full(flags: ~gi.repository.Flatpak.LaunchFlags, name: str, arch: str | None = None, branch: str | None = None, commit: str | None = None, instance_out: ~gi.repository.Flatpak.Instance | None = None, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> bool Launch an installed application. You can use :func:`~gi.repository.Flatpak.Installation.get_installed_ref` or :func:`~gi.repository.Flatpak.Installation.get_current_installed_app` to find out what builds are available, in order to get a value for ``commit``\. Compared to :func:`~gi.repository.Flatpak.Installation.launch`, this function returns a :obj:`~gi.repository.Flatpak.Instance` that can be used to get information about the running instance. You can also use it to wait for the instance to be done with :func:`~gi.repository.GLib.child_watch_add` if you pass the ``FLATPAK_LAUNCH_FLAGS_DO_NOT_REAP`` flag. .. versionadded:: 1.1 :param flags: set of :obj:`~gi.repository.Flatpak.LaunchFlags` :param name: name of the app to launch :param arch: which architecture to launch (default: current architecture) :param branch: which branch of the application (default: "master") :param commit: the commit of ``branch`` to launch :param instance_out: return location for a :obj:`~gi.repository.Flatpak.Instance` :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. method:: list_installed_refs(cancellable: ~gi.repository.Gio.Cancellable | None = None) -> list[~gi.repository.Flatpak.InstalledRef] Lists the installed references. :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. method:: list_installed_refs_by_kind(kind: ~gi.repository.Flatpak.RefKind, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> list[~gi.repository.Flatpak.InstalledRef] Lists the installed references of a specific kind. :param kind: the kind of installation :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. method:: list_installed_refs_for_update(cancellable: ~gi.repository.Gio.Cancellable | None = None) -> list[~gi.repository.Flatpak.InstalledRef] Lists the installed apps and runtimes that have an update available, either from the configured remote or locally available but not deployed (see :func:`~gi.repository.Flatpak.Transaction.set_no_deploy`). This also checks if any of :obj:`~gi.repository.Flatpak.InstalledRef` has a missing :obj:`~gi.repository.Flatpak.RelatedRef` (which has ``should-download`` set to :const:`True`) or runtime. If so, it adds the ref to the returning ``GPtrArray`` to pull in the :obj:`~gi.repository.Flatpak.RelatedRef` or runtime again via an update operation in :obj:`~gi.repository.Flatpak.Transaction`\. In case more than one app needs an update of the same runtime or extension, this function will return all of those apps. :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. method:: list_installed_related_refs_sync(remote_name: str, ref: str, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> list[~gi.repository.Flatpak.RelatedRef] 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. .. versionadded:: 0.6.7 :param remote_name: the name of the remote providing ``ref`` :param ref: the ref :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. method:: list_pinned_refs(arch: str | None = None, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> list[~gi.repository.Flatpak.InstalledRef] Lists the installed references that are pinned, meaning they will not be returned by :func:`~gi.repository.Flatpak.Installation.list_unused_refs` and won't be removed unless explicitly specified for removal. Refs appear here either because they have been pinned automatically by Flatpak or because the user pinned them; see flatpak-pin(1). .. versionadded:: 1.9.1 :param arch: if non-:const:`None`, the architecture of refs to collect :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. method:: list_remote_refs_sync(remote_or_uri: str, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> list[~gi.repository.Flatpak.RemoteRef] Lists all the applications and runtimes in a remote. :param remote_or_uri: the name or URI of the remote :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. method:: list_remote_refs_sync_full(remote_or_uri: str, flags: ~gi.repository.Flatpak.QueryFlags, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> list[~gi.repository.Flatpak.RemoteRef] Lists all the applications and runtimes in a remote. .. versionadded:: 1.3.3 :param remote_or_uri: the name or URI of the remote :param flags: set of :obj:`~gi.repository.Flatpak.QueryFlags` :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. method:: list_remote_related_refs_for_installed_sync(remote_name: str, ref: str, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> list[~gi.repository.Flatpak.RelatedRef] Lists all the available refs on ``remote_name`` that are related to ``ref``\, and which are appropriate for the installed version of ``ref``\. For example if the installed version of org.videolan.VLC has a related ref of org.videolan.VLC.Plugin.bdj//3-19.08 and the remote version of VLC has a related ref of org.videolan.VLC.Plugin.bdj//3-20.08, this function will only return the 3-19.08 branch. See also the related functions :func:`~gi.repository.Flatpak.Installation.list_remote_related_refs_sync` and :func:`~gi.repository.Flatpak.Installation.list_installed_related_refs_sync`. The returned list contains all available related refs, but not every one should always be installed. For example, :func:`~gi.repository.Flatpak.RelatedRef.should_download` returns :const:`True` if the reference should be installed/updated with the app, and :func:`~gi.repository.Flatpak.RelatedRef.should_delete` returns :const:`True` if it should be uninstalled with the main ref. The commit property of each :obj:`~gi.repository.Flatpak.RelatedRef` is not guaranteed to be non-:const:`None`. .. versionadded:: 1.11.1 :param remote_name: the name of the remote :param ref: the ref :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. method:: list_remote_related_refs_sync(remote_name: str, ref: str, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> list[~gi.repository.Flatpak.RelatedRef] Lists all the available refs on ``remote_name`` that are related to ``ref``\, and the subpaths to use. These are things that are interesting to install, update, or uninstall together with ``ref``\. For instance, locale data or debug information. The returned list contains all available related refs, but not every one should always be installed. For example, :func:`~gi.repository.Flatpak.RelatedRef.should_download` returns :const:`True` if the reference should be installed/updated with the app, and :func:`~gi.repository.Flatpak.RelatedRef.should_delete` returns :const:`True` if it should be uninstalled with the main ref. The commit property of each :obj:`~gi.repository.Flatpak.RelatedRef` is not guaranteed to be non-:const:`None`. .. versionadded:: 0.6.7 :param remote_name: the name of the remote :param ref: the ref :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. method:: list_remotes(cancellable: ~gi.repository.Gio.Cancellable | None = None) -> list[~gi.repository.Flatpak.Remote] Lists the static remotes, in priority (highest first) order. For same priority, an earlier added remote comes before a later added one. :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. method:: list_remotes_by_type(types: list[~gi.repository.Flatpak.RemoteType], cancellable: ~gi.repository.Gio.Cancellable | None = None) -> list[~gi.repository.Flatpak.Remote] Lists only the remotes whose type is included in the ``types`` argument. Since flatpak 1.7 this will never return any types except FLATPAK_REMOTE_TYPE_STATIC. Equivalent functionallity to FLATPAK_REMOTE_TYPE_USB can be had by listing remote refs with FLATPAK_QUERY_FLAGS_ONLY_SIDELOADED. :param types: an array of :obj:`~gi.repository.Flatpak.RemoteType` :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. method:: list_unused_refs(arch: str | None = None, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> list[~gi.repository.Flatpak.InstalledRef] Lists the installed references that are not 'used'. A reference is used if it is either an application, 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) and :func:`~gi.repository.Flatpak.Installation.list_pinned_refs`. .. versionadded:: 1.1.2 :param arch: if non-:const:`None`, the architecture of refs to collect :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. method:: list_unused_refs_with_options(arch: str | None = None, metadata_injection: dict[~typing.Any, ~typing.Any] | None = None, options: ~gi.repository.GLib.Variant | None = None, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> list[~gi.repository.Flatpak.InstalledRef] Like :func:`~gi.repository.Flatpak.Installation.list_unused_refs` but supports an extensible set of options as well as an ``metadata_injection`` parameter. The following are currently defined: - exclude-refs (as): Act as if these refs are not installed even if they are when determining the set of unused refs - filter-by-eol (b): Return refs as unused if they are End-Of-Life. Note that if this option is combined with other filters then non-EOL refs may also be returned. - filter-by-autoprune (b): Return refs as unused if they should be autopruned. Note that if this option is combined with other filters then non-autoprune refs may also be returned. .. versionadded:: 1.9.1 :param arch: if non-:const:`None`, the architecture of refs to collect :param metadata_injection: if non-:const:`None`, a :obj:`~gi.repository.GLib.HashTable` mapping refs to :obj:`~gi.repository.GLib.KeyFile` objects, which when available will be used instead of installed metadata :param options: if non-:const:`None`, a GVariant a{sv} with an extensible set of options :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. method:: load_app_overrides(app_id: str, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> str Loads the metadata overrides file for an application. :param app_id: an application id :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. method:: modify_remote(remote: ~gi.repository.Flatpak.Remote, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> bool Saves changes in the ``remote`` object. :param remote: the modified :obj:`~gi.repository.Flatpak.Remote` :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. method:: prune_local_repo(cancellable: ~gi.repository.Gio.Cancellable | None = None) -> bool Remove all orphaned OSTree objects from the underlying OSTree repo in ``self``\. .. versionadded:: 0.10.0 :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. method:: remove_remote(name: str, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> bool Removes the remote with the given name from the installation. :param name: the name of the remote to remove :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. method:: run_triggers(cancellable: ~gi.repository.Gio.Cancellable | None = None) -> bool Run the trigger commands to update the files exported by the apps in ``self``\. Should be used after one or more app install, upgrade or uninstall operations with the :const:`~gi.repository.Flatpak.InstallFlags.NO_TRIGGERS`, :const:`~gi.repository.Flatpak.UpdateFlags.NO_TRIGGERS` or :const:`~gi.repository.Flatpak.UninstallFlags.NO_TRIGGERS` flags set. .. versionadded:: 1.0.3 :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. method:: set_config_sync(key: str, value: str, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> bool Set a global configuration option for the installation, currently the only supported keys are ``languages``\, which is a semicolon-separated list of language codes like ``"sv;en;pl"``\, or ``""`` to mean all languages, and ``extra-languages``\, which is a semicolon-separated list of locale identifiers like ``"en;en_DK;zh_HK.big5hkscs;uz_UZ.utf8@cyrillic"``\. :param key: the name of the key to set :param value: the new value, or :const:`None` to unset :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. method:: set_no_interaction(no_interaction: bool) -> None 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. .. versionadded:: 1.1.1 :param no_interaction: Whether to disallow interactive authorization for operations .. method:: uninstall(kind: ~gi.repository.Flatpak.RefKind, name: str, arch: str | None = None, branch: str | None = None, progress: ~typing.Callable[[str, int, bool, ~typing.Any], None] | None = None, progress_data: ~typing.Any = None, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> bool This is an old deprecated function, you should use :obj:`~gi.repository.Flatpak.Transaction` and :func:`~gi.repository.Flatpak.Transaction.add_uninstall` instead. It has a lot more interesting features. Uninstall an application or runtime. .. deprecated:: 1.7.0 Use :func:`~gi.repository.Flatpak.Transaction.add_uninstall` instead. :param kind: what this ref contains (an :obj:`~gi.repository.Flatpak.RefKind`\) :param name: name of the app or runtime to uninstall :param arch: architecture of the app or runtime to uninstall; if :const:`None`, :func:`~gi.repository.Flatpak.get_default_arch` is assumed :param branch: name of the branch of the app or runtime to uninstall; if :const:`None`, ``master`` is assumed :param progress: the callback :param progress_data: user data passed to ``progress`` :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. method:: uninstall_full(flags: ~gi.repository.Flatpak.UninstallFlags, kind: ~gi.repository.Flatpak.RefKind, name: str, arch: str | None = None, branch: str | None = None, progress: ~typing.Callable[[str, int, bool, ~typing.Any], None] | None = None, progress_data: ~typing.Any = None, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> bool This is an old deprecated function, you should use :obj:`~gi.repository.Flatpak.Transaction` and :func:`~gi.repository.Flatpak.Transaction.add_uninstall` instead. It has a lot more interesting features. Uninstall an application or runtime. .. versionadded:: 0.11.8 .. deprecated:: 1.7.0 Use :func:`~gi.repository.Flatpak.Transaction.add_uninstall` instead. :param flags: set of :obj:`~gi.repository.Flatpak.UninstallFlags` flags :param kind: what this ref contains (an :obj:`~gi.repository.Flatpak.RefKind`\) :param name: name of the app or runtime to uninstall :param arch: architecture of the app or runtime to uninstall; if :const:`None`, :func:`~gi.repository.Flatpak.get_default_arch` is assumed :param branch: name of the branch of the app or runtime to uninstall; if :const:`None`, ``master`` is assumed :param progress: the callback :param progress_data: user data passed to ``progress`` :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. method:: update(flags: ~gi.repository.Flatpak.UpdateFlags, kind: ~gi.repository.Flatpak.RefKind, name: str, arch: str | None = None, branch: str | None = None, progress: ~typing.Callable[[str, int, bool, ~typing.Any], None] | None = None, progress_data: ~typing.Any = None, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> ~gi.repository.Flatpak.InstalledRef This is an old deprecated function, you should use :obj:`~gi.repository.Flatpak.Transaction` and :func:`~gi.repository.Flatpak.Transaction.add_update` instead. It has a lot more interesting features. Update an application or runtime. If the specified package is not installed, then :const:`~gi.repository.Flatpak.Error.NOT_INSTALLED` will be thrown. If no updates could be found on the remote end and the package is already up to date, then :const:`~gi.repository.Flatpak.Error.ALREADY_INSTALLED` will be thrown. .. deprecated:: 1.7.0 Use :func:`~gi.repository.Flatpak.Transaction.add_update` instead. :param flags: set of :obj:`~gi.repository.Flatpak.UpdateFlags` flag :param kind: whether this is an app or runtime :param name: name of the app or runtime to update :param arch: architecture of the app or runtime to update (default: current architecture) :param branch: name of the branch of the app or runtime to update (default: master) :param progress: the callback :param progress_data: user data passed to ``progress`` :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. method:: update_appstream_full_sync(remote_name: str, arch: str | None = None, progress: ~typing.Callable[[str, int, bool, ~typing.Any], None] | None = None, progress_data: ~typing.Any = None, out_changed: bool | None = None, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> bool Updates the local copy of appstream for ``remote_name`` for the specified ``arch``\. :param remote_name: the name of the remote :param arch: Architecture to update, or :const:`None` for the local machine arch :param progress: progress callback :param progress_data: user data passed to ``progress`` :param out_changed: Set to :const:`True` if the contents of the appstream changed, :const:`False` if nothing changed :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. method:: update_appstream_sync(remote_name: str, arch: str | None = None, out_changed: bool | None = None, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> bool Updates the local copy of appstream for ``remote_name`` for the specified ``arch``\. If you need progress feedback, use :func:`~gi.repository.Flatpak.Installation.update_appstream_full_sync`. :param remote_name: the name of the remote :param arch: Architecture to update, or :const:`None` for the local machine arch :param out_changed: Set to :const:`True` if the contents of the appstream changed, :const:`False` if nothing changed :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. method:: update_full(flags: ~gi.repository.Flatpak.UpdateFlags, kind: ~gi.repository.Flatpak.RefKind, name: str, arch: str | None = None, branch: str | None = None, subpaths: list[str] | None = None, progress: ~typing.Callable[[str, int, bool, ~typing.Any], None] | None = None, progress_data: ~typing.Any = None, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> ~gi.repository.Flatpak.InstalledRef This is an old deprecated function, you should use :obj:`~gi.repository.Flatpak.Transaction` and :func:`~gi.repository.Flatpak.Transaction.add_update` instead. It has a lot more interesting features. Update an application or runtime. If the specified package is not installed, then :const:`~gi.repository.Flatpak.Error.NOT_INSTALLED` will be thrown. If no updates could be found on the remote end and the package is already up to date, then :const:`~gi.repository.Flatpak.Error.ALREADY_INSTALLED` will be thrown. .. deprecated:: 1.7.0 Use :func:`~gi.repository.Flatpak.Transaction.add_update` instead. :param flags: set of :obj:`~gi.repository.Flatpak.UpdateFlags` flag :param kind: whether this is an app or runtime :param name: name of the app or runtime to update :param arch: architecture of the app or runtime to update (default: current architecture) :param branch: name of the branch of the app or runtime to update (default: master) :param subpaths: A list of subpaths to fetch, or :const:`None` for everything :param progress: the callback :param progress_data: user data passed to ``progress`` :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` .. method:: update_remote_sync(name: str, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> bool 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. .. versionadded:: 0.6.13 :param name: the name of the remote to update :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` Fields ------ .. rst-class:: interim-class .. class:: Installation :no-index: .. attribute:: parent