gs_plugin_alloc_data ()

GsPluginData *
gs_plugin_alloc_data (GsPlugin *plugin,
                      gsize sz);

Allocates a private data area for the plugin which can be retrieved using gs_plugin_get_data(). This is normally called in gs_plugin_initialize() and the data should not be manually freed.

gs_plugin_get_data ()

GsPluginData *
gs_plugin_get_data (GsPlugin *plugin);

Gets the private data for the plugin if gs_plugin_alloc_data() has been called.

gs_plugin_get_name ()

const gchar *
gs_plugin_get_name (GsPlugin *plugin);

Gets the plugin name.

gs_plugin_get_enabled ()

gboolean
gs_plugin_get_enabled (GsPlugin *plugin);

Gets if the plugin is enabled.

gs_plugin_set_enabled ()

void
gs_plugin_set_enabled (GsPlugin *plugin,
                       gboolean enabled);

Enables or disables a plugin. This is normally only called from gs_plugin_initialize().

gs_plugin_has_flags ()

gboolean
gs_plugin_has_flags (GsPlugin *plugin,
                     GsPluginFlags flags);

Finds out if a plugin has a specific flag set.

gs_plugin_get_scale ()

guint
gs_plugin_get_scale (GsPlugin *plugin);

Gets the window scale factor.

gs_plugin_get_locale ()

const gchar *
gs_plugin_get_locale (GsPlugin *plugin);

Gets the user locale.

gs_plugin_get_profile ()

AsProfile *
gs_plugin_get_profile (GsPlugin *plugin);

Gets the profile object to be used for the plugin. This can be used to make plugin actions appear in the global profile output.

gs_plugin_get_soup_session ()

SoupSession *
gs_plugin_get_soup_session (GsPlugin *plugin);

Gets the soup session that plugins can use when downloading.

gs_plugin_add_rule ()

void
gs_plugin_add_rule (GsPlugin *plugin,
                    GsPluginRule rule,
                    const gchar *name);

If the plugin name is found, the rule will be used to sort the plugin list, for example the plugin specified by name will be ordered after this plugin when GS_PLUGIN_RULE_RUN_AFTER is used.

NOTE: The depsolver is iterative and may not solve overly-complicated rules; If depsolving fails then gnome-software will not start.

gs_plugin_download_data ()

GBytes *
gs_plugin_download_data (GsPlugin *plugin,
                         GsApp *app,
                         const gchar *uri,
                         GCancellable *cancellable,
                         GError **error);

Downloads data.

gs_plugin_download_file ()

gboolean
gs_plugin_download_file (GsPlugin *plugin,
                         GsApp *app,
                         const gchar *uri,
                         const gchar *filename,
                         GCancellable *cancellable,
                         GError **error);

Downloads data and saves it to a file.

gs_plugin_check_distro_id ()

gboolean
gs_plugin_check_distro_id (GsPlugin *plugin,
                           const gchar *distro_id);

Checks if the distro is compatible.

gs_plugin_cache_lookup ()

GsApp *
gs_plugin_cache_lookup (GsPlugin *plugin,
                        const gchar *key);

Looks up an application object from the per-plugin cache

gs_plugin_cache_add ()

void
gs_plugin_cache_add (GsPlugin *plugin,
                     const gchar *key,
                     GsApp *app);

Adds an application to the per-plugin cache. This is optional, and the plugin can use the cache however it likes.

gs_plugin_cache_invalidate ()

void
gs_plugin_cache_invalidate (GsPlugin *plugin);

Invalidate the per-plugin cache by marking all entries as invalid. This is optional, and the plugin can evict the cache whenever it likes.

gs_plugin_status_update ()

void
gs_plugin_status_update (GsPlugin *plugin,
                         GsApp *app,
                         GsPluginStatus status);

Update the state of the plugin so any UI can be updated.

gs_plugin_app_launch ()

gboolean
gs_plugin_app_launch (GsPlugin *plugin,
                      GsApp *app,
                      GError **error);

Launches the application using GAppInfo.

gs_plugin_updates_changed ()

void
gs_plugin_updates_changed (GsPlugin *plugin);

Emit a signal that tells the plugin loader that the list of updates may have changed.

gs_plugin_status_to_string ()

const gchar *
gs_plugin_status_to_string (GsPluginStatus status);

Converts the GsPluginStatus enum to a string.

GS_TYPE_PLUGIN

#define GS_TYPE_PLUGIN (gs_plugin_get_type ())

struct GsPluginClass

struct GsPluginClass {
	GObjectClass		 parent_class;
	void			(*updates_changed) (GsPlugin *plugin);
	void			(*status_changed) (GsPlugin *plugin,
							 GsApp		*app,
							 guint		 status);
	gpointer		 padding[29];
};

GsPluginData

typedef struct GsPluginData GsPluginData;

enum GsPluginStatus

The ststus of the plugin.

enum GsPluginFlags

The flags for the plugin at this point in time.

enum GsPluginError

The failure error types.

enum GsPluginRefineFlags

The refine flags.

enum GsPluginRefreshFlags

The flags used for refresh. Regeneration and downloading is only done if the cache is older than the cache_age.

The GS_PLUGIN_REFRESH_FLAGS_METADATA can be used to make sure there's enough metadata to start the application. 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.

enum GsPluginRule

The rules used for ordering plugins. Plugins are expected to add rules in gs_plugin_initialize().

GS_PLUGIN_ERROR

#define GS_PLUGIN_ERROR					1

GsPlugin

typedef struct _GsPlugin GsPlugin;

The “flags” property

  “flags”                    guint64

Flags: Read / Write

Default value: 0

The “status-changed” signal

void
user_function (GsPlugin *gsplugin,
               GsApp    *arg1,
               guint     arg2,
               gpointer  user_data)

Flags: Run Last

The “updates-changed” signal

void
user_function (GsPlugin *gsplugin,
               gpointer  user_data)

Flags: Run Last