Class (GI Class)

Flatpak-1.0FlatpakTransaction

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

_init abort_webflow add_default_dependency_sources add_dependency_source add_install add_install_bundle add_install_flatpakref add_install_image add_rebase add_rebase_and_uninstall add_sideload_image_collection add_sideload_repo add_sync_preinstalled add_uninstall add_update bind_property bind_property_full block_signal_handler complete_basic_auth connect connect_after disconnect emit force_floating freeze_notify get_auto_install_debug get_auto_install_sdk get_current_operation get_data get_include_unused_uninstall_ops get_installation get_no_deploy get_no_interaction get_no_pull get_operation_for_ref get_operations get_parent_window get_property get_qdata getv init is_empty is_floating notify notify_by_pspec ref ref_sink run run_dispose set set_auto_install_debug set_auto_install_sdk set_data set_default_arch set_disable_auto_pin set_disable_dependencies set_disable_prune set_disable_related set_disable_static_deltas set_force_uninstall set_include_unused_uninstall_ops set_no_deploy set_no_interaction set_no_pull set_parent_window set_property set_reinstall steal_data steal_qdata stop_emission_by_name thaw_notify unblock_signal_handler unref vfunc_add_new_remote vfunc_basic_auth_start vfunc_choose_remote_for_ref vfunc_constructed vfunc_dispatch_properties_changed vfunc_dispose vfunc_end_of_lifed vfunc_end_of_lifed_with_rebase vfunc_finalize vfunc_get_property vfunc_init vfunc_install_authenticator vfunc_new_operation vfunc_notify vfunc_operation_done vfunc_operation_error vfunc_ready vfunc_ready_pre_auth vfunc_run vfunc_set_property vfunc_webflow_done vfunc_webflow_start watch_closure new_for_installation

Methods - Inherited from GObject

Constructors

Properties

Compile-time signal type information.

This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.

Accessors

Methods

  • Cancel an ongoing webflow authentication request. This can be call in the time between Flatpak.Transaction.SignalSignatures.webflow_start | Flatpak.Transaction::webflow-start returned true, and Flatpak.Transaction.SignalSignatures.webflow_done | Flatpak.Transaction::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.

    Parameters

    • id: number

      The webflow id, as passed into the webflow-start signal

    Returns void

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

    Returns void

  • 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().

    Parameters

    Returns void

  • Adds installing the given ref to this transaction.

    The remote can either be a configured remote of the installation, or a file:// uri pointing at a local repository to install from, in which case an origin remote is created.

    Parameters

    • remote: string

      the name of the remote

    • ref: string

      the ref

    • Optionalsubpaths: string[]

      subpaths to install, or the empty list or null to pull all subpaths

    Returns boolean

    true on success; false with error set on failure.

  • Adds installing the given bundle to this transaction.

    Parameters

    • file: Gio.File

      a Gio.File that is an flatpak bundle

    • Optionalgpg_data: GLib.Bytes

      GPG key with which to check bundle signatures, or null to use the key embedded in the bundle (if any)

    Returns boolean

    true on success; false with error set on failure.

  • Adds installing the given flatpakref to this transaction.

    Parameters

    • flatpakref_data: GLib.Bytes | Uint8Array<ArrayBufferLike>

      data from a flatpakref file

    Returns boolean

    true on success; false with error set on failure.

  • Install a Flatpak from a container image. The image is specified

    If the reference from the image was previously installed, then that remote will be used as the remote for the newly installed image. If the reference was not previously installed, then a remote will be created for the reference.

    image_location is specified in containers-transports(5) form. Only a subset of transports are supported: oci:, oci-archive:, and docker:.

    Parameters

    • Optionalimage_location: string

      location string to install from.

    Returns boolean

    true on success; false with error set on failure.

  • Adds updating the previous_ids of the given ref to this transaction, via either installing the ref if it was not already present or updating it. This will treat ref as the result of following an eol-rebase, and data migration from the refs in previous_ids will be set up.

    If you want to rebase the ref and uninstall the old version of it, consider using flatpak_transaction_add_rebase_and_uninstall() instead. It will add appropriate dependencies between the rebase and uninstall operations.

    See flatpak_transaction_add_install() for a description of remote.

    Parameters

    • remote: string

      the name of the remote

    • ref: string

      the ref

    • Optionalsubpaths: string

      the subpaths to include, or null to install the complete ref

    • Optionalprevious_ids: string[]

      Previous ids to add to the given ref. These should simply be the ids, not the full ref names (e.g. org.foo.Bar, not org.foo.Bar/x86_64/master).

    Returns boolean

    true on success; false with error set on failure.

  • Adds updating the previous_ids of the given new_ref to this transaction, via either installing the new_ref if it was not already present or updating it. This will treat new_ref as the result of following an eol-rebase, and data migration from the refs in previous_ids will be set up.

    Also adds an operation to uninstall old_ref to this transaction. This operation will only be run if the operation to install/update new_ref succeeds.

    If old_ref is not already installed (which can happen if requesting to install an EOLed app, rather than update one which is already installed), the uninstall operation will silently not be added, and this function will behave similarly to flatpak_transaction_add_rebase().

    See flatpak_transaction_add_install() for a description of remote.

    Parameters

    • remote: string

      the name of the remote

    • new_ref: string

      the ref to rebase to

    • old_ref: string

      the ref to uninstall

    • Optionalsubpaths: string

      the subpaths to include, or null to install the complete ref

    • Optionalprevious_ids: string[]

      Previous ids to add to the given ref. These should simply be the ids, not the full ref names (e.g. org.foo.Bar, not org.foo.Bar/x86_64/master).

    Returns boolean

    true on success; false with error set on failure.

  • Adds a set of images to be used as source for installation. This is similar to flatpak_transaction_add_sideload_repo(), but the Flatpaks are stored as OCI images rather than ostree commits, and the images are used for all OCI remotes without regard to collection ID.

    Currently location should be either 'oci:' or 'oci-archive:'. Additional schemes may be added in the future.

    Parameters

    • location: string

      source of images for installation

    • Optionalcancellable: Gio.Cancellable

    Returns boolean

  • Adds an extra local ostree repo as source for installation. This is equivalent to using the sideload-repos directories (see flatpak(1)), but can be done dynamically. Any path added here is used in addition to ones in those directories.

    Parameters

    • path: string

      a path to a local flatpak repository

    Returns void

  • Adds preinstall operations to this transaction. This can involve both installing and removing refs, based on /etc/preinstall.d contents and what the system had preinstalled before.

    Returns boolean

    true on success; false with error set on failure.

  • Adds uninstalling the given ref to this transaction. If the transaction is set to not deploy updates, the request is ignored.

    Parameters

    • ref: string

      the ref

    Returns boolean

    true on success; false with error set on failure.

  • Adds updating the given ref to this transaction.

    Parameters

    • ref: string

      the ref

    • Optionalsubpaths: string[]

      subpaths to install; null to use the current set plus the set of configured languages, or { NULL } or { "", NULL } to pull all subpaths.

    • Optionalcommit: string

      the commit to update to, or null to use the latest

    Returns boolean

    true on success; false with error set on failure.

  • 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.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.

    If flags contains GObject.BindingFlags.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 GObject.Binding 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.Object can have multiple bindings.

    Parameters

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • Complete version of g_object_bind_property().

    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.

    If flags contains GObject.BindingFlags.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 transform_from function is only used in case of bidirectional bindings, otherwise it will be ignored

    The binding will automatically be removed when either the source or the target instances are finalized. This will release the reference that is being held on the GObject.Binding instance; if you want to hold on to the GObject.Binding instance, you will need to hold a reference to it.

    To remove the binding, call g_binding_unbind().

    A GObject.Object can have multiple bindings.

    The same user_data parameter will be used for both transform_to and transform_from transformation functions; the notify function will be called once, when the binding is removed. If you need different data for each transformation function, please use g_object_bind_property_with_closures() instead.

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target GObject.Object

    • target_property: string

      the property on target to bind

    • flags: GObject.BindingFlags

      flags to pass to GObject.Binding

    • Optionaltransform_to: BindingTransformFunc

      the transformation function from the source to the target, or null to use the default

    • Optionaltransform_from: BindingTransformFunc

      the transformation function from the target to the source, or null to use the default

    • Optionalnotify: DestroyNotify

      a function to call when disposing the binding, to free resources used by the transformation functions, or null if not required

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

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

    Parameters

    • ...args: never[]

      the property on source to bind

    Returns any

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • Finishes (or aborts) an ongoing basic auth request.

    Parameters

    • id: number

      The webflow id, as passed into the webflow-start signal

    • user: string

      The user name, or null if aborting request

    • password: string

      The password

    • options: GLib.Variant

      Extra a{sv] variant with options (or null), currently unused.

    Returns void

  • Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.

    Parameters

    • id: number

      Handler ID of the handler to be disconnected

    Returns void

  • 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.Object::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.

    Returns void

  • Gets the value set by flatpak_transaction_set_auto_install_debug().

    Returns boolean

    true if auto_install_debug is set, false otherwise

  • Gets the value set by flatpak_transaction_set_auto_install_sdk().

    Returns boolean

    true if auto_install_sdk is set, false otherwise

  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • key: string

      name of the key for that association

    Returns any

    the data if found, or null if no such data exists.

  • Gets the value set by flatpak_transaction_set_include_unused_uninstall_ops().

    Returns boolean

    true if include_unused_uninstall_ops is set, false otherwise

  • Gets whether the transaction is only downloading updates, and not deploying them.

    Returns boolean

    true if no_deploy is set, false otherwise

  • Gets whether the transaction is interactive. See flatpak_transaction_set_no_interaction().

    Returns boolean

    true if the transaction is not interactive, false otherwise

  • Gets whether the transaction should operate only on locally available data.

    Returns boolean

    true if no_pull is set, false otherwise

  • Gets the parent window set for this transaction, or null if unset. See flatpak_transaction_get_parent_window().

    Returns string

    a window name, or null

  • Gets a property of an object.

    The value can be:

    • an empty GObject.Value initialized by G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a GObject.Value initialized with the expected type of the property
    • a GObject.Value initialized with a type to which the expected type of the property can be transformed

    In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.

    Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.

    Parameters

    • property_name: string

      The name of the property to get

    • value: any

      Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type

    Returns any

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

    Parameters

    • names: string[]

      the names of each property to get

    • values: any[]

      the values of each property to get

    Returns void

  • Initializes the object implementing the interface.

    This method is intended for language bindings. If writing in C, g_initable_new() should typically be used instead.

    The object must be initialized before any real use after initial construction, either with this function or g_async_initable_init_async().

    Implementations may also support cancellation. If cancellable is not null, then initialization can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error Gio.IOErrorEnum.CANCELLED will be returned. If cancellable is not null and the object doesn't support cancellable initialization the error Gio.IOErrorEnum.NOT_SUPPORTED will be returned.

    If the object is not initialized, or initialization returns with an error, then all operations on the object except g_object_ref() and g_object_unref() are considered to be invalid, and have undefined behaviour. See the [description][iface@Gio.Initable#description] for more details.

    Callers should not assume that a class which implements Gio.Initable can be initialized multiple times, unless the class explicitly documents itself as supporting this. Generally, a class’ implementation of init() can assume (and assert) that it will only be called once. Previously, this documentation recommended all Gio.Initable implementations should be idempotent; that recommendation was relaxed in GLib 2.54.

    If a class explicitly supports being initialized multiple times, it is recommended that the method is idempotent: multiple calls with the same arguments should return the same results. Only the first call initializes the object; further calls return the result of the first call.

    One reason why a class might need to support idempotent initialization is if it is designed to be used via the singleton pattern, with a GObject.ObjectClass.constructor that sometimes returns an existing instance. In this pattern, a caller would expect to be able to call g_initable_init() on the result of g_object_new(), regardless of whether it is in fact a new instance.

    Parameters

    Returns boolean

    true if successful. If an error has occurred, this function will return false and set error appropriately if present.

  • Returns whether the transaction contains any non-skipped operations.

    Returns boolean

    true if the transaction is empty

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

    Parameters

    • property_name: string

      the name of a property installed on the class of object.

    Returns void

  • 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.:

      typedef enum
    {
    PROP_FOO = 1,
    PROP_LAST
    } MyObjectProperty;

    static GParamSpec *properties[PROP_LAST];

    static void
    my_object_class_init (MyObjectClass *klass)
    {
    properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
    0, 100,
    50,
    G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
    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]);
    

    Parameters

    Returns void

  • Increases the reference count of object.

    Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type of object will be propagated to the return type (using the GCC typeof() extension), so any casting the caller needs to do on the return type must be explicit.

    Returns GObject.Object

    the same object

  • Increase the reference count of object, and possibly remove the floating 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().

    Returns GObject.Object

    object

  • Executes the transaction.

    During the course of the execution, various signals will get emitted. The FlatpakTransaction::choose-remote-for-ref and Flatpak.Transaction.SignalSignatures.add_new_remote | Flatpak.Transaction::add-new-remote signals may get emitted while resolving operations. Flatpak.Transaction::ready is emitted when the transaction has been fully resolved, and Flatpak.Transaction.SignalSignatures.new_operation | Flatpak.Transaction::new-operation and Flatpak.Transaction.SignalSignatures.operation_done | Flatpak.Transaction::operation-done are emitted while the operations are carried out. If an error occurs at any point during the execution, Flatpak.Transaction.SignalSignatures.operation_error | Flatpak.Transaction::operation-error is emitted.

    Note that this call blocks until the transaction is done.

    Parameters

    Returns boolean

    true on success, false if an error occurred

  • Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.

    Parameters

    • properties: { [key: string]: any }

      Object containing the properties to set

    Returns void

  • When this is set to true, Flatpak will automatically install the debug info for each app currently being installed or updated, as well as its dependencies. Does nothing if an uninstall is taking place.

    Parameters

    • auto_install_debug: boolean

      whether to auto install debug info for apps

    Returns void

  • When this is set to true, Flatpak will automatically install the SDK for each app currently being installed or updated. Does nothing if an uninstall is taking place.

    Parameters

    • auto_install_sdk: boolean

      whether to auto install SDKs for apps

    Returns void

  • 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 GLib.Quark 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 GLib.Quark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optionaldata: any

      data to associate with that key

    Returns void

  • Sets the architecture to default to where it is unspecified.

    Parameters

    • arch: string

      the arch to make default

    Returns void

  • Normally the transaction pins any explicit installations so they will not be automatically removed. But this can be disabled if you don't want this behaviour.

    Parameters

    • disable_pin: boolean

      whether to disable auto-pinning

    Returns void

  • Sets whether the transaction should ignore runtime dependencies when resolving operations for applications.

    Parameters

    • disable_dependencies: boolean

      whether to disable runtime dependencies

    Returns void

  • Sets whether the transaction should avoid pruning the local OSTree repository after updating.

    Parameters

    • disable_prune: boolean

      whether to avoid pruning

    Returns void

  • Sets whether the transaction should avoid adding related refs when resolving operations. Related refs are extensions that are suggested by apps, such as locales.

    Parameters

    • disable_related: boolean

      whether to avoid adding related refs

    Returns void

  • Sets whether the transaction should avoid using static deltas when pulling.

    Parameters

    • disable_static_deltas: boolean

      whether to avoid static deltas

    Returns void

  • Sets whether the transaction should uninstall files even if they're used by a running application.

    Parameters

    • force_uninstall: boolean

      whether to force-uninstall refs

    Returns void

  • When this is set to true, Flatpak will add uninstall operations to the transaction for each runtime it considers unused. This is used by the "update" CLI command to garbage collect runtimes and free disk space.

    No guarantees are made about the exact hueristic used; e.g. only end-of-life unused runtimes may be uninstalled with this set. To see the full list of unused runtimes in an installation, use flatpak_installation_list_unused_refs().

    Parameters

    • include_unused_uninstall_ops: boolean

      whether to include unused uninstall ops

    Returns void

  • Sets whether the transaction should download updates, but not deploy them.

    Parameters

    • no_deploy: boolean

      whether to avoid deploying

    Returns void

  • 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, the setting from the parent Flatpak.Installation is used.

    Parameters

    • no_interaction: boolean

      Whether to disallow interactive authorization for operations

    Returns void

  • Sets whether the transaction should operate only on locally available data.

    Parameters

    • no_pull: boolean

      whether to avoid pulls

    Returns void

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

    Parameters

    • parent_window: string

      whether to avoid pulls

    Returns void

  • Sets whether the transaction should uninstall first if a ref is already installed.

    Parameters

    • reinstall: boolean

      whether to reinstall refs

    Returns void

  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • key: string

      name of the key

    Returns any

    the data if found, or null if no such data exists.

  • 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().

    Parameters

    • quark: number

      A GLib.Quark, naming the user data pointer

    Returns any

    The user data pointer set, or null

  • 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.Object::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.

    Returns void

  • 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.Object 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.Object instance. Use g_clear_object() for this.

    Returns void

  • Parameters

    • for_ref: string
    • runtime_ref: string
    • remotes: string

    Returns number

  • the constructed function is called by g_object_new() as the final step of the object creation process. At the point of the call, all construction properties have been set on the object. The purpose of this call is to allow for object initialisation steps that can only be performed after construction properties have been set. constructed implementors should chain up to the constructed call of their parent class to allow it to complete its initialisation.

    Returns void

  • the dispose function is supposed to drop all references to other objects, but keep the instance otherwise intact, so that client method invocations still work. It may be run multiple times (due to reference loops). Before returning, dispose should chain up to the dispose method of the parent class.

    Returns void

  • Parameters

    • ref: string
    • reason: string
    • rebase: string

    Returns void

  • Parameters

    • remote: string
    • ref: string
    • reason: string
    • rebased_to_ref: string
    • previous_ids: string

    Returns boolean

  • Initializes the object implementing the interface.

    This method is intended for language bindings. If writing in C, g_initable_new() should typically be used instead.

    The object must be initialized before any real use after initial construction, either with this function or g_async_initable_init_async().

    Implementations may also support cancellation. If cancellable is not null, then initialization can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error Gio.IOErrorEnum.CANCELLED will be returned. If cancellable is not null and the object doesn't support cancellable initialization the error Gio.IOErrorEnum.NOT_SUPPORTED will be returned.

    If the object is not initialized, or initialization returns with an error, then all operations on the object except g_object_ref() and g_object_unref() are considered to be invalid, and have undefined behaviour. See the [description][iface@Gio.Initable#description] for more details.

    Callers should not assume that a class which implements Gio.Initable can be initialized multiple times, unless the class explicitly documents itself as supporting this. Generally, a class’ implementation of init() can assume (and assert) that it will only be called once. Previously, this documentation recommended all Gio.Initable implementations should be idempotent; that recommendation was relaxed in GLib 2.54.

    If a class explicitly supports being initialized multiple times, it is recommended that the method is idempotent: multiple calls with the same arguments should return the same results. Only the first call initializes the object; further calls return the result of the first call.

    One reason why a class might need to support idempotent initialization is if it is designed to be used via the singleton pattern, with a GObject.ObjectClass.constructor that sometimes returns an existing instance. In this pattern, a caller would expect to be able to call g_initable_init() on the result of g_object_new(), regardless of whether it is in fact a new instance.

    Parameters

    Returns boolean

  • Parameters

    • remote: string
    • authenticator_ref: string

    Returns void

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

    Parameters

    Returns void

  • Executes the transaction.

    During the course of the execution, various signals will get emitted. The FlatpakTransaction::choose-remote-for-ref and Flatpak.Transaction.SignalSignatures.add_new_remote | Flatpak.Transaction::add-new-remote signals may get emitted while resolving operations. Flatpak.Transaction::ready is emitted when the transaction has been fully resolved, and Flatpak.Transaction.SignalSignatures.new_operation | Flatpak.Transaction::new-operation and Flatpak.Transaction.SignalSignatures.operation_done | Flatpak.Transaction::operation-done are emitted while the operations are carried out. If an error occurs at any point during the execution, Flatpak.Transaction.SignalSignatures.operation_error | Flatpak.Transaction::operation-error is emitted.

    Note that this call blocks until the transaction is done.

    Parameters

    Returns boolean

  • the generic setter for all properties of this type. Should be overridden for every type with properties. If implementations of set_property don't emit property change notification explicitly, this will be done implicitly by the type system. However, if the notify signal is emitted explicitly, the type system will not emit it a second time.

    Parameters

    Returns void

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

    Parameters

    Returns void

Methods - Inherited from GObject

  • 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 GObject.ParamSpec, 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 GObject.TypeInfo.) 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.

    Parameters

    Returns void

  • Parameters

    • property_id: number

      the new property ID

    • name: string

      the name of a property registered in a parent class or in an interface of this class.

    Returns void

Interfaces

ConstructorProps
SignalSignatures