gs_app_new ()

GsApp *
gs_app_new (const gchar *id);

Creates a new application object.

The ID should only be set when the application ID (with optional prefix) is known; it is perfectly valid to use gs_app_new() with an id of NULL, and then relying on another plugin to set the id using gs_app_set_id() based on some other information.

For instance, a GsApp is created with no ID when returning results from the packagekit plugin, but with the default source name set as the package name. The source name is read by the appstream plugin, and if matched in the AppStream XML the correct ID is set, along with other higher quality data like the application icon and long description.

gs_app_to_string ()

gchar *
gs_app_to_string (GsApp *app);

Converts the application to a string. This is not designed to serialize the object but to produce a string suitable for debugging.

gs_app_get_id ()

const gchar *
gs_app_get_id (GsApp *app);

Gets the application ID.

gs_app_set_id ()

void
gs_app_set_id (GsApp *app,
               const gchar *id);

Sets the application ID.

gs_app_get_id_no_prefix ()

const gchar *
gs_app_get_id_no_prefix (GsApp *app);

Gets the application ID without any prefix set.

gs_app_get_kind ()

AsAppKind
gs_app_get_kind (GsApp *app);

Gets the kind of the application.

gs_app_set_kind ()

void
gs_app_set_kind (GsApp *app,
                 AsAppKind kind);

This sets the kind of the application. The following state diagram explains the typical states. All applications start with kind AS_APP_KIND_UNKNOWN.

1
2
3

PACKAGE --> NORMAL
PACKAGE --> SYSTEM
NORMAL  --> SYSTEM

gs_app_get_state ()

AsAppState
gs_app_get_state (GsApp *app);

Gets the state of the application.

gs_app_set_state ()

void
gs_app_set_state (GsApp *app,
                  AsAppState state);

This sets the state of the application. The following state diagram explains the typical states. All applications start in state AS_APP_STATE_UNKNOWN, but the frontend is not supposed to see GsApps with this state.

Plugins are reponsible for changing the state to one of the other states before the GsApp is passed to the frontend.

1
2
3
4
5
6

UPDATABLE --> INSTALLING --> INSTALLED
UPDATABLE --> REMOVING   --> AVAILABLE
INSTALLED --> REMOVING   --> AVAILABLE
AVAILABLE --> INSTALLING --> INSTALLED
AVAILABLE <--> QUEUED --> INSTALLING --> INSTALLED
UNKNOWN   --> UNAVAILABLE

gs_app_set_state_recover ()

void
gs_app_set_state_recover (GsApp *app);

Sets the application state to the last status value that was not transient.

gs_app_get_progress ()

guint
gs_app_get_progress (GsApp *app);

Gets the percentage completion.

gs_app_set_progress ()

void
gs_app_set_progress (GsApp *app,
                     guint percentage);

This sets the progress completion of the application. If called more than once with the same value then subsequent calls will be ignored.

gs_app_get_name ()

const gchar *
gs_app_get_name (GsApp *app);

Gets the application name.

gs_app_set_name ()

void
gs_app_set_name (GsApp *app,
                 GsAppQuality quality,
                 const gchar *name);

Sets the application name.

gs_app_get_source_default ()

const gchar *
gs_app_get_source_default (GsApp *app);

Gets the default source.

gs_app_add_source ()

void
gs_app_add_source (GsApp *app,
                   const gchar *source);

Adds a source name for the application.

gs_app_get_sources ()

GPtrArray *
gs_app_get_sources (GsApp *app);

Gets the list of sources for the application.

gs_app_set_sources ()

void
gs_app_set_sources (GsApp *app,
                    GPtrArray *sources);

This name is used for the update page if the application is collected into the 'OS Updates' group. It is typically the package names, although this should not be relied upon.

gs_app_get_source_id_default ()

const gchar *
gs_app_get_source_id_default (GsApp *app);

Gets the default source ID.

gs_app_add_source_id ()

void
gs_app_add_source_id (GsApp *app,
                      const gchar *source_id);

Adds a source ID to the application.

gs_app_get_source_ids ()

GPtrArray *
gs_app_get_source_ids (GsApp *app);

Gets the list of source IDs.

gs_app_set_source_ids ()

void
gs_app_set_source_ids (GsApp *app,
                       GPtrArray *source_ids);

This ID is used internally to the controlling plugin.

gs_app_clear_source_ids ()

void
gs_app_clear_source_ids (GsApp *app);

Clear the list of source IDs.

gs_app_get_project_group ()

const gchar *
gs_app_get_project_group (GsApp *app);

Gets a project group for the application. Applications belonging to other project groups may not be shown in this software center.

gs_app_set_project_group ()

void
gs_app_set_project_group (GsApp *app,
                          const gchar *project_group);

Sets a project group for the application.

gs_app_get_version ()

const gchar *
gs_app_get_version (GsApp *app);

Gets the exact version for the application.

gs_app_get_version_ui ()

const gchar *
gs_app_get_version_ui (GsApp *app);

Gets a version string that can be displayed in a UI.

gs_app_set_version ()

void
gs_app_set_version (GsApp *app,
                    const gchar *version);

This saves the version after stripping out any non-friendly parts, such as distro tags, git revisions and that kind of thing.

gs_app_get_summary ()

const gchar *
gs_app_get_summary (GsApp *app);

Gets the single-line description of the application.

gs_app_set_summary ()

void
gs_app_set_summary (GsApp *app,
                    GsAppQuality quality,
                    const gchar *summary);

The medium length one-line localized name.

gs_app_get_summary_missing ()

const gchar *
gs_app_get_summary_missing (GsApp *app);

Gets the one-line summary to use when this application is missing.

gs_app_set_summary_missing ()

void
gs_app_set_summary_missing (GsApp *app,
                            const gchar *summary_missing);

Sets the one-line summary to use when this application is missing.

gs_app_get_description ()

const gchar *
gs_app_get_description (GsApp *app);

Gets the long multi-line description of the application.

gs_app_set_description ()

void
gs_app_set_description (GsApp *app,
                        GsAppQuality quality,
                        const gchar *description);

Sets the long multi-line description of the application.

gs_app_get_url ()

const gchar *
gs_app_get_url (GsApp *app,
                AsUrlKind kind);

Gets a web address of a specific type.

gs_app_set_url ()

void
gs_app_set_url (GsApp *app,
                AsUrlKind kind,
                const gchar *url);

Sets a web address of a specific type.

gs_app_get_license ()

const gchar *
gs_app_get_license (GsApp *app);

Gets the project license of the application.

gs_app_get_license_is_free ()

gboolean
gs_app_get_license_is_free (GsApp *app);

Returns if the application is free software.

gs_app_set_license ()

void
gs_app_set_license (GsApp *app,
                    GsAppQuality quality,
                    const gchar *license);

Sets the project licenses used in the application.

gs_app_get_menu_path ()

gchar **
gs_app_get_menu_path (GsApp *app);

Returns the menu path which is an array of path elements. The resulting array is an internal structure and must not be modified or freed.

gs_app_set_menu_path ()

void
gs_app_set_menu_path (GsApp *app,
                      gchar **menu_path);

Sets the new menu path. The menu path is an array of path elements. This function creates a deep copy of the path.

gs_app_get_origin ()

const gchar *
gs_app_get_origin (GsApp *app);

Gets the origin for the application, e.g. "fedora".

gs_app_set_origin ()

void
gs_app_set_origin (GsApp *app,
                   const gchar *origin);

The origin is the original source of the application e.g. "fedora-updates"

gs_app_get_origin_ui ()

const gchar *
gs_app_get_origin_ui (GsApp *app);

Gets the UI-visible origin used to install the application, e.g. "Fedora".

gs_app_set_origin_ui ()

void
gs_app_set_origin_ui (GsApp *app,
                      const gchar *origin_ui);

The origin is the original source of the application to show in the UI, e.g. "Fedora"

gs_app_get_screenshots ()

GPtrArray *
gs_app_get_screenshots (GsApp *app);

Gets the list of screenshots.

gs_app_add_screenshot ()

void
gs_app_add_screenshot (GsApp *app,
                       AsScreenshot *screenshot);

Adds a screenshot to the applicaton.

gs_app_get_update_version ()

const gchar *
gs_app_get_update_version (GsApp *app);

Gets the newest update version.

gs_app_get_update_version_ui ()

const gchar *
gs_app_get_update_version_ui (GsApp *app);

Gets the update version for the UI.

gs_app_set_update_version ()

void
gs_app_set_update_version (GsApp *app,
                           const gchar *update_version);

Sets the new version number of the update.

gs_app_get_update_details ()

const gchar *
gs_app_get_update_details (GsApp *app);

Gets the multi-line description for the update.

gs_app_set_update_details ()

void
gs_app_set_update_details (GsApp *app,
                           const gchar *update_details);

Sets the multi-line description for the update.

gs_app_get_update_urgency ()

AsUrgencyKind
gs_app_get_update_urgency (GsApp *app);

Gets the update urgency.

gs_app_set_update_urgency ()

void
gs_app_set_update_urgency (GsApp *app,
                           AsUrgencyKind update_urgency);

Sets the update urgency.

gs_app_get_management_plugin ()

const gchar *
gs_app_get_management_plugin (GsApp *app);

Gets the management plugin. This is some metadata about the application which is used to work out which plugin should handle the install, remove or upgrade actions.

Typically plugins will just set this to the plugin name using gs_plugin_get_name().

gs_app_set_management_plugin ()

void
gs_app_set_management_plugin (GsApp *app,
                              const gchar *management_plugin);

The management plugin is the plugin that can handle doing install and remove operations on the GsApp. Typical values include "packagekit" and "jhbuild"

gs_app_get_pixbuf ()

GdkPixbuf *
gs_app_get_pixbuf (GsApp *app);

Gets a pixbuf to represent the application.

gs_app_set_pixbuf ()

void
gs_app_set_pixbuf (GsApp *app,
                   GdkPixbuf *pixbuf);

Sets a pixbuf used to represent the application.

gs_app_get_icon ()

AsIcon *
gs_app_get_icon (GsApp *app);

Gets the icon for the application.

gs_app_set_icon ()

void
gs_app_set_icon (GsApp *app,
                 AsIcon *icon);

Sets an icon to use for the application.

gs_app_get_local_file ()

GFile *
gs_app_get_local_file (GsApp *app);

Gets the file that backs this application, for instance this might be a local file in ~/Downloads that we are installing.

gs_app_set_local_file ()

void
gs_app_set_local_file (GsApp *app,
                       GFile *local_file);

Sets the file that backs this application, for instance this might be a local file in ~/Downloads that we are installing.

gs_app_get_runtime ()

GsApp *
gs_app_get_runtime (GsApp *app);

Gets the runtime for the application.

gs_app_set_runtime ()

void
gs_app_set_runtime (GsApp *app,
                    GsApp *runtime);

Sets the runtime that the application requires.

gs_app_get_metadata_item ()

const gchar *
gs_app_get_metadata_item (GsApp *app,
                          const gchar *key);

Gets some metadata for the application. Is is expected that plugins namespace any plugin-specific metadata, for example fwupd::device-id.

gs_app_set_metadata ()

void
gs_app_set_metadata (GsApp *app,
                     const gchar *key,
                     const gchar *value);

Sets some metadata for the application. Is is expected that plugins namespace any plugin-specific metadata, for example fwupd::device-id.

gs_app_get_rating ()

gint
gs_app_get_rating (GsApp *app);

Gets the percentage rating of the application, where 100 is 5 stars.

gs_app_set_rating ()

void
gs_app_set_rating (GsApp *app,
                   gint rating);

Gets the percentage rating of the application.

gs_app_get_review_ratings ()

GArray *
gs_app_get_review_ratings (GsApp *app);

Gets the review ratings.

gs_app_set_review_ratings ()

void
gs_app_set_review_ratings (GsApp *app,
                           GArray *review_ratings);

Sets the review ratings.

gs_app_get_reviews ()

GPtrArray *
gs_app_get_reviews (GsApp *app);

Gets all the user-submitted reviews for the application.

gs_app_add_review ()

void
gs_app_add_review (GsApp *app,
                   GsReview *review);

Adds a user-submitted review to the application.

gs_app_remove_review ()

void
gs_app_remove_review (GsApp *app,
                      GsReview *review);

Removes a user-submitted review to the application.

gs_app_get_size_installed ()

guint64
gs_app_get_size_installed (GsApp *app);

Gets the size on disk, either for an existing application of one that could be installed.

If there is a runtime not yet installed then this is also added.

gs_app_set_size_installed ()

void
gs_app_set_size_installed (GsApp *app,
                           guint64 size_installed);

Sets the installed size of the application.

gs_app_get_size_download ()

guint64
gs_app_get_size_download (GsApp *app);

Gets the size of the total download needed to either install an available application, or update an already installed one.

If there is a runtime not yet installed then this is also added.

gs_app_set_size_download ()

void
gs_app_set_size_download (GsApp *app,
                          guint64 size_download);

Sets the download size of the application, not including any required runtime.

gs_app_get_addons ()

GPtrArray *
gs_app_get_addons (GsApp *app);

Gets the list of addons for the application.

gs_app_add_addon ()

void
gs_app_add_addon (GsApp *app,
                  GsApp *addon);

Adds an addon to the list of application addons.

gs_app_get_related ()

GPtrArray *
gs_app_get_related (GsApp *app);

Gets any related applications.

gs_app_add_related ()

void
gs_app_add_related (GsApp *app,
                    GsApp *app2);

Adds a related application.

gs_app_get_history ()

GPtrArray *
gs_app_get_history (GsApp *app);

Gets the history of this application.

gs_app_add_history ()

void
gs_app_add_history (GsApp *app,
                    GsApp *app2);

Adds a history item for this package.

gs_app_get_install_date ()

guint64
gs_app_get_install_date (GsApp *app);

Gets the date that an application was installed.

gs_app_set_install_date ()

void
gs_app_set_install_date (GsApp *app,
                         guint64 install_date);

Sets the date that an application was installed.

gs_app_get_categories ()

GPtrArray *
gs_app_get_categories (GsApp *app);

Gets the list of categories for an application.

gs_app_set_categories ()

void
gs_app_set_categories (GsApp *app,
                       GPtrArray *categories);

Set the list of categories for an application.

gs_app_get_key_colors ()

GPtrArray *
gs_app_get_key_colors (GsApp *app);

Gets the key colors used in the application icon.

gs_app_set_key_colors ()

void
gs_app_set_key_colors (GsApp *app,
                       GPtrArray *key_colors);

Sets the key colors used in the application icon.

gs_app_add_key_color ()

void
gs_app_add_key_color (GsApp *app,
                      GdkRGBA *key_color);

Adds a key colors used in the application icon.

gs_app_has_category ()

gboolean
gs_app_has_category (GsApp *app,
                     const gchar *category);

Checks if the application is in a specific category.

gs_app_add_category ()

void
gs_app_add_category (GsApp *app,
                     const gchar *category);

Adds a category ID to an application.

gs_app_get_keywords ()

GPtrArray *
gs_app_get_keywords (GsApp *app);

Gets the list of application keywords in the users locale.

gs_app_set_keywords ()

void
gs_app_set_keywords (GsApp *app,
                     GPtrArray *keywords);

Sets the list of application keywords in the users locale.

gs_app_add_kudo ()

void
gs_app_add_kudo (GsApp *app,
                 GsAppKudo kudo);

Adds a kudo to the application.

gs_app_get_kudos ()

guint64
gs_app_get_kudos (GsApp *app);

Gets all the kudos the application has been awarded.

gs_app_get_kudos_percentage ()

guint
gs_app_get_kudos_percentage (GsApp *app);

Gets the kudos, as a percentage value.

gs_app_get_to_be_installed ()

gboolean
gs_app_get_to_be_installed (GsApp *app);

Gets if the application is queued for installation.

This is only set for addons when the user has selected some addons to be installed before installing the main application. Plugins should check all the addons for this property when installing main applications so that the chosen set of addons is also installed at the same time. This is never set when applications do not have addons.

gs_app_set_to_be_installed ()

void
gs_app_set_to_be_installed (GsApp *app,
                            gboolean to_be_installed);

Sets if the application is queued for installation.

gs_app_set_match_value ()

void
gs_app_set_match_value (GsApp *app,
                        guint match_value);

Set a match quality value, where higher values correspond to a "better" search match, and should be shown above lower results.

gs_app_get_match_value ()

guint
gs_app_get_match_value (GsApp *app);

Get a match quality value, where higher values correspond to a "better" search match, and should be shown above lower results.

Note: This value is only valid when processing the result set and may be overwritten on subsequent searches if the plugin is using a cache.

gs_app_has_quirk ()

gboolean
gs_app_has_quirk (GsApp *app,
                  AsAppQuirk quirk);

Finds out if an application has a specific quirk.

gs_app_add_quirk ()

void
gs_app_add_quirk (GsApp *app,
                  AsAppQuirk quirk);

Adds a quirk to an application.

gs_app_remove_quirk ()

void
gs_app_remove_quirk (GsApp *app,
                     AsAppQuirk quirk);

Removes a quirk from an application.

GS_TYPE_APP

#define GS_TYPE_APP (gs_app_get_type ())

enum GsAppKudo

Any awards given to the application.

GS_APP_INSTALL_DATE_UNSET

#define GS_APP_INSTALL_DATE_UNSET		0

GS_APP_INSTALL_DATE_UNKNOWN

#define GS_APP_INSTALL_DATE_UNKNOWN		1 /* 1s past the epoch */

GS_APP_SIZE_UNKNOWABLE

#define GS_APP_SIZE_UNKNOWABLE			G_MAXUINT64

enum GsAppQuality

Any awards given to the application.

GsApp

typedef struct _GsApp GsApp;

The “description” property

  “description”              gchar *

Flags: Read / Write / Construct

Default value: NULL

The “id” property

  “id”                       gchar *

Flags: Read / Write / Construct

Default value: NULL

The “install-date” property

  “install-date”             guint64

Flags: Read / Write / Construct

Default value: 0

The “kind” property

  “kind”                     guint

Flags: Read / Write / Construct

Allowed values: <= 15

Default value: 0

The “name” property

  “name”                     gchar *

Flags: Read / Write / Construct

Default value: NULL

The “progress” property

  “progress”                 guint

Flags: Read / Write / Construct

Allowed values: <= 100

Default value: 0

The “quirk” property

  “quirk”                    guint64

Flags: Read / Write / Construct

Default value: 0

The “rating” property

  “rating”                   gint

Flags: Read / Write / Construct

Allowed values: [-1,100]

Default value: -1

The “state” property

  “state”                    guint

Flags: Read / Write / Construct

Allowed values: <= 10

Default value: 0

The “summary” property

  “summary”                  gchar *

Flags: Read / Write / Construct

Default value: NULL

The “version” property

  “version”                  gchar *

Flags: Read / Write / Construct

Default value: NULL