Top | ![]() |
![]() |
![]() |
![]() |
struct | FlatpakInstallation |
enum | FlatpakUpdateFlags |
enum | FlatpakInstallFlags |
enum | FlatpakStorageType |
FlatpakInstallation is the toplevel object that software installers should use to operate on an flatpak applications.
An FlatpakInstallation object provides information about an installation location for flatpak applications. Typical installation locations are either system-wide (in $prefix/var/lib/flatpak) or per-user (in ~/.local/share/flatpak).
FlatpakInstallation can list configured remotes as well as installed application and runtime references (in short: refs). It can also run, install, update and uninstall applications and runtimes.
FlatpakInstallation * flatpak_installation_new_system (GCancellable *cancellable
,GError **error
);
Creates a new FlatpakInstallation for the system-wide installation.
FlatpakInstallation * flatpak_installation_new_system_with_id (const char *id
,GCancellable *cancellable
,GError **error
);
Creates a new FlatpakInstallation for the system-wide installation id
.
id |
the ID of the system-wide installation. |
[nullable] |
cancellable |
a GCancellable. |
[nullable] |
error |
return location for a GError |
Since: 0.8
FlatpakInstallation * flatpak_installation_new_user (GCancellable *cancellable
,GError **error
);
Creates a new FlatpakInstallation for the per-user installation.
FlatpakInstallation * flatpak_installation_new_for_path (GFile *path
,gboolean user
,GCancellable *cancellable
,GError **error
);
Creates a new FlatpakInstallation for the installation at the given path
.
gboolean
flatpak_installation_get_is_user (FlatpakInstallation *self
);
Returns whether the installation is for a user-specific location.
GFile *
flatpak_installation_get_path (FlatpakInstallation *self
);
Returns the installation location for self
.
GFileMonitor * flatpak_installation_create_monitor (FlatpakInstallation *self
,GCancellable *cancellable
,GError **error
);
Gets monitor object for the installation. The returned file monitor will emit the “changed” signal whenever an application or runtime was installed, uninstalled or updated.
FlatpakInstalledRef * flatpak_installation_install (FlatpakInstallation *self
,const char *remote_name
,FlatpakRefKind kind
,const char *name
,const char *arch
,const char *branch
,FlatpakProgressCallback progress
,gpointer progress_data
,GCancellable *cancellable
,GError **error
);
Install a new application or runtime.
Note that this function was originally written to always return a FlatpakInstalledRef. 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.
self |
||
remote_name |
name of the remote to use |
|
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] |
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 |
FlatpakInstalledRef * flatpak_installation_install_full (FlatpakInstallation *self
,FlatpakInstallFlags flags
,const char *remote_name
,FlatpakRefKind kind
,const char *name
,const char *arch
,const char *branch
,const char * const *subpaths
,FlatpakProgressCallback progress
,gpointer progress_data
,GCancellable *cancellable
,GError **error
);
Install a new application or runtime.
Note that this function was originally written to always return a FlatpakInstalledRef. 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.
self |
||
flags |
set of FlatpakInstallFlags flag |
|
remote_name |
name of the remote to use |
|
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] |
subpaths |
A list of subpaths to fetch, or |
[nullable][array zero-terminated=1] |
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 |
FlatpakInstalledRef * flatpak_installation_update (FlatpakInstallation *self
,FlatpakUpdateFlags flags
,FlatpakRefKind kind
,const char *name
,const char *arch
,const char *branch
,FlatpakProgressCallback progress
,gpointer progress_data
,GCancellable *cancellable
,GError **error
);
Update an application or runtime.
If the specified package is not installed, then 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 FLATPAK_ERROR_ALREADY_INSTALLED
will be thrown.
self |
||
flags |
set of FlatpakUpdateFlags flag |
|
kind |
whether this is an app or runtime |
|
name |
name of the app or runtime to update |
|
arch |
architecture of the app or runtime to update (default: current architecture). |
[nullable] |
branch |
name of the branch of the app or runtime to update (default: master). |
[nullable] |
progress |
the callback. |
[scope call][nullable] |
progress_data |
user data passed to |
[closure progress][nullable] |
cancellable |
a GCancellable. |
[nullable] |
error |
return location for a GError |
FlatpakInstalledRef * flatpak_installation_update_full (FlatpakInstallation *self
,FlatpakUpdateFlags flags
,FlatpakRefKind kind
,const char *name
,const char *arch
,const char *branch
,const char * const *subpaths
,FlatpakProgressCallback progress
,gpointer progress_data
,GCancellable *cancellable
,GError **error
);
Update an application or runtime.
If the specified package is not installed, then 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 FLATPAK_ERROR_ALREADY_INSTALLED
will be thrown.
self |
||
flags |
set of FlatpakUpdateFlags flag |
|
kind |
whether this is an app or runtime |
|
name |
name of the app or runtime to update |
|
arch |
architecture of the app or runtime to update (default: current architecture). |
[nullable] |
branch |
name of the branch of the app or runtime to update (default: master). |
[nullable] |
subpaths |
A list of subpaths to fetch, or |
[nullable][array zero-terminated=1] |
progress |
the callback. |
[scope call][nullable] |
progress_data |
user data passed to |
[closure progress][nullable] |
cancellable |
a GCancellable. |
[nullable] |
error |
return location for a GError |
gboolean flatpak_installation_uninstall (FlatpakInstallation *self
,FlatpakRefKind kind
,const char *name
,const char *arch
,const char *branch
,FlatpakProgressCallback progress
,gpointer progress_data
,GCancellable *cancellable
,GError **error
);
Uninstall an application or runtime.
self |
||
kind |
what this ref contains (an FlatpakRefKind) |
|
name |
name of the app or runtime to uninstall |
|
arch |
architecture of the app or runtime to uninstall |
|
branch |
name of the branch of the app or runtime to uninstall |
|
progress |
the callback. |
[scope call][nullable] |
progress_data |
user data passed to |
[closure progress][nullable] |
cancellable |
a GCancellable. |
[nullable] |
error |
return location for a GError |
gboolean flatpak_installation_launch (FlatpakInstallation *self
,const char *name
,const char *arch
,const char *branch
,const char *commit
,GCancellable *cancellable
,GError **error
);
Launch an installed application.
You can use flatpak_installation_get_installed_ref()
or
flatpak_installation_get_current_installed_app()
to find out what builds
are available, in order to get a value for commit
.
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 |
[nullable] |
cancellable |
a GCancellable. |
[nullable] |
error |
return location for a GError |
FlatpakInstalledRef * flatpak_installation_get_current_installed_app (FlatpakInstallation *self
,const char *name
,GCancellable *cancellable
,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.
const char *
flatpak_installation_get_display_name (FlatpakInstallation *self
);
Returns the display name of the system installation for self
.
Since: 0.8
const char *
flatpak_installation_get_id (FlatpakInstallation *self
);
Returns the ID of the system installation for self
.
Since: 0.8
FlatpakInstalledRef * flatpak_installation_get_installed_ref (FlatpakInstallation *self
,FlatpakRefKind kind
,const char *name
,const char *arch
,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 |
gint
flatpak_installation_get_priority (FlatpakInstallation *self
);
Returns the numeric priority of the system installation for self
.
Since: 0.8
FlatpakStorageType
flatpak_installation_get_storage_type (FlatpakInstallation *self
);
Returns the type of storage of the system installation for self
.
Since: 0.8
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 * 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 * flatpak_installation_list_installed_refs_for_update (FlatpakInstallation *self
,GCancellable *cancellable
,GError **error
);
Lists the installed references that has a remote update that is not locally available. However, even though an app is not returned by this it can have local updates available that has not been deployed. Look at commit vs latest_commit on installed apps for this.
a GPtrArray of
FlatpakInstalledRef instances, or NULL
on 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, 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_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 * flatpak_installation_list_remote_related_refs_sync (FlatpakInstallation *self
,const char *remote_name
,const char *ref
,GCancellable *cancellable
,GError **error
);
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
everyone should always be installed. For example,
flatpak_related_ref_should_download()
returns TRUE if the
reference should be installed/updated with the app, and
flatpak_related_ref_should_delete()
returns TRUE if it
should be uninstalled with the main ref.
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_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 * flatpak_installation_get_remote_by_name (FlatpakInstallation *self
,const gchar *name
,GCancellable *cancellable
,GError **error
);
Looks up a remote by name.
GBytes * flatpak_installation_fetch_remote_metadata_sync (FlatpakInstallation *self
,const char *remote_name
,FlatpakRef *ref
,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.
FlatpakRemoteRef * flatpak_installation_fetch_remote_ref_sync (FlatpakInstallation *self
,const char *remote_name
,FlatpakRefKind kind
,const char *name
,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 |
gboolean flatpak_installation_fetch_remote_size_sync (FlatpakInstallation *self
,const char *remote_name
,FlatpakRef *ref
,guint64 *download_size
,guint64 *installed_size
,GCancellable *cancellable
,GError **error
);
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.
char * flatpak_installation_load_app_overrides (FlatpakInstallation *self
,const char *app_id
,GCancellable *cancellable
,GError **error
);
Loads the metadata overrides file for an application.
gboolean flatpak_installation_update_appstream_sync (FlatpakInstallation *self
,const char *remote_name
,const char *arch
,gboolean *out_changed
,GCancellable *cancellable
,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()
.
FlatpakInstalledRef * flatpak_installation_install_bundle (FlatpakInstallation *self
,GFile *file
,FlatpakProgressCallback progress
,gpointer progress_data
,GCancellable *cancellable
,GError **error
);
Install an application or runtime from an flatpak bundle file. See flatpak-build-bundle(1) for how to create bundles.
FlatpakRemoteRef * flatpak_installation_install_ref_file (FlatpakInstallation *self
,GBytes *ref_file_data
,GCancellable *cancellable
,GError **error
);
Creates a remote based on the passed in .flatpakref file contents
in ref_file_data
and returns the FlatpakRemoteRef that can be used
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()
.
self |
||
ref_file_data |
The ref file contents |
|
cancellable |
a GCancellable. |
[nullable] |
error |
return location for a GError |
a FlatpakRemoteRef if the remote has been added successfully, NULL
on error.
[transfer full]
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 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 flatpak_installation_remove_remote (FlatpakInstallation *self
,const char *name
,GCancellable *cancellable
,GError **error
);
Removes the remote with the given name from the installation.
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 flatpak_installation_cleanup_local_refs_sync (FlatpakInstallation *self
,GCancellable *cancellable
,GError **error
);
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 flatpak_installation_install_full()
and
specified FLATPAK_INSTALL_FLAGS_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
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 remote, see
flatpak_installation_set_config_sync()
for supported keys.
gboolean flatpak_installation_prune_local_repo (FlatpakInstallation *self
,GCancellable *cancellable
,GError **error
);
Remove all orphaned OSTree objects from the underlying OSTree repo in
installation
.
gboolean flatpak_installation_remove_local_ref_sync (FlatpakInstallation *self
,const char *remote_name
,const char *ref
,GCancellable *cancellable
,GError **error
);
Remove the OSTree ref given by remote_name
:ref
from the local flatpak
repository. 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 ref using flatpak_installation_install_full()
and
specified FLATPAK_INSTALL_FLAGS_NO_DEPLOY
but then decided not to
deploy the ref later on and want to remove the local ref to prevent it
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
flatpak_installation_prune_local_repo()
to do that.
gboolean flatpak_installation_set_config_sync (FlatpakInstallation *self
,const char *key
,const char *value
,GCancellable *cancellable
,GError **error
);
Set a global configuration option for the installation, currently the only supported key is "languages", which is a comman-separated list of langue codes like "sv;en;pl", or "" to mean all languages.
gboolean flatpak_installation_update_appstream_full_sync (FlatpakInstallation *self
,const char *remote_name
,const char *arch
,FlatpakProgressCallback progress
,gpointer progress_data
,gboolean *out_changed
,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 |
|
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 |
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 * 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 (*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 flatpak_installation_install_full()
.
Since: 0.6.15