gs_plugin_initialize ()

void
gs_plugin_initialize (GsPlugin *plugin);

Checks if the plugin should run, and if initializes it. If the plugin should not be run then gs_plugin_set_enabled() should be called. This is also the place to call gs_plugin_alloc_data() if private data is required for the plugin.

NOTE: Do not do any failable actions in this function; use gs_plugin_setup() instead.

gs_plugin_destroy ()

void
gs_plugin_destroy (GsPlugin *plugin);

Called when the plugin should destroy any private data.

gs_plugin_adopt_app ()

void
gs_plugin_adopt_app (GsPlugin *plugin,
                     GsApp *app);

Called when an GsApp has not been claimed (i.e. a management plugin has not been set).

A claimed application means other plugins will not try to perform actions such as install, remove or update. Most applications are claimed when they are created.

If a plugin can adopt this application then it should call gs_app_set_management_plugin() on app .

gs_plugin_add_search ()

gboolean
gs_plugin_add_search (GsPlugin *plugin,
                      gchar **values,
                      GsAppList *list,
                      GCancellable *cancellable,
                      GError **error);

Get search results for a specific query.

Plugins are expected to add new apps using gs_app_list_add().

gs_plugin_add_search_files ()

gboolean
gs_plugin_add_search_files (GsPlugin *plugin,
                            gchar **values,
                            GsAppList *list,
                            GCancellable *cancellable,
                            GError **error);

Called when searching for an application that provides a specific filename on the filesystem.

Plugins are expected to add new apps using gs_app_list_add().

gs_plugin_add_search_what_provides ()

gboolean
gs_plugin_add_search_what_provides (GsPlugin *plugin,
                                    gchar **values,
                                    GsAppList *list,
                                    GCancellable *cancellable,
                                    GError **error);

Called when searching for an application that provides specific defined tags, for instance a codec string or mime-type.

Plugins are expected to add new apps using gs_app_list_add().

gs_plugin_setup ()

gboolean
gs_plugin_setup (GsPlugin *plugin,
                 GCancellable *cancellable,
                 GError **error);

Called when the plugin should set up the initial state, and with the write lock held.

All functions can block, but should sent progress notifications, e.g. using gs_app_set_progress() if they will take more than tens of milliseconds to complete.

This function will also not be called if gs_plugin_initialize() self-disabled.

gs_plugin_add_installed ()

gboolean
gs_plugin_add_installed (GsPlugin *plugin,
                         GsAppList *list,
                         GCancellable *cancellable,
                         GError **error);

Get the list of installed applications.

Plugins are expected to add new apps using gs_app_list_add().

gs_plugin_add_updates ()

gboolean
gs_plugin_add_updates (GsPlugin *plugin,
                       GsAppList *list,
                       GCancellable *cancellable,
                       GError **error);

Get the list of pre-downloaded, pre-checked updates, with the write lock held.

NOTE: Actually downloading the updates is normally done in gs_plugin_refresh() when called with GS_PLUGIN_REFRESH_FLAGS_PAYLOAD.

Plugins are expected to add new apps using gs_app_list_add().

gs_plugin_add_updates_pending ()

gboolean
gs_plugin_add_updates_pending (GsPlugin *plugin,
                               GsAppList *list,
                               GCancellable *cancellable,
                               GError **error);

Get the list of not-yet-downloaded updates, with the write lock held.

NOTE: Actually downloading the updates is normally done in gs_plugin_refresh() when called with GS_PLUGIN_REFRESH_FLAGS_PAYLOAD.

Plugins are expected to add new apps using gs_app_list_add().

gs_plugin_add_distro_upgrades ()

gboolean
gs_plugin_add_distro_upgrades (GsPlugin *plugin,
                               GsAppList *list,
                               GCancellable *cancellable,
                               GError **error);

Get the list of distribution upgrades. Due to the download size, these should not be downloaded until the user has explicitly opted-in.

Plugins are expected to add new apps using gs_app_list_add() of type AS_APP_KIND_OS_UPGRADE.

gs_plugin_add_sources ()

gboolean
gs_plugin_add_sources (GsPlugin *plugin,
                       GsAppList *list,
                       GCancellable *cancellable,
                       GError **error);

Get the list of sources, for example the repos listed in /etc/yum.repos.d or the remotes configured in flatpak.

Plugins are expected to add new apps using gs_app_list_add() of type AS_APP_KIND_SOURCE.

gs_plugin_add_updates_historical ()

gboolean
gs_plugin_add_updates_historical (GsPlugin *plugin,
                                  GsAppList *list,
                                  GCancellable *cancellable,
                                  GError **error);

Get the list of historical updates, i.e. the updates that have just been installed.

Plugins are expected to add new apps using gs_app_list_add().

gs_plugin_add_categories ()

gboolean
gs_plugin_add_categories (GsPlugin *plugin,
                          GPtrArray *list,
                          GCancellable *cancellable,
                          GError **error);

Get the category tree, for instance Games->Action or Internet->Email.

Plugins are expected to add new categories using g_ptr_array_add().

gs_plugin_add_category_apps ()

gboolean
gs_plugin_add_category_apps (GsPlugin *plugin,
                             GsCategory *category,
                             GsAppList *list,
                             GCancellable *cancellable,
                             GError **error);

Get all the applications that match a specific category.

Plugins are expected to add new apps using gs_app_list_add().

gs_plugin_add_popular ()

gboolean
gs_plugin_add_popular (GsPlugin *plugin,
                       GsAppList *list,
                       GCancellable *cancellable,
                       GError **error);

Get popular applications that should be featured on the main page as "Editors Picks". This is expected to be a curated list of applications that are high quality and feature-complete.

The returned list of popular applications are not sorted, but each GsApp has to be valid, for instance having a known state and a valid icon. If an insufficient number of applications are added by plugins then the section on the overview shell may be hidden.

Plugins are expected to add new apps using gs_app_list_add().

gs_plugin_add_featured ()

gboolean
gs_plugin_add_featured (GsPlugin *plugin,
                        GsAppList *list,
                        GCancellable *cancellable,
                        GError **error);

Get applications that should be featured as a large full-width banner on the overview page. This is expected to be a curated list of applications that are high quality and feature-complete.

The returned list of popular applications are randomized in a way so that the same application is featured for the entire calendar day.

NOTE: The UI code may expect that applications have additional metadata set on results, for instance GnomeSoftware::FeatureTile-css.

Plugins are expected to add new apps using gs_app_list_add().

gs_plugin_add_unvoted_reviews ()

gboolean
gs_plugin_add_unvoted_reviews (GsPlugin *plugin,
                               GsAppList *list,
                               GCancellable *cancellable,
                               GError **error);

Gets the list of unvoted reviews. Only applications should be returned where there are reviews, and where the user has not previously moderated them. This function is supposed to be used to display a moderation panel for reviewers.

Plugins are expected to add new apps using gs_app_list_add().

gs_plugin_refine ()

gboolean
gs_plugin_refine (GsPlugin *plugin,
                  GsAppList *list,
                  GsPluginRefineFlags flags,
                  GCancellable *cancellable,
                  GError **error);

Adds required information to a list of GsApp's. This function is only really required when "batching up" requests, and most plugins are better using the per-app gs_plugin_refine_app() function.

An example for when this is useful would be in the PackageKit plugin where we want to do one transaction of GetDetails with multiple source-ids rather than scheduling a large number of pending requests.

gs_plugin_refine_app ()

gboolean
gs_plugin_refine_app (GsPlugin *plugin,
                      GsApp *app,
                      GsPluginRefineFlags flags,
                      GCancellable *cancellable,
                      GError **error);

Adds required information to app .

The general idea for flags is that this indicates what the UI needs at the moment. This doesn't mean you can't add more information if you have it, for example, if we requested GS_PLUGIN_REFINE_FLAGS_REQUIRE_LICENSE and had to do some IO to get a blob of data, we can use gs_app_set_license() *and* gs_app_set_origin() even though only the first thing was specified.

If the plugin can't handle applications of the specific kind, or if the plugin knows not of the GsApp ID then it should just ignore the request and return FALSE.

gs_plugin_refine_wildcard ()

gboolean
gs_plugin_refine_wildcard (GsPlugin *plugin,
                           GsApp *app,
                           GsAppList *list,
                           GsPluginRefineFlags flags,
                           GCancellable *cancellable,
                           GError **error);

Adds applications that match the wildcard specified in app .

The general idea is that plugins create and add *new* applications rather than all trying to fight over the wildcard application. This allows the plugin loader to filter using the GsApp priority value.

gs_plugin_launch ()

gboolean
gs_plugin_launch (GsPlugin *plugin,
                  GsApp *app,
                  GCancellable *cancellable,
                  GError **error);

Launch the specified application using a plugin-specific method. This is normally setting some environment or launching a specific binary.

Plugins can simply use gs_plugin_app_launch() if no plugin-specific functionality is required.

gs_plugin_add_shortcut ()

gboolean
gs_plugin_add_shortcut (GsPlugin *plugin,
                        GsApp *app,
                        GCancellable *cancellable,
                        GError **error);

Adds a shortcut for the application in a desktop-defined location.

gs_plugin_remove_shortcut ()

gboolean
gs_plugin_remove_shortcut (GsPlugin *plugin,
                           GsApp *app,
                           GCancellable *cancellable,
                           GError **error);

Removes a shortcut for the application in a desktop-defined location.

gs_plugin_update_cancel ()

gboolean
gs_plugin_update_cancel (GsPlugin *plugin,
                         GsApp *app,
                         GCancellable *cancellable,
                         GError **error);

Cancels the offline update of app .

gs_plugin_app_install ()

gboolean
gs_plugin_app_install (GsPlugin *plugin,
                       GsApp *app,
                       GCancellable *cancellable,
                       GError **error);

Install the application.

Plugins are expected to send progress notifications to the UI using gs_app_set_progress() using the passed in app .

All functions can block, but should sent progress notifications, e.g. using gs_app_set_progress() if they will take more than tens of milliseconds to complete.

On failure the error message returned will usually only be shown on the console, but they can also be retrieved using gs_plugin_loader_get_events().

NOTE: Once the action is complete, the plugin must set the new state of app to AS_APP_STATE_INSTALLED.

gs_plugin_app_remove ()

gboolean
gs_plugin_app_remove (GsPlugin *plugin,
                      GsApp *app,
                      GCancellable *cancellable,
                      GError **error);

Remove the application.

Plugins are expected to send progress notifications to the UI using gs_app_set_progress() using the passed in app .

All functions can block, but should sent progress notifications, e.g. using gs_app_set_progress() if they will take more than tens of milliseconds to complete.

On failure the error message returned will usually only be shown on the console, but they can also be retrieved using gs_plugin_loader_get_events().

NOTE: Once the action is complete, the plugin must set the new state of app to AS_APP_STATE_AVAILABLE or AS_APP_STATE_UNKNOWN if not known.

gs_plugin_app_set_rating ()

gboolean
gs_plugin_app_set_rating (GsPlugin *plugin,
                          GsApp *app,
                          GCancellable *cancellable,
                          GError **error);

Gets any ratings for the applications.

Plugins are expected to call gs_app_set_rating() on app .

gs_plugin_update_app ()

gboolean
gs_plugin_update_app (GsPlugin *plugin,
                      GsApp *app,
                      GCancellable *cancellable,
                      GError **error);

Update the application live.

Plugins are expected to send progress notifications to the UI using gs_app_set_progress() using the passed in app .

All functions can block, but should sent progress notifications, e.g. using gs_app_set_progress() if they will take more than tens of milliseconds to complete.

On failure the error message returned will usually only be shown on the console, but they can also be retrieved using gs_plugin_loader_get_events().

NOTE: Once the action is complete, the plugin must set the new state of app to AS_APP_STATE_INSTALLED or AS_APP_STATE_UNKNOWN if not known.

If AS_APP_QUIRK_IS_PROXY is set on the application then the actual GsApp set in app will be the related application of the parent. Plugins do not need to manually iterate on the related list of applications.

gs_plugin_app_upgrade_download ()

gboolean
gs_plugin_app_upgrade_download (GsPlugin *plugin,
                                GsApp *app,
                                GCancellable *cancellable,
                                GError **error);

Starts downloading a distribution upgrade in the background.

All functions can block, but should sent progress notifications, e.g. using gs_app_set_progress() if they will take more than tens of milliseconds to complete.

gs_plugin_app_upgrade_trigger ()

gboolean
gs_plugin_app_upgrade_trigger (GsPlugin *plugin,
                               GsApp *app,
                               GCancellable *cancellable,
                               GError **error);

Triggers the distribution upgrade to be installed on next boot.

gs_plugin_review_submit ()

gboolean
gs_plugin_review_submit (GsPlugin *plugin,
                         GsApp *app,
                         AsReview *review,
                         GCancellable *cancellable,
                         GError **error);

Submits a new end-user application review.

gs_plugin_review_upvote ()

gboolean
gs_plugin_review_upvote (GsPlugin *plugin,
                         GsApp *app,
                         AsReview *review,
                         GCancellable *cancellable,
                         GError **error);

Upvote a specific review to indicate the review is helpful.

gs_plugin_review_downvote ()

gboolean
gs_plugin_review_downvote (GsPlugin *plugin,
                           GsApp *app,
                           AsReview *review,
                           GCancellable *cancellable,
                           GError **error);

Downvote a specific review to indicate the review is unhelpful.

Plugins are expected to add new apps using gs_app_list_add().

gs_plugin_review_report ()

gboolean
gs_plugin_review_report (GsPlugin *plugin,
                         GsApp *app,
                         AsReview *review,
                         GCancellable *cancellable,
                         GError **error);

Report a review that is not suitable in some way. It is expected that this action flags a review to be checked by a moderator and that the review won't be shown to any users until this happens.

gs_plugin_review_remove ()

gboolean
gs_plugin_review_remove (GsPlugin *plugin,
                         GsApp *app,
                         AsReview *review,
                         GCancellable *cancellable,
                         GError **error);

Remove a review that the user wrote. NOTE: Users should only be able to remove reviews with AS_REVIEW_FLAG_SELF.

gs_plugin_review_dismiss ()

gboolean
gs_plugin_review_dismiss (GsPlugin *plugin,
                          GsApp *app,
                          AsReview *review,
                          GCancellable *cancellable,
                          GError **error);

Dismisses a review, i.e. hide it from future moderated views. This action is useful when the moderator is unable to speak the language of the review for example.

gs_plugin_refresh ()

gboolean
gs_plugin_refresh (GsPlugin *plugin,
                   guint cache_age,
                   GsPluginRefreshFlags flags,
                   GCancellable *cancellable,
                   GError **error);

Refreshes the state of all the plugins.

The GS_PLUGIN_REFRESH_FLAGS_METADATA flag can be used to make sure there's enough metadata to start the application, for example lists of available applications.

The GS_PLUGIN_REFRESH_FLAGS_PAYLOAD flag should only be used when the session is idle and bandwidth is unmetered as the amount of data and IO may be large. This is used to pre-download package updates and firmware.

All functions can block, but should sent progress notifications, e.g. using gs_app_set_progress() if they will take more than tens of milliseconds to complete.

gs_plugin_file_to_app ()

gboolean
gs_plugin_file_to_app (GsPlugin *plugin,
                       GsAppList *list,
                       GFile *file,
                       GCancellable *cancellable,
                       GError **error);

Converts a local file to a GsApp. It's expected that only one plugin will match the mimetype of file and that a single GsApp will be in the returned list. If no plugins can handle the file, the list will be empty.

For example, the PackageKit plugin can turn a .rpm file into a application of kind AS_APP_KIND_UNKNOWN but that in some cases it will be futher refined into a AS_APP_KIND_DESKTOP (with all the extra metadata) by the appstream plugin.

Plugins are expected to add new apps using gs_app_list_add().

gs_plugin_url_to_app ()

gboolean
gs_plugin_url_to_app (GsPlugin *plugin,
                      GsAppList *list,
                      const gchar *url,
                      GCancellable *cancellable,
                      GError **error);

Converts a URL to a GsApp. It's expected that only one plugin will match the scheme of url and that a single GsApp will be in the returned list. If no plugins can handle the file, the list will be empty.

For example, the apt plugin can turn apt://gimp into a application.

Plugins are expected to add new apps using gs_app_list_add().

gs_plugin_update ()

gboolean
gs_plugin_update (GsPlugin *plugin,
                  GsAppList *apps,
                  GCancellable *cancellable,
                  GError **error);

Updates a list of applications, typically scheduling them for offline update.

gs_plugin_auth_login ()

gboolean
gs_plugin_auth_login (GsPlugin *plugin,
                      GsAuth *auth,
                      GCancellable *cancellable,
                      GError **error);

Performs a login using the given authentication details.

gs_plugin_auth_logout ()

gboolean
gs_plugin_auth_logout (GsPlugin *plugin,
                       GsAuth *auth,
                       GCancellable *cancellable,
                       GError **error);

Performs a logout using the given authentication details.

gs_plugin_auth_lost_password ()

gboolean
gs_plugin_auth_lost_password (GsPlugin *plugin,
                              GsAuth *auth,
                              GCancellable *cancellable,
                              GError **error);

Performs the lost password action using the given authentication details.

gs_plugin_auth_register ()

gboolean
gs_plugin_auth_register (GsPlugin *plugin,
                         GsAuth *auth,
                         GCancellable *cancellable,
                         GError **error);

Performs the registration action using the given authentication details.