as_pool_error_quark ()

GQuark
as_pool_error_quark (void);

as_pool_new ()

AsPool *
as_pool_new (void);

Creates a new AsPool.

as_pool_get_locale ()

const gchar *
as_pool_get_locale (AsPool *pool);

Gets the currently used locale.

as_pool_set_locale ()

void
as_pool_set_locale (AsPool *pool,
                    const gchar *locale);

Sets the current locale which should be used when parsing metadata.

as_pool_load ()

gboolean
as_pool_load (AsPool *pool,
              GCancellable *cancellable,
              GError **error);

Builds an index of all found components in the watched locations. The function will try to get as much data into the pool as possible, so even if the update completes with FALSE, it might still have added components to the pool.

The function will load from all possible data sources, preferring caches if they are up to date.

as_pool_load_async ()

void
as_pool_load_async (AsPool *pool,
                    GCancellable *cancellable,
                    GAsyncReadyCallback callback,
                    gpointer user_data);

Asynchronously loads data from all registered locations. Equivalent to as_pool_load() (but asynchronous)

Since: 0.12.10

as_pool_load_finish ()

gboolean
as_pool_load_finish (AsPool *pool,
                     GAsyncResult *result,
                     GError **error);

Retrieve the result of as_pool_load_async().

Since: 0.12.10

as_pool_clear ()

void
as_pool_clear (AsPool *pool);

Remove all metadata from the pool, data will be reloaded once as_pool_load is called again.

as_pool_add_components ()

gboolean
as_pool_add_components (AsPool *pool,
                        GPtrArray *cpts,
                        GError **error);

Register a set of components with the pool temporarily. Data from components added like this will not be cached.

Since: 0.15.0

as_pool_get_components ()

GPtrArray *
as_pool_get_components (AsPool *pool);

Get a list of found components.

[skip]

as_pool_get_components_by_id ()

GPtrArray *
as_pool_get_components_by_id (AsPool *pool,
                              const gchar *cid);

Get a specific component by its ID. This function may contain multiple results if we have data describing this component from multiple scopes/origin types.

[skip]

as_pool_get_components_by_provided_item ()

GPtrArray *
as_pool_get_components_by_provided_item
                               (AsPool *pool,
                                AsProvidedKind kind,
                                const gchar *item);

Find components in the AppStream data pool which provide a certain item.

[skip]

as_pool_get_components_by_kind ()

GPtrArray *
as_pool_get_components_by_kind (AsPool *pool,
                                AsComponentKind kind);

Return a list of all components in the pool which are of a certain kind.

[skip]

as_pool_get_components_by_categories ()

GPtrArray *
as_pool_get_components_by_categories (AsPool *pool,
                                      gchar **categories);

Return a list of components which are in all of the categories.

[skip]

as_pool_get_components_by_launchable ()

GPtrArray *
as_pool_get_components_by_launchable (AsPool *pool,
                                      AsLaunchableKind kind,
                                      const gchar *id);

Find components in the AppStream data pool which provide a specific launchable. See AsLaunchable for details on launchables, or refer to the AppStream specification.

[skip]

Since: 0.11.4

as_pool_get_components_by_extends ()

GPtrArray *
as_pool_get_components_by_extends (AsPool *pool,
                                   const gchar *extended_id);

Find components extending the component with the given ID. They can then be registered to the AsComponent they extend via as_component_add_addon. If the AS_POOL_FLAG_RESOLVE_ADDONS pool flag is set, addons are automatically resolved and this explicit function is not needed, but overall query time will be increased (so only use this flag if you will be resolving addon information later anyway).

[skip]

Since: 0.15.0

as_pool_get_components_by_bundle_id ()

GPtrArray *
as_pool_get_components_by_bundle_id (AsPool *pool,
                                     AsBundleKind kind,
                                     const gchar *bundle_id,
                                     gboolean match_prefix);

Find components that are provided by a bundle with a specific ID by its prefix. For example, given a AS_BUNDLE_KIND_FLATPAK and a bundle_id "org.kde.dolphin/", it will list all the components that bundle dolphin. If the bundle_id is "org.kde.dolphin/x86_64" it will give those with also the architecture.

[skip]

Since: 0.16.0

as_pool_search ()

GPtrArray *
as_pool_search (AsPool *pool,
                const gchar *search);

Search for a list of components matching the search term. The list will be ordered by match score.

[skip]

Since: 0.9.7

as_pool_build_search_tokens ()

gchar **
as_pool_build_search_tokens (AsPool *pool,
                             const gchar *search);

Splits up a string into an array of tokens that are suitable for searching. This includes stripping whitespaces, casefolding the terms and removing greylist words.

This function is usually called automatically when needed, you will only need to run it explicitly when you need to check which search tokens the pool will actually use internally for a given phrase.

as_pool_reset_extra_data_locations ()

void
as_pool_reset_extra_data_locations (AsPool *pool);

Remove all explicitly added metadata locations.

Since: 0.15.0

as_pool_add_extra_data_location ()

void
as_pool_add_extra_data_location (AsPool *pool,
                                 const gchar *directory,
                                 AsFormatStyle format_style);

Add an additional non-standard location to the metadata pool where metadata will be read from. If directory contains a "xml", "xmls", "yaml" or "icons" subdirectory (or all of them), those paths will be added to the search paths instead.

as_pool_get_flags ()

AsPoolFlags
as_pool_get_flags (AsPool *pool);

Get the AsPoolFlags for this data pool.

as_pool_set_flags ()

void
as_pool_set_flags (AsPool *pool,
                   AsPoolFlags flags);

Set the AsPoolFlags for this data pool.

as_pool_add_flags ()

void
as_pool_add_flags (AsPool *pool,
                   AsPoolFlags flags);

Convenience function to add one or multiple AsPoolFlags to the flag set of this data pool.

Since: 0.15.0

as_pool_remove_flags ()

void
as_pool_remove_flags (AsPool *pool,
                      AsPoolFlags flags);

Convenience function to remove one or multiple AsPoolFlags from the flag set of this data pool.

Since: 0.15.0

as_pool_set_load_std_data_locations ()

void
as_pool_set_load_std_data_locations (AsPool *pool,
                                     gboolean enabled);

This is a convenience function that enables or disables loading of metadata from well-known standard locations by configuring the AsPoolFlags of this AsPool accordingly. Data affected by this includes the OS data catalog, metainfo, desktop-entry files and Flatpak data. If you need more fine-grained control, set the AsPoolFlags explicitly.

Since: 0.15.0

as_pool_add_component ()

gboolean
as_pool_add_component (AsPool *pool,
                       AsComponent *cpt,
                       GError **error);

Register a new component in the AppStream metadata pool.

as_pool_load_cache_file ()

gboolean
as_pool_load_cache_file (AsPool *pool,
                         const gchar *fname,
                         GError **error);

Load AppStream metadata from a cache file.

as_pool_save_cache_file ()

gboolean
as_pool_save_cache_file (AsPool *pool,
                         const gchar *fname,
                         GError **error);

Serialize AppStream metadata to a cache file.

as_pool_refresh_cache ()

gboolean
as_pool_refresh_cache (AsPool *pool,
                       gboolean force,
                       GError **error);

Update the AppStream cache. There is normally no need to call this function manually, because cache updates are handled transparently in the background.

as_pool_clear2 ()

gboolean
as_pool_clear2 (AsPool *pool,
                GError **error);

Remove all metadata from the pool.

as_pool_get_cache_location ()

const gchar *
as_pool_get_cache_location (AsPool *pool);

Gets the location of the session cache.

as_pool_set_cache_location ()

void
as_pool_set_cache_location (AsPool *pool,
                            const gchar *fname);

Sets the name of the cache file. If fname is ":memory", the cache will be kept in memory, if it is set to ":temporary", the cache will be stored in a temporary directory. In any other case, the given filename is used.

Since: 0.12.7

as_pool_get_cache_flags ()

AsCacheFlags
as_pool_get_cache_flags (AsPool *pool);

Get the AsCacheFlags for this data pool.

as_pool_set_cache_flags ()

void
as_pool_set_cache_flags (AsPool *pool,
                         AsCacheFlags flags);

Set the AsCacheFlags for this data pool.

as_pool_clear_metadata_locations ()

void
as_pool_clear_metadata_locations (AsPool *pool);

Remove all metadata locations from the list of watched locations.

as_pool_add_metadata_location ()

void
as_pool_add_metadata_location (AsPool *pool,
                               const gchar *directory);

Add a location for the data pool to read data from. If directory contains a "xml", "xmls", "yaml" or "icons" subdirectory (or all of them), those paths will be added to the search paths instead.

AS_TYPE_POOL

#define AS_TYPE_POOL (as_pool_get_type ())

struct AsPoolClass

struct AsPoolClass {
	GObjectClass parent_class;
	void		(*changed) (AsPool *pool);
};

enum AsPoolFlags

Flags controlling the metadata pool behavior.

AS_POOL_FLAG_LOAD_OS_COLLECTION

#define AS_POOL_FLAG_LOAD_OS_COLLECTION AS_POOL_FLAG_LOAD_OS_CATALOG

AS_POOL_FLAG_READ_COLLECTION

#define AS_POOL_FLAG_READ_COLLECTION AS_POOL_FLAG_LOAD_OS_CATALOG

AS_POOL_FLAG_READ_METAINFO

#define AS_POOL_FLAG_READ_METAINFO AS_POOL_FLAG_LOAD_OS_METAINFO

AS_POOL_FLAG_READ_DESKTOP_FILES

#define AS_POOL_FLAG_READ_DESKTOP_FILES AS_POOL_FLAG_LOAD_OS_DESKTOP_FILES

enum AsCacheFlags

Flags on how caching should be used.

enum AsPoolError

A metadata pool error.

AS_POOL_ERROR

#define AS_POOL_ERROR as_pool_error_quark ()

AsPool

typedef struct _AsPool AsPool;