as_store_new ()

AsStore *
as_store_new (void);

Creates a new AsStore.

Since: 0.1.0

as_store_error_quark ()

GQuark
as_store_error_quark (void);

Since: 0.1.2

as_store_get_size ()

guint
as_store_get_size (AsStore *store);

Gets the size of the store after deduplication and prioritization has taken place.

Since: 0.1.0

as_store_from_file ()

gboolean
as_store_from_file (AsStore *store,
                    GFile *file,
                    const gchar *icon_root,
                    GCancellable *cancellable,
                    GError **error);

Parses an AppStream XML or DEP-11 YAML file and adds any valid applications to the store.

If the root node does not have a 'origin' attribute, then the method as_store_set_origin() should be called *before* this function if cached icons are required.

If file does not exist, G_IO_ERROR_NOT_FOUND will be returned. Other GIOErrors and AsStoreErrors may be returned as appropriate.

Since: 0.1.0

as_store_from_bytes ()

gboolean
as_store_from_bytes (AsStore *store,
                     GBytes *bytes,
                     GCancellable *cancellable,
                     GError **error);

Parses an appstream store presented as an archive. This is typically a .cab file containing firmware files.

Since: 0.5.2

as_store_from_xml ()

gboolean
as_store_from_xml (AsStore *store,
                   const gchar *data,
                   const gchar *icon_root,
                   GError **error);

Parses AppStream XML file and adds any valid applications to the store.

If the root node does not have a 'origin' attribute, then the method as_store_set_origin() should be called *before* this function if cached icons are required.

Since: 0.1.1

as_store_load ()

gboolean
as_store_load (AsStore *store,
               guint32 flags,
               GCancellable *cancellable,
               GError **error);

Loads the store from the default locations.

Since: 0.1.2

as_store_load_async ()

void
as_store_load_async (AsStore *store,
                     AsStoreLoadFlags flags,
                     GCancellable *cancellable,
                     GAsyncReadyCallback callback,
                     gpointer user_data);

Asynchronously loads the store from the default locations.

Since: 0.7.11

as_store_load_finish ()

gboolean
as_store_load_finish (AsStore *store,
                      GAsyncResult *result,
                      GError **error);

Retrieve the result of as_store_load_async().

Since: 0.7.11

as_store_load_path ()

gboolean
as_store_load_path (AsStore *store,
                    const gchar *path,
                    GCancellable *cancellable,
                    GError **error);

Loads the store from a specific path.

Since: 0.2.2

as_store_load_path_async ()

void
as_store_load_path_async (AsStore *store,
                          const gchar *path,
                          GCancellable *cancellable,
                          GAsyncReadyCallback callback,
                          gpointer user_data);

Asynchronously loads the store from a specific path.

Since: 0.7.11

as_store_load_path_finish ()

gboolean
as_store_load_path_finish (AsStore *store,
                           GAsyncResult *result,
                           GError **error);

Retrieve the result of as_store_load_path_async().

Since: 0.7.11

as_store_load_search_cache ()

void
as_store_load_search_cache (AsStore *store);

Populates the token cache for all applications in the store. This allows all the search keywords for all applications in the store to be pre-processed at one time in multiple threads rather than on demand.

Note: Calling as_app_search_matches() automatically generates the search cache for the AsApp object if it has not already been generated.

Since: 0.6.5

as_store_set_search_match ()

void
as_store_set_search_match (AsStore *store,
                           guint16 search_match);

Sets the token match fields. The bitfield given here is used to choose what is included in the token cache.

Since: 0.6.5

as_store_get_search_match ()

guint16
as_store_get_search_match (AsStore *store);

Gets the token match fields. The bitfield given here is used to choose what is included in the token cache.

Since: 0.6.13

as_store_remove_all ()

void
as_store_remove_all (AsStore *store);

Removes all applications from the store.

Since: 0.2.5

as_store_get_apps ()

GPtrArray *
as_store_get_apps (AsStore *store);

Gets an array of all the valid applications in the store.

Since: 0.1.0

as_store_dup_apps ()

GPtrArray *
as_store_dup_apps (AsStore *store);

Gets an array of all the valid applications in the store.

Since: 0.7.15

as_store_get_apps_by_id ()

GPtrArray *
as_store_get_apps_by_id (AsStore *store,
                         const gchar *id);

Gets an array of all the applications that match a specific ID, ignoring the prefix type.

Since: 0.5.12

as_store_get_apps_by_id_merge ()

GPtrArray *
as_store_get_apps_by_id_merge (AsStore *store,
                               const gchar *id);

Gets an array of all the merge applications that match a specific ID.

Since: 0.7.0

as_store_dup_apps_by_id_merge ()

GPtrArray *
as_store_dup_apps_by_id_merge (AsStore *store,
                               const gchar *id);

Gets an array of all the merge applications that match a specific ID.

Since: 0.7.15

as_store_get_apps_by_metadata ()

GPtrArray *
as_store_get_apps_by_metadata (AsStore *store,
                               const gchar *key,
                               const gchar *value);

Gets an array of all the applications that match a specific metadata element.

Since: 0.1.4

as_store_get_app_by_id ()

AsApp *
as_store_get_app_by_id (AsStore *store,
                        const gchar *id);

Finds an application in the store by ID. If more than one application exists matching the specific ID, (for instance when using AS_STORE_ADD_FLAG_USE_UNIQUE_ID) then the first item that was added is returned.

Since: 0.1.0

as_store_get_app_by_unique_id ()

AsApp *
as_store_get_app_by_unique_id (AsStore *store,
                               const gchar *unique_id,
                               guint32 search_flags);

Finds an application in the store by matching the unique ID.

Since: 0.6.1

as_store_get_app_by_id_ignore_prefix ()

AsApp *
as_store_get_app_by_id_ignore_prefix (AsStore *store,
                                      const gchar *id);

Finds an application in the store ignoring the prefix type.

Since: 0.5.12

as_store_get_app_by_id_with_fallbacks ()

AsApp *
as_store_get_app_by_id_with_fallbacks (AsStore *store,
                                       const gchar *id);

Finds an application in the store by either by the current desktop ID or a desktop ID that it has used previously. This allows upstream software to change their ID (e.g. from cheese.desktop to org.gnome.Cheese.desktop) without us duplicating entries in the software center.

Since: 0.4.1

as_store_get_app_by_pkgname ()

AsApp *
as_store_get_app_by_pkgname (AsStore *store,
                             const gchar *pkgname);

Finds an application in the store by package name.

Since: 0.1.0

as_store_get_app_by_pkgnames ()

AsApp *
as_store_get_app_by_pkgnames (AsStore *store,
                              gchar **pkgnames);

Finds an application in the store by any of the possible package names.

Since: 0.4.1

as_store_get_app_by_provide ()

AsApp *
as_store_get_app_by_provide (AsStore *store,
                             AsProvideKind kind,
                             const gchar *value);

Finds an application in the store by something that it provides.

Since: 0.5.0

as_store_get_app_by_launchable ()

AsApp *
as_store_get_app_by_launchable (AsStore *store,
                                AsLaunchableKind kind,
                                const gchar *value);

Finds an application in the store that provides a specific launchable.

Since: 0.7.8

as_store_get_apps_by_provide ()

GPtrArray *
as_store_get_apps_by_provide (AsStore *store,
                              AsProvideKind kind,
                              const gchar *value);

Finds any applications in the store by something that they provides.

Since: 0.7.5

as_store_add_app ()

void
as_store_add_app (AsStore *store,
                  AsApp *app);

Adds an application to the store. If a lower priority application has already been added then this new application will replace it.

Additionally only applications where the kind is known will be added.

Since: 0.1.0

as_store_add_apps ()

void
as_store_add_apps (AsStore *store,
                   GPtrArray *apps);

Adds several applications to the store.

Additionally only applications where the kind is known will be added.

Since: 0.6.4

as_store_remove_app ()

void
as_store_remove_app (AsStore *store,
                     AsApp *app);

Removes an application from the store if it exists.

Since: 0.1.0

as_store_remove_app_by_id ()

void
as_store_remove_app_by_id (AsStore *store,
                           const gchar *id);

Removes an application from the store if it exists.

Since: 0.3.0

as_store_remove_apps_with_veto ()

void
as_store_remove_apps_with_veto (AsStore *store);

Removes any applications from the store if they have any vetos.

Since: 0.5.13

as_store_to_xml ()

GString *
as_store_to_xml (AsStore *store,
                 guint32 flags);

Outputs an XML representation of all the applications in the store.

Since: 0.1.0

as_store_to_file ()

gboolean
as_store_to_file (AsStore *store,
                  GFile *file,
                  guint32 flags,
                  GCancellable *cancellable,
                  GError **error);

Outputs an optionally compressed XML file of all the applications in the store.

Since: 0.1.0

as_store_convert_icons ()

gboolean
as_store_convert_icons (AsStore *store,
                        AsIconKind kind,
                        GError **error);

Converts all the icons in the store to a specific kind.

Since: 0.3.1

as_store_get_origin ()

const gchar *
as_store_get_origin (AsStore *store);

Gets the metadata origin, which is used to locate icons.

Since: 0.1.1

as_store_set_origin ()

void
as_store_set_origin (AsStore *store,
                     const gchar *origin);

Sets the metadata origin, which is used to locate icons.

Since: 0.1.1

as_store_get_builder_id ()

const gchar *
as_store_get_builder_id (AsStore *store);

Gets the metadata builder identifier, which is used to work out if old metadata is compatible with this builder.

Since: 0.2.5

as_store_set_builder_id ()

void
as_store_set_builder_id (AsStore *store,
                         const gchar *builder_id);

Sets the metadata builder identifier, which is used to work out if old metadata can be used.

Since: 0.2.5

as_store_get_destdir ()

const gchar *
as_store_get_destdir (AsStore *store);

Gets the destdir, which is used to prefix usr.

Since: 0.2.4

as_store_set_destdir ()

void
as_store_set_destdir (AsStore *store,
                      const gchar *destdir);

Sets the destdir, which is used to prefix usr.

Since: 0.2.4

as_store_get_api_version ()

gdouble
as_store_get_api_version (AsStore *store);

Gets the AppStream API version.

Since: 0.1.1

as_store_set_api_version ()

void
as_store_set_api_version (AsStore *store,
                          gdouble api_version);

Sets the AppStream API version.

Since: 0.1.1

as_store_get_version ()

const gchar *
as_store_get_version (AsStore *store);

Gets the AppStream API version.

Since: 0.7.19

as_store_set_version ()

void
as_store_set_version (AsStore *store,
                      const gchar *api_version);

Sets the AppStream API version.

Since: 0.7.19

as_store_get_add_flags ()

guint32
as_store_get_add_flags (AsStore *store);

Gets the flags used for adding applications to the store.

Since: 0.2.2

as_store_set_add_flags ()

void
as_store_set_add_flags (AsStore *store,
                        guint32 add_flags);

Sets the flags used when adding applications to the store.

NOTE: Using AS_STORE_ADD_FLAG_PREFER_LOCAL may be a privacy risk depending on your level of paranoia, and should not be used by default.

Since: 0.2.2

as_store_get_watch_flags ()

guint32
as_store_get_watch_flags (AsStore *store);

Gets the flags used for adding files to the store.

Since: 0.4.2

as_store_set_watch_flags ()

void
as_store_set_watch_flags (AsStore *store,
                          guint32 watch_flags);

Sets the flags used when adding files to the store.

Since: 0.4.2

as_store_validate ()

GPtrArray *
as_store_validate (AsStore *store,
                   guint32 flags,
                   GError **error);

Validates information in the store for data applicable to the defined metadata version.

Since: 0.2.4

as_store_add_metadata_index ()

void
as_store_add_metadata_index (AsStore *store,
                             const gchar *key);

Adds a metadata index key.

NOTE: if applications are removed *all* the indexes will be invalid and will have to be re-added.

Since: 0.3.0

as_store_add_filter ()

void
as_store_add_filter (AsStore *store,
                     AsAppKind kind);

Adds a filter to the store so that only components of this type are loaded into the store. This may be useful if the client is only interested in certain types of component, or not interested in loading components it cannot process.

If no filter is set then all types of components are loaded.

Since: 0.3.5

as_store_remove_filter ()

void
as_store_remove_filter (AsStore *store,
                        AsAppKind kind);

Removed a filter from the store so that components of this type are no longer loaded into the store. This may be useful if the client is only interested in certain types of component.

If all filters are removed then all types of components are loaded.

Since: 0.3.5

AS_TYPE_STORE

#define AS_TYPE_STORE (as_store_get_type ())

struct AsStoreClass

struct AsStoreClass {
	GObjectClass		parent_class;
	void			(*changed) (AsStore *store);
	void			(*app_added) (AsStore *store,
						 AsApp		*app);
	void			(*app_removed) (AsStore *store,
						 AsApp		*app);
	void			(*app_changed) (AsStore *store,
						 AsApp		*app);
};

enum AsStoreLoadFlags

The flags to use when loading the store.

AS_STORE_LOAD_FLAG_XDG_APP_USER

#define AS_STORE_LOAD_FLAG_XDG_APP_USER		AS_STORE_LOAD_FLAG_FLATPAK_USER

AS_STORE_LOAD_FLAG_XDG_APP_SYSTEM

#define AS_STORE_LOAD_FLAG_XDG_APP_SYSTEM AS_STORE_LOAD_FLAG_FLATPAK_SYSTEM

enum AsStoreAddFlags

The flags to use when adding applications to the store.

enum AsStoreWatchFlags

The flags to use when local files are added or removed from the store.

enum AsStoreSearchFlags

The flags to use when searching in the store.

enum AsStoreError

The error type.

AS_STORE_ERROR

#define AS_STORE_ERROR				as_store_error_quark ()

AsStore

typedef struct _AsStore AsStore;