Gjsify LogoGjsify Logo

#SnapdClient contains connection state with snapd.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Properties

g_type_instance: TypeInstance
parent_instance: GObject.Object
$gtype: GType<Snapd.Client>
name: string

Methods

  • Asynchronously abort a change. See snapd_client_abort_change_sync() for more information.

    Parameters

    • id: string

      a change ID to abort.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • Complete request started with snapd_client_abort_change_async(). See snapd_client_abort_change_sync() for more information.

    Parameters

    Returns Change

  • Asynchronously add an assertion. See snapd_client_add_assertions_sync() for more information.

    Parameters

    • assertions: string[]

      assertions to add.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • Complete request started with snapd_client_add_assertions_async(). See snapd_client_add_assertions_sync() for more information.

    Parameters

    Returns boolean

  • add_assertions_sync(assertions: string[], cancellable: Gio.Cancellable): boolean
  • Asynchronously create an alias to an app. See snapd_client_alias_sync() for more information.

    Parameters

    • snap: string

      the name of the snap to modify.

    • app: string

      an app in the snap to make the alias to.

    • alias: string

      the name of the alias (i.e. the command that will run this app).

    • progress_callback: Snapd.ProgressCallback

      function to callback with progress.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • Complete request started with snapd_client_alias_async(). See snapd_client_alias_sync() for more information.

    Parameters

    Returns boolean

  • Create an alias to an app.

    Parameters

    • snap: string

      the name of the snap to modify.

    • app: string

      an app in the snap to make the alias to.

    • alias: string

      the name of the alias (i.e. the command that will run this app).

    • progress_callback: Snapd.ProgressCallback

      function to callback with progress.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    Returns boolean

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

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • target_property: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    Returns Binding

  • 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

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • target_property: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transform_to: TClosure<any, any>

      a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default

    • transform_from: TClosure<any, any>

      a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default

    Returns Binding

  • Asynchronously buy a snap from the store. See snapd_client_buy_sync() for more information.

    Parameters

    • id: string

      id of snap to buy.

    • amount: number

      amount of currency to spend, e.g. 0.99.

    • currency: string

      the currency to buy with as an ISO 4217 currency code, e.g. "NZD".

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • Complete request started with snapd_client_buy_async(). See snapd_client_buy_sync() for more information.

    Parameters

    Returns boolean

  • buy_sync(id: string, amount: number, currency: string, cancellable: Gio.Cancellable): boolean
  • Buy a snap from the store. Once purchased, this snap can be installed with snapd_client_install2_sync().

    Parameters

    • id: string

      id of snap to buy.

    • amount: number

      amount of currency to spend, e.g. 0.99.

    • currency: string

      the currency to buy with as an ISO 4217 currency code, e.g. "NZD".

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    Returns boolean

  • Asynchronously check if able to buy snaps. See snapd_client_check_buy_sync() for more information.

    Parameters

    Returns void

  • Complete request started with snapd_client_check_buy_async(). See snapd_client_check_buy_sync() for more information.

    Parameters

    Returns boolean

  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • connect_after(sigName: string, callback: ((...args: any[]) => void)): number
  • Complete request started with snapd_client_connect_async(). See snapd_client_connect_sync() for more information.

    Parameters

    Returns boolean

  • Asynchronously connect two interfaces together. See snapd_client_connect_interface_sync() for more information.

    Parameters

    • plug_snap: string

      name of snap containing plug.

    • plug_name: string

      name of plug to connect.

    • slot_snap: string

      name of snap containing socket.

    • slot_name: string

      name of slot to connect.

    • progress_callback: Snapd.ProgressCallback

      function to callback with progress.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • Complete request started with snapd_client_connect_interface_async(). See snapd_client_connect_interface_sync() for more information.

    Parameters

    Returns boolean

  • connect_interface_sync(plug_snap: string, plug_name: string, slot_snap: string, slot_name: string, progress_callback: Snapd.ProgressCallback, cancellable: Gio.Cancellable): boolean
  • Connect two interfaces together. An asynchronous version of this function is snapd_client_connect_interface_async().

    Parameters

    • plug_snap: string

      name of snap containing plug.

    • plug_name: string

      name of plug to connect.

    • slot_snap: string

      name of snap containing socket.

    • slot_name: string

      name of slot to connect.

    • progress_callback: Snapd.ProgressCallback

      function to callback with progress.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    Returns boolean

  • Asynchronously create a local user account. See snapd_client_create_user_sync() for more information.

    Parameters

    • email: string

      the email of the user to create.

    • flags: CreateUserFlags

      a set of #SnapdCreateUserFlags to control how the user account is created.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • Asynchronously create local user accounts using the system-user assertions that are valid for this device. See snapd_client_create_users_sync() for more information.

    Parameters

    Returns void

  • Asynchronously change the state of aliases. See snapd_client_disable_aliases_sync() for more information.

    Parameters

    • snap: string

      the name of the snap to modify.

    • aliases: string[]

      the aliases to modify.

    • progress_callback: Snapd.ProgressCallback

      function to callback with progress.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • Complete request started with snapd_client_disable_aliases_async(). See snapd_client_disable_aliases_sync() for more information.

    Parameters

    Returns boolean

  • Asynchronously disable an installed snap. See snapd_client_disable_sync() for more information.

    Parameters

    Returns void

  • Complete request started with snapd_client_disable_async(). See snapd_client_disable_sync() for more information.

    Parameters

    Returns boolean

  • disconnect(id: number): void
  • Asynchronously disconnect two interfaces. See snapd_client_disconnect_interface_sync() for more information.

    Parameters

    • plug_snap: string

      name of snap containing plug.

    • plug_name: string

      name of plug to disconnect.

    • slot_snap: string

      name of snap containing socket.

    • slot_name: string

      name of slot to disconnect.

    • progress_callback: Snapd.ProgressCallback

      function to callback with progress.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • disconnect_interface_finish(result: AsyncResult): boolean
  • Complete request started with snapd_client_disconnect_interface_async(). See snapd_client_disconnect_interface_sync() for more information.

    Parameters

    Returns boolean

  • disconnect_interface_sync(plug_snap: string, plug_name: string, slot_snap: string, slot_name: string, progress_callback: Snapd.ProgressCallback, cancellable: Gio.Cancellable): boolean
  • Disconnect two interfaces.

    Parameters

    • plug_snap: string

      name of snap containing plug.

    • plug_name: string

      name of plug to disconnect.

    • slot_snap: string

      name of snap containing socket.

    • slot_name: string

      name of slot to disconnect.

    • progress_callback: Snapd.ProgressCallback

      function to callback with progress.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    Returns boolean

  • Asynchronously download a snap. See snapd_client_download_sync() for more information.

    Parameters

    • name: string

      name of snap to download.

    • channel: string

      channel to download from.

    • revision: string

      revision to download.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • download_sync(name: string, channel: string, revision: string, cancellable: Gio.Cancellable): Bytes
  • Download the given snap.

    Parameters

    • name: string

      name of snap to download.

    • channel: string

      channel to download from.

    • revision: string

      revision to download.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    Returns Bytes

  • emit(sigName: string, ...args: any[]): void
  • Asynchronously change the state of aliases. See snapd_client_enable_aliases_sync() for more information.

    Parameters

    • snap: string

      the name of the snap to modify.

    • aliases: string[]

      the aliases to modify.

    • progress_callback: Snapd.ProgressCallback

      function to callback with progress.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • Complete request started with snapd_client_enable_aliases_async(). See snapd_client_enable_aliases_sync() for more information.

    Parameters

    Returns boolean

  • Asynchronously enable an installed snap. See snapd_client_enable_sync() for more information.

    Parameters

    Returns void

  • Complete request started with snapd_client_enable_async(). See snapd_client_enable_sync() for more information.

    Parameters

    Returns boolean

  • Asynchronously find snaps in the store. See snapd_client_find_sync() for more information.

    Parameters

    • flags: Snapd.FindFlags

      a set of #SnapdFindFlags to control how the find is performed.

    • query: string

      query string to send.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • Complete request started with snapd_client_find_async(). See snapd_client_find_sync() for more information.

    Parameters

    Returns [Snap[], string]

  • Asynchronously find snaps in store that are newer revisions than locally installed versions. See snapd_client_find_refreshable_sync() for more information.

    Parameters

    Returns void

  • Complete request started with snapd_client_find_refreshable_async(). See snapd_client_find_refreshable_sync() for more information.

    Parameters

    Returns Snap[]

  • Asynchronously find snaps in the store. See snapd_client_find_section_sync() for more information.

    Parameters

    • flags: Snapd.FindFlags

      a set of #SnapdFindFlags to control how the find is performed.

    • section: string

      store section to search in or %NULL to search in all sections.

    • query: string

      query string to send or %NULL to get all snaps from the given section.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • Complete request started with snapd_client_find_async(). See snapd_client_find_sync() for more information.

    Parameters

    Returns [Snap[], string]

  • Find snaps in the store.

    Parameters

    • flags: Snapd.FindFlags

      a set of #SnapdFindFlags to control how the find is performed.

    • section: string

      store section to search in or %NULL to search in all sections.

    • query: string

      query string to send or %NULL to get all snaps from the given section.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    Returns [Snap[], string]

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

    Returns void

  • freeze_notify(): 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::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

  • Asynchronously get the available aliases. See snapd_client_get_aliases_sync() for more information.

    Parameters

    Returns void

  • Complete request started with snapd_client_get_aliases_async(). See snapd_client_get_aliases_sync() for more information.

    Parameters

    Returns Alias[]

  • get_allow_interaction(): boolean
  • Asynchronously get information on installed apps. See snapd_client_get_apps2_sync() for more information.

    Parameters

    • flags: GetAppsFlags

      a set of #SnapdGetAppsFlags to control what results are returned.

    • snaps: string[]

      A list of snap names to return results for. If %NULL or empty then apps for all installed snaps are returned.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • Get information on installed apps.

    Parameters

    • flags: GetAppsFlags

      a set of #SnapdGetAppsFlags to control what results are returned.

    • snaps: string[]

      A list of snap names to return results for. If %NULL or empty then apps for all installed snaps are returned.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    Returns Snapd.App[]

  • Asynchronously get information on installed apps. See snapd_client_get_apps_sync() for more information.

    Parameters

    • flags: GetAppsFlags

      a set of #SnapdGetAppsFlags to control what results are returned.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • Asynchronously get assertions. See snapd_client_get_assertions_sync() for more information.

    Parameters

    • type: string

      assertion type to get.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • Complete request started with snapd_client_get_assertions_async(). See snapd_client_get_assertions_sync() for more information.

    Parameters

    Returns string[]

  • get_assertions_sync(type: string, cancellable: Gio.Cancellable): string[]
  • Asynchronously get information on a change. See snapd_client_get_change_sync() for more information.

    Parameters

    • id: string

      a change ID to get information on.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • Asynchronously get changes that have occurred / are occurring on the snap daemon. See snapd_client_get_changes_sync() for more information.

    Parameters

    • filter: ChangeFilter

      changes to filter on.

    • snap_name: string

      name of snap to filter on or %NULL for changes for any snap.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • Complete request started with snapd_client_get_changes_async(). See snapd_client_get_changes_sync() for more information.

    Parameters

    Returns Change[]

  • Get changes that have occurred / are occurring on the snap daemon.

    Parameters

    • filter: ChangeFilter

      changes to filter on.

    • snap_name: string

      name of snap to filter on or %NULL for changes for any snap.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    Returns Change[]

  • Asynchronously get the installed snap connections. See snapd_client_get_connections_sync() for more information.

    Parameters

    • flags: GetConnectionsFlags

      a set of #SnapdGetConnectionsFlags to control what results are returned.

    • snap: string

      the name of the snap to get connections for or %NULL for all snaps.

    • interface: string

      the name of the interface to get connections for or %NULL for all interfaces.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • Asynchronously get the installed snap connections. See snapd_client_get_connections_sync() for more information.

    Parameters

    Returns void

  • get_data(key?: string): object
  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • Optional key: string

      name of the key for that association

    Returns object

  • Asynchronously get the icon for an installed snap. See snapd_client_get_icon_sync() for more information.

    Parameters

    • name: string

      name of snap to get icon for.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • Asynchronously get the installed snap interfaces. See snapd_client_get_interfaces2_sync() for more information.

    Parameters

    • flags: GetInterfacesFlags

      a set of #SnapdGetInterfacesFlags to control what information is returned about the interfaces.

    • names: string[]

      a null-terminated array of interface names or %NULL.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • Get information about the available snap interfaces.

    Parameters

    • flags: GetInterfacesFlags

      a set of #SnapdGetInterfacesFlags to control what information is returned about the interfaces.

    • names: string[]

      a null-terminated array of interface names or %NULL.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    Returns Snapd.Interface[]

  • Asynchronously get the installed snap interfaces. See snapd_client_get_interfaces_sync() for more information.

    Parameters

    Returns void

  • Get the maintenance information reported by snapd or %NULL if no maintenance is in progress. This information is updated after every request.

    Returns Maintenance

  • get_property(property_name?: string, value?: any): void
  • Gets a property of an object.

    The value can be:

    • an empty #GValue initialized by %G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a #GValue initialized with the expected type of the property
    • a #GValue 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 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.

    Parameters

    • Optional property_name: string

      the name of the property to get

    • Optional value: any

      return location for the property value

    Returns void

  • get_qdata(quark: number): object
  • Asynchronously get the store sections. See snapd_client_get_sections_sync() for more information.

    Parameters

    Returns void

  • Complete request started with snapd_client_get_sections_async(). See snapd_client_get_sections_sync() for more information.

    Parameters

    Returns string[]

  • Asynchronously get information of a single installed snap. See snapd_client_get_snap_sync() for more information.

    Parameters

    • name: string

      name of snap to get.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • Asynchronously get configuration for a snap. See snapd_client_get_snap_conf_sync() for more information.

    Parameters

    • name: string

      name of snap to get configuration from.

    • keys: string[]

      keys to returns or %NULL to return all.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • get_snap_conf_finish(result: AsyncResult): HashTable<string | number | symbol, string | number | boolean>
  • Complete request started with snapd_client_get_snap_conf_async(). See snapd_client_get_snap_conf_sync() for more information.

    Parameters

    Returns HashTable<string | number | symbol, string | number | boolean>

  • get_snap_conf_sync(name: string, keys: string[], cancellable: Gio.Cancellable): HashTable<string | number | symbol, string | number | boolean>
  • Get configuration for a snap. System configuration is stored using the name "system".

    Parameters

    • name: string

      name of snap to get configuration from.

    • keys: string[]

      keys to returns or %NULL to return all.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    Returns HashTable<string | number | symbol, string | number | boolean>

  • Complete request started with snapd_client_get_snap_async(). See snapd_client_get_snap_sync() for more information.

    Parameters

    Returns Snap

  • Get information of a single installed snap. If the snap does not exist an error occurs.

    Parameters

    • name: string

      name of snap to get.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    Returns Snap

  • Asynchronously get information on installed snaps. See snapd_client_get_snaps_sync() for more information.

    Parameters

    • flags: GetSnapsFlags

      a set of #SnapdGetSnapsFlags to control what results are returned.

    • names: string[]

      A list of snap names to return results for. If %NULL or empty then all installed snaps are returned.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • Complete request started with snapd_client_get_snaps_async(). See snapd_client_get_snaps_sync() for more information.

    Parameters

    Returns Snap[]

  • Get information on installed snaps (snaps with status %SNAPD_SNAP_STATUS_ACTIVE). If flags contains %SNAPD_GET_SNAPS_FLAGS_INCLUDE_INACTIVE then also return snaps with status %SNAPD_SNAP_STATUS_INSTALLED.

    If names is not %NULL and contains at least one name only snaps that match these names are returned. If a snap is not installed it is not returned (no error is generated).

    Parameters

    • flags: GetSnapsFlags

      a set of #SnapdGetSnapsFlags to control what results are returned.

    • names: string[]

      A list of snap names or %NULL.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    Returns Snap[]

  • get_socket_path(): string
  • Request system information asynchronously from snapd. See snapd_client_get_system_information_sync() for more information.

    Parameters

    Returns void

  • get_user_agent(): string
  • Asynchronously get user accounts that are valid for this device. See snapd_client_get_users_sync() for more information.

    Parameters

    Returns void

  • getv(names: string[], values: any[]): void
  • 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

  • Asynchronously install a snap from the store. See snapd_client_install2_sync() for more information.

    Parameters

    • flags: Snapd.InstallFlags

      a set of #SnapdInstallFlags to control install options.

    • name: string

      name of snap to install.

    • channel: string

      channel to install from or %NULL for default.

    • revision: string

      revision to install or %NULL for default.

    • progress_callback: Snapd.ProgressCallback

      function to callback with progress.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • Complete request started with snapd_client_install2_async(). See snapd_client_install2_sync() for more information.

    Parameters

    Returns boolean

  • Install a snap from the store.

    Parameters

    • flags: Snapd.InstallFlags

      a set of #SnapdInstallFlags to control install options.

    • name: string

      name of snap to install.

    • channel: string

      channel to install from or %NULL for default.

    • revision: string

      revision to install or %NULL for default.

    • progress_callback: Snapd.ProgressCallback

      function to callback with progress.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    Returns boolean

  • Asynchronously install a snap from the store. See snapd_client_install_sync() for more information.

    Parameters

    • name: string

      name of snap to install.

    • channel: string

      channel to install from or %NULL for default.

    • progress_callback: Snapd.ProgressCallback

      function to callback with progress.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • Complete request started with snapd_client_install_async(). See snapd_client_install_sync() for more information.

    Parameters

    Returns boolean

  • Complete request started with snapd_client_install_stream_async(). See snapd_client_install_stream_sync() for more information.

    Parameters

    Returns boolean

  • Install a snap. The snap contents are provided in the form of an input stream. To install from a local file, do the following:

    |[ g_autoptr(GFile) file = g_file_new_for_path (path_to_snap_file); g_autoptr(GInputStream) stream = g_file_read (file, cancellable, &error); snapd_client_install_stream_sync (self, stream, progress_cb, NULL, cancellable, &error); ]

    Or if you have the file in memory you can use:

    |[ g_autoptr(GInputStream) stream = g_memory_input_stream_new_from_data (data, data_length, free_data); snapd_client_install_stream_sync (self, stream, progress_cb, NULL, cancellable, &error); ]

    Parameters

    Returns boolean

  • Install a snap from the store.

    Parameters

    • name: string

      name of snap to install.

    • channel: string

      channel to install from or %NULL for default.

    • progress_callback: Snapd.ProgressCallback

      function to callback with progress.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    Returns boolean

  • is_floating(): boolean
  • Asynchronously get information on all installed snaps. See snapd_client_list_sync() for more information.

    Parameters

    Returns void

  • Asynchronously get information of a single installed snap. See snapd_client_list_one_sync() for more information.

    Parameters

    • name: string

      name of snap to get.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • Complete request started with snapd_client_list_one_async(). See snapd_client_list_one_sync() for more information.

    Parameters

    Returns Snap

  • Asynchronously get authorization to install/remove snaps. See snapd_client_login2_sync() for more information.

    Parameters

    • email: string

      email address to log in with.

    • password: string

      password to log in with.

    • otp: string

      response to one-time password challenge.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • Log in to snapd and get authorization to install/remove snaps.

    Parameters

    • email: string

      email address to log in with.

    • password: string

      password to log in with.

    • otp: string

      response to one-time password challenge.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    Returns UserInformation

  • Asynchronously get authorization to install/remove snaps. See snapd_client_login_sync() for more information.

    Parameters

    • email: string

      email address to log in with.

    • password: string

      password to log in with.

    • otp: string

      response to one-time password challenge.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • Log in to snapd and get authorization to install/remove snaps.

    Parameters

    • email: string

      email address to log in with.

    • password: string

      password to log in with.

    • otp: string

      response to one-time password challenge.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    Returns Snapd.AuthData

  • Asynchronously log out from the snap store. See snapd_client_logout_sync() for more information.

    Parameters

    • id: number

      login ID to use.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • Complete request started with snapd_client_logout_async(). See snapd_client_logout_sync() for more information.

    Parameters

    Returns boolean

  • notify(property_name: string): 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

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

      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]);
    

    Parameters

    • pspec: ParamSpec

      the #GParamSpec of a property installed on the class of object.

    Returns void

  • Complete request started with snapd_client_prefer_async(). See snapd_client_prefer_sync() for more information.

    Parameters

    Returns boolean

  • 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

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

    Returns GObject.Object

  • Asynchronously ensure all snaps are updated to their latest versions. See snapd_client_refresh_all_sync() for more information.

    Parameters

    Returns void

  • Complete request started with snapd_client_refresh_all_async(). See snapd_client_refresh_all_sync() for more information.

    Parameters

    Returns string[]

  • Asynchronously ensure an installed snap is at the latest version. See snapd_client_refresh_sync() for more information.

    Parameters

    • name: string

      name of snap to refresh.

    • channel: string

      channel to refresh from or %NULL for default.

    • progress_callback: Snapd.ProgressCallback

      function to callback with progress.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • Complete request started with snapd_client_refresh_async(). See snapd_client_refresh_sync() for more information.

    Parameters

    Returns boolean

  • Ensure an installed snap is at the latest version.

    Parameters

    • name: string

      name of snap to refresh.

    • channel: string

      channel to refresh from or %NULL for default.

    • progress_callback: Snapd.ProgressCallback

      function to callback with progress.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    Returns boolean

  • Asynchronously uninstall a snap. See snapd_client_remove2_sync() for more information.

    Parameters

    • flags: RemoveFlags

      a set of #SnapdRemoveFlags to control remove options.

    • name: string

      name of snap to remove.

    • progress_callback: Snapd.ProgressCallback

      function to callback with progress.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • Complete request started with snapd_client_remove2_async(). See snapd_client_remove2_sync() for more information.

    Parameters

    Returns boolean

  • Asynchronously uninstall a snap. See snapd_client_remove_sync() for more information.

    Parameters

    Returns void

  • Complete request started with snapd_client_remove_async(). See snapd_client_remove_sync() for more information.

    Parameters

    Returns boolean

  • Asynchronously change the state of aliases. See snapd_client_reset_aliases_sync() for more information.

    Parameters

    • snap: string

      the name of the snap to modify.

    • aliases: string[]

      the aliases to modify.

    • progress_callback: Snapd.ProgressCallback

      function to callback with progress.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • Complete request started with snapd_client_reset_aliases_async(). See snapd_client_reset_aliases_sync() for more information.

    Parameters

    Returns boolean

  • run_dispose(): void
  • Releases all references to other objects. This can be used to break reference cycles.

    This function should only be called from object system implementations.

    Returns void

  • Asynchronously run a snapctl command. See snapd_client_run_snapctl_sync() for more information.

    Parameters

    • context_id: string

      context for this call.

    • args: string[]

      the arguments to pass to snapctl.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • run_snapctl_finish(result: AsyncResult): [boolean, string, string]
  • Complete request started with snapd_client_run_snapctl_async(). See snapd_client_run_snapctl_sync() for more information.

    Parameters

    Returns [boolean, string, string]

  • run_snapctl_sync(context_id: string, args: string[], cancellable: Gio.Cancellable): [boolean, string[], string[]]
  • Run a snapctl command.

    Parameters

    • context_id: string

      context for this call.

    • args: string[]

      the arguments to pass to snapctl.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    Returns [boolean, string[], string[]]

  • set_allow_interaction(allow_interaction: boolean): void
  • Set whether snapd operations are allowed to interact with the user. This affects operations that use polkit authorisation. Defaults to TRUE.

    Parameters

    • allow_interaction: boolean

      whether to allow interaction.

    Returns void

  • Set the authorization data to use for requests. Authorization data can be obtained by:

    • Logging into snapd using snapd_client_login_sync()

    • Using an existing authorization with snapd_auth_data_new().

    Parameters

    Returns void

  • set_data(key: string, data?: object): 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 #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.

    Parameters

    • key: string

      name of the key

    • Optional data: object

      data to associate with that key

    Returns void

  • set_property(property_name: string, value?: any): void
  • Asynchronously set configuration for a snap. See snapd_client_set_snap_conf_sync() for more information.

    Parameters

    • name: string

      name of snap to set configuration for.

    • key_values: HashTable<string | number | symbol, string | number | boolean>

      Keys to set.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • Complete request started with snapd_client_set_snap_conf_async(). See snapd_client_set_snap_conf_sync() for more information.

    Parameters

    Returns boolean

  • set_snap_conf_sync(name: string, key_values: HashTable<string | number | symbol, string | number | boolean>, cancellable: Gio.Cancellable): boolean
  • Set configuration for a snap. System configuration is stored using the name "system".

    Parameters

    • name: string

      name of snap to set configuration for.

    • key_values: HashTable<string | number | symbol, string | number | boolean>

      Keys to set.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    Returns boolean

  • set_socket_path(socket_path: string): void
  • Set the Unix socket path to connect to snapd with. Defaults to the system socket.

    Parameters

    • socket_path: string

      a socket path or %NULL to reset to the default.

    Returns void

  • set_user_agent(user_agent: string): void
  • Set the HTTP user-agent that is sent with each request to snapd. Defaults to "snapd-glib/VERSION".

    Parameters

    • user_agent: string

      a user agent or %NULL.

    Returns void

  • steal_data(key?: string): object
  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • Optional key: string

      name of the key

    Returns object

  • steal_qdata(quark: number): object
  • 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 #GQuark, naming the user data pointer

    Returns object

  • Asynchronously set the tracking channel on an installed snap. See snapd_client_switch_sync() for more information.

    Parameters

    • name: string

      name of snap to switch channel.

    • channel: string

      channel to track.

    • progress_callback: Snapd.ProgressCallback

      function to callback with progress.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • Complete request started with snapd_client_switch_async(). See snapd_client_switch_sync() for more information.

    Parameters

    Returns boolean

  • Set the tracking channel on an installed snap.

    Parameters

    • name: string

      name of snap to switch channel.

    • channel: string

      channel to track.

    • progress_callback: Snapd.ProgressCallback

      function to callback with progress.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    Returns boolean

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

    Returns void

  • Asynchronously try a snap. See snapd_client_try_sync() for more information.

    Parameters

    • path: string

      path to snap directory to try.

    • progress_callback: Snapd.ProgressCallback

      function to callback with progress.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • Complete request started with snapd_client_try_async(). See snapd_client_try_sync() for more information.

    Parameters

    Returns boolean

  • Asynchronously remove an alias from an app. See snapd_client_unalias_sync() for more information.

    Parameters

    • snap: string

      the name of the snap to modify or %NULL.

    • alias: string

      the name of the alias to remove or %NULL to remove all aliases for the given snap.

    • progress_callback: Snapd.ProgressCallback

      function to callback with progress.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • Complete request started with snapd_client_unalias_async(). See snapd_client_unalias_sync() for more information.

    Parameters

    Returns boolean

  • Remove an alias from an app.

    Parameters

    • snap: string

      the name of the snap to modify or %NULL.

    • alias: string

      the name of the alias to remove or %NULL to remove all aliases for the given snap.

    • progress_callback: Snapd.ProgressCallback

      function to callback with progress.

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL.

    Returns boolean

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

    Returns void

  • vfunc_constructed(): void
  • vfunc_dispatch_properties_changed(n_pspecs: number, pspecs: ParamSpec): void
  • vfunc_dispose(): void
  • vfunc_finalize(): void
  • vfunc_get_property(property_id: number, value?: any, pspec?: ParamSpec): 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.

    virtual

    Parameters

    Returns void

  • vfunc_set_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • watch_closure(closure: TClosure<any, any>): 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

    • closure: TClosure<any, any>

      #GClosure to watch

    Returns void

  • compat_control(what: number, data: object): number
  • 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().

    Parameters

    • g_iface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    • property_name: string

      name of a property to look up.

    Returns ParamSpec

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

    Parameters

    • g_iface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface.

    • pspec: ParamSpec

      the #GParamSpec for the new property

    Returns void

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

    Parameters

    • g_iface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    Returns ParamSpec[]

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

    Parameters

    • object_type: GType<unknown>

      the type id of the #GObject subtype to instantiate

    • parameters: GObject.Parameter[]

      an array of #GParameter

    Returns GObject.Object

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method