the new #FlatpakRemote
if %TRUE, only add if it doesn't exists
a #GCancellable
Creates a binding between source_property on source and target_property
on target.
Whenever the source_property is changed the target_property is
updated using the same value. For instance:
g_object_bind_property (action, "active", widget, "sensitive", 0);
Will result in the "sensitive" property of the widget #GObject instance to be updated with the same value of the "active" property of the action #GObject instance.
If flags contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well.
The binding will automatically be removed when either the source or the
target instances are finalized. To remove the binding without affecting the
source and the target you can just call g_object_unref() on the returned
#GBinding instance.
Removing the binding by calling g_object_unref() on it must only be done if
the binding, source and target are only used from a single thread and it
is clear that both source and target outlive the binding. Especially it
is not safe to rely on this if the binding, source or target can be
finalized from different threads. Keep another reference to the binding and
use g_binding_unbind() instead to be on the safe side.
A #GObject can have multiple bindings.
the property on source to bind
the target #GObject
the property on target to bind
flags to pass to #GBinding
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.
the property on source to bind
the target #GObject
the property on target to bind
flags to pass to #GBinding
a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default
a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default
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.
a #GCancellable
Gets monitor object for the installation. The returned file monitor will emit the #GFileMonitor::changed signal whenever an application or runtime was installed, uninstalled or updated.
a #GCancellable
Drops all internal (in-memory) caches. For instance, this may be needed to pick up new or changed remotes configured outside this installation instance.
a #GCancellable
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.
the name of the remote
the ref
a #GCancellable
Gets the current remote branch of a ref in the remote.
the name of the remote
what this ref contains (an #FlatpakRefKind)
name of the app/runtime to fetch
which architecture to fetch (default: current architecture)
which branch to fetch (default: 'master')
a #GCancellable
Gets the current remote branch of a ref in the remote.
the name of the remote
what this ref contains (an #FlatpakRefKind)
name of the app/runtime to fetch
which architecture to fetch (default: current architecture)
which branch to fetch (default: 'master')
set of #FlatpakQueryFlags
a #GCancellable
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.
the name of the remote
the ref
a #GCancellable
This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().
Increases the freeze count on object. If the freeze count is
non-zero, the emission of "notify" signals on object is
stopped. The signals are queued until the freeze count is decreased
to zero. Duplicate notifications are squashed so that at most one
#GObject::notify signal is emitted for each property modified while the
object is frozen.
This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.
Get a global configuration option for the installation, see flatpak_installation_set_config_sync() for supported keys.
the name of the key to get
a #GCancellable
Get the last build of reference name that was installed with
flatpak_installation_install(), or %NULL if the reference has
never been installed locally.
the name of the app
a #GCancellable
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
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.
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]``.
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.
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".
Returns information about an installed ref, such as the available builds, its size, location, etc.
whether this is an app or runtime
name of the app/runtime to fetch
which architecture to fetch (default: current architecture)
which branch to fetch (default: "master")
a #GCancellable
Returns whether the installation is for a user-specific location.
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.
Returns the value set with flatpak_installation_set_no_interaction().
Returns the numeric priority of the installation for self.
Gets a property of an object.
The value can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().
Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.
the name of the property to get
return location for the property value
This function gets back user data pointers stored via g_object_set_qdata().
A #GQuark, naming the user data pointer
Looks up a remote by name.
a remote name
a #GCancellable
Returns the type of storage of the installation for self.
Gets n_properties properties for an object.
Obtained properties will be set to values. All properties must be valid.
Warnings will be emitted and undefined behaviour may result if invalid
properties are passed in.
the names of each property to get
the values of each property to get
This is an old deprecated function, you should use #FlatpakTransaction and 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 #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.
name of the remote to use
what this ref contains (an #FlatpakRefKind)
name of the app/runtime to fetch
which architecture to fetch (default: current architecture)
which branch to fetch (default: 'master')
a #GCancellable
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.
a #GFile that is an flatpak bundle
a #GCancellable
This is an old deprecated function, you should use #FlatpakTransaction and 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 #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.
set of #FlatpakInstallFlags flag
name of the remote to use
what this ref contains (an #FlatpakRefKind)
name of the app/runtime to fetch
which architecture to fetch (default: current architecture)
which branch to fetch (default: 'master')
A list of subpaths to fetch, or %NULL for everything
a #GCancellable
This is an old deprecated function, you should use #FlatpakTransaction and flatpak_transaction_add_install_flatpakref() instead. It has a lot more interesting features.
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 ().
The ref file contents
a #GCancellable
Checks whether object has a [floating][floating-ref] reference.
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.
name of the app to launch
which architecture to launch (default: current architecture)
which branch of the application (default: "master")
the commit of branch to launch
a #GCancellable
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.
Compared to flatpak_installation_launch(), this function returns a #FlatpakInstance 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 g_child_watch_add() if you pass the #FLATPAK_LAUNCH_FLAGS_DO_NOT_REAP flag.
set of #FlatpakLaunchFlags
name of the app to launch
which architecture to launch (default: current architecture)
which branch of the application (default: "master")
the commit of branch to launch
return location for a #FlatpakInstance
a #GCancellable
Lists the installed references.
a #GCancellable
Lists the installed references of a specific kind.
the kind of installation
a #GCancellable
Lists the installed apps and runtimes that have an update available, either from the configured remote or locally available but not deployed (see flatpak_transaction_set_no_deploy()).
This also checks if any of #FlatpakInstalledRef has a missing #FlatpakRelatedRef
(which has should-download set to %TRUE) or runtime. If so, it adds the
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.
a #GCancellable
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.
the name of the remote
the ref
a #GCancellable
Lists all the applications and runtimes in a remote.
the name or URI of the remote
a #GCancellable
Lists all the applications and runtimes in a remote.
the name or URI of the remote
set of #FlatpakQueryFlags
a #GCancellable
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, 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.
The commit property of each #FlatpakRelatedRef is not guaranteed to be non-%NULL.
the name of the remote
the ref
a #GCancellable
Lists the static remotes, in priority (highest first) order. For same priority, an earlier added remote comes before a later added one.
a #GCancellable
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.
an array of #FlatpakRemoteType
a #GCancellable
Lists the installed references that are not 'used'.
A reference is used if it is either an application, or an sdk, or the runtime of a used ref, or an extension of a used ref.
if non-%NULL, the architecture of refs to collect
a #GCancellable
Loads the metadata overrides file for an application.
an application id
a #GCancellable
Saves changes in the remote object.
the modified #FlatpakRemote
a #GCancellable
Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.
Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.
the name of a property installed on the class of object.
Emits a "notify" signal for the property specified by pspec on object.
This function omits the property name lookup, hence it is faster than g_object_notify().
One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:
enum
{
PROP_0,
PROP_FOO,
PROP_LAST
};
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
0, 100,
50,
G_PARAM_READWRITE);
g_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the #GParamSpec of a property installed on the class of object.
Remove all orphaned OSTree objects from the underlying OSTree repo in
self.
a #GCancellable
Increase the reference count of object, and possibly remove the
[floating][floating-ref] reference, if object has a floating reference.
In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.
Since GLib 2.56, the type of object will be propagated to the return type
under the same conditions as for g_object_ref().
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.
the name of the remote
the ref
a #GCancellable
Removes the remote with the given name from the installation.
the name of the remote to remove
a #GCancellable
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
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 %FLATPAK_INSTALL_FLAGS_NO_TRIGGERS,
%FLATPAK_UPDATE_FLAGS_NO_TRIGGERS or %FLATPAK_UNINSTALL_FLAGS_NO_TRIGGERS
flags set.
a #GCancellable
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.utf8cyrillic"``.
the name of the key to set
the new value, or %NULL to unset
a #GCancellable
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
If the object already had an association with that name, the old association will be destroyed.
Internally, the key is converted to a #GQuark using g_quark_from_string().
This means a copy of key is kept permanently (even after object has been
finalized) — so it is recommended to only use a small, bounded set of values
for key in your program, to avoid the #GQuark storage growing unbounded.
name of the key
data to associate with that key
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.
Whether to disallow interactive authorization for operations
Sets a property on an object.
the name of the property to set
the value
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
This function gets back user data pointers stored via
g_object_set_qdata() and removes the data from object
without invoking its destroy() function (if any was
set).
Usually, calling this function is only required to update
user data pointers with a destroy notifier, for example:
void
object_add_to_user_list (GObject *object,
const gchar *new_string)
{
// the quark, naming the object data
GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
// retrieve the old string list
GList *list = g_object_steal_qdata (object, quark_string_list);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().
A #GQuark, naming the user data pointer
Reverts the effect of a previous call to
g_object_freeze_notify(). The freeze count is decreased on object
and when it reaches zero, queued "notify" signals are emitted.
Duplicate notifications for each property are squashed so that at most one #GObject::notify signal is emitted for each property, in the reverse order in which they have been queued.
It is an error to call this function when the freeze count is zero.
This is an old deprecated function, you should use #FlatpakTransaction and flatpak_transaction_add_uninstall() instead. It has a lot more interesting features.
Uninstall an application or runtime.
what this ref contains (an #FlatpakRefKind)
name of the app or runtime to uninstall
architecture of the app or runtime to uninstall; if %NULL, flatpak_get_default_arch() is assumed
name of the branch of the app or runtime to uninstall; if %NULL, master is assumed
a #GCancellable
This is an old deprecated function, you should use #FlatpakTransaction and flatpak_transaction_add_uninstall() instead. It has a lot more interesting features.
Uninstall an application or runtime.
set of #FlatpakUninstallFlags flags
what this ref contains (an #FlatpakRefKind)
name of the app or runtime to uninstall
architecture of the app or runtime to uninstall; if %NULL, flatpak_get_default_arch() is assumed
name of the branch of the app or runtime to uninstall; if %NULL, master is assumed
a #GCancellable
Decreases the reference count of object. When its reference count
drops to 0, the object is finalized (i.e. its memory is freed).
If the pointer to the #GObject may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to %NULL rather than retain a dangling pointer to a potentially invalid #GObject instance. Use g_clear_object() for this.
This is an old deprecated function, you should use #FlatpakTransaction and 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 %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.
set of #FlatpakUpdateFlags flag
whether this is an app or runtime
name of the app or runtime to update
architecture of the app or runtime to update (default: current architecture)
name of the branch of the app or runtime to update (default: master)
a #GCancellable
Updates the local copy of appstream for remote_name for the specified arch.
the name of the remote
Architecture to update, or %NULL for the local machine arch
Set to %TRUE if the contents of the appstream changed, %FALSE if nothing changed
a #GCancellable
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().
the name of the remote
Architecture to update, or %NULL for the local machine arch
Set to %TRUE if the contents of the appstream changed, %FALSE if nothing changed
a #GCancellable
This is an old deprecated function, you should use #FlatpakTransaction and 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 %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.
set of #FlatpakUpdateFlags flag
whether this is an app or runtime
name of the app or runtime to update
architecture of the app or runtime to update (default: current architecture)
name of the branch of the app or runtime to update (default: master)
A list of subpaths to fetch, or %NULL for everything
a #GCancellable
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.
the name of the remote to update
a #GCancellable
This function essentially limits the life time of the closure to
the life time of the object. That is, when the object is finalized,
the closure is invalidated by calling g_closure_invalidate() on
it, in order to prevent invocations of the closure with a finalized
(nonexisting) object. Also, g_object_ref() and g_object_unref() are
added as marshal guards to the closure, to ensure that an extra
reference count is held on object during invocation of the
closure. Usually, this function will be called on closures that
use this object as closure data.
#GClosure to watch
Find the #GParamSpec with the given name for an
interface. Generally, the interface vtable passed in as g_iface
will be the default vtable from g_type_default_interface_ref(), or,
if you know the interface has already been loaded,
g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.
This function is meant to be called from the interface's default
vtable initialization function (the class_init member of
#GTypeInfo.) It must not be called after after class_init has
been called for any object types implementing this interface.
If pspec is a floating reference, it will be consumed.
any interface vtable for the interface, or the default vtable for the interface.
the #GParamSpec for the new property
Lists the properties of an interface.Generally, the interface
vtable passed in as g_iface will be the default vtable from
g_type_default_interface_ref(), or, if you know the interface has
already been loaded, g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
Creates a new #FlatpakInstallation for the installation at the given path.
a #GFile
whether this is a user-specific location
a #GCancellable
Creates a new #FlatpakInstallation for the default system-wide installation.
a #GCancellable
Creates a new #FlatpakInstallation for the system-wide installation id.
the ID of the system-wide installation
a #GCancellable
Creates a new #FlatpakInstallation for the per-user installation.
a #GCancellable
Creates a new instance of a #GObject subtype and sets its properties.
Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.
the type id of the #GObject subtype to instantiate
an array of #GParameter
Adds a new
remoteobject to the set of remotes. This is similar to flatpak_installation_modify_remote() for non-existing remote names. However, if the named remote already exists then instead of modifying it it fails with %FLATPAK_ERROR_ALREADY_INSTALLED, or ifif_neededis 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 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.