AsComponent

AsComponent — Object representing a software component

Functions

const gchar * as_component_kind_to_string ()
AsComponentKind as_component_kind_from_string ()
AsComponent * as_component_new ()
AsComponent * as_component_construct ()
gboolean as_component_is_valid ()
gchar * as_component_to_string ()
gboolean as_component_provides_item ()
AsComponentKind as_component_get_kind ()
const gchar * as_component_get_pkgname ()
const gchar * as_component_get_idname ()
const gchar * as_component_get_name ()
const gchar * as_component_get_name_original ()
const gchar * as_component_get_project_license ()
const gchar * as_component_get_project_group ()
gchar ** as_component_get_compulsory_for_desktops ()
const gchar * as_component_get_summary ()
gchar ** as_component_get_categories ()
GPtrArray * as_component_get_screenshots ()
const gchar * as_component_get_description ()
gchar ** as_component_get_keywords ()
const gchar * as_component_get_icon ()
const gchar * as_component_get_icon_url ()
const gchar * as_component_get_homepage ()
gchar ** as_component_get_mimetypes ()
GPtrArray * as_component_get_provided_items ()
GPtrArray * as_component_get_releases ()
void as_component_add_screenshot ()
void as_component_add_release ()
void as_component_set_categories_from_str ()
void as_component_set_kind ()
void as_component_set_name ()
void as_component_set_keywords ()
void as_component_set_mimetypes ()
void as_component_set_compulsory_for_desktops ()
void as_component_set_pkgname ()
void as_component_set_idname ()
void as_component_set_name_original ()
void as_component_set_summary ()
void as_component_set_description ()
void as_component_set_homepage ()
void as_component_set_icon ()
void as_component_set_icon_url ()
void as_component_set_project_license ()
void as_component_set_project_group ()
void as_component_set_categories ()

Properties

GStrv categories Read / Write
gchar * description Read / Write
gchar * homepage Read / Write
gchar * icon Read / Write
gchar * icon-url Read / Write
gchar * idname Read / Write
GStrv keywords Read / Write
AsComponentKind kind Read / Write
GStrv mimetypes Read / Write
gchar * name Read / Write
gchar * name-original Read / Write
gchar * pkgname Read / Write
gchar * project-license Read / Write
GPtrArray * screenshots Read
gchar * summary Read / Write

Object Hierarchy

    GEnum
    ╰── AsComponentKind
    GObject
    ╰── AsComponent

Includes

#include <appstream.h>

Description

This object represents an Appstream software component which is associated to a package in the distribution's repositories. A component can be anything, ranging from an application to a font, a codec or even a non-visual software project providing libraries and python-modules for other applications to use.

The type of the component is stored as AsComponentKind and can be queried to find out which kind of component we're dealing with.

See also: AsProvidesKind, AsDatabase

Functions

as_component_kind_to_string ()

const gchar *
as_component_kind_to_string (AsComponentKind kind);

Converts the enumerated value to an text representation.

Parameters

kind

the AsComponentKind.

 

Returns

string version of kind


as_component_kind_from_string ()

AsComponentKind
as_component_kind_from_string (const gchar *kind_str);

Converts the text representation to an enumerated value.

Parameters

kind_str

the string.

 

Returns

a AsComponentKind or AS_COMPONENT_KIND_UNKNOWN for unknown


as_component_new ()

AsComponent *
as_component_new (void);

Creates a new AsComponent.

Returns

a new AsComponent.

[transfer full]


as_component_construct ()

AsComponent *
as_component_construct (GType object_type);

Construct an AsComponent.

Returns

a new AsComponent.

[transfer full]


as_component_is_valid ()

gboolean
as_component_is_valid (AsComponent *self);

Check if the essential properties of this Component are populated with useful data.

Returns

TRUE if the component data was validated successfully.


as_component_to_string ()

gchar *
as_component_to_string (AsComponent *self);

Returns a string identifying this component. (useful for debugging)

Returns

A descriptive string.

[transfer full]


as_component_provides_item ()

gboolean
as_component_provides_item (AsComponent *self,
                            AsProvidesKind kind,
                            const gchar *value);

Checks if this component provides an item of the specified type

self a valid AsComponent kind the kind of the provides-item value the value of the provides-item

Returns

TRUE if an item was found


as_component_get_kind ()

AsComponentKind
as_component_get_kind (AsComponent *self);

Returns

the AsComponentKind of this component.


as_component_get_pkgname ()

const gchar *
as_component_get_pkgname (AsComponent *self);

Returns


as_component_get_idname ()

const gchar *
as_component_get_idname (AsComponent *self);

Returns


as_component_get_name ()

const gchar *
as_component_get_name (AsComponent *self);

Returns


as_component_get_name_original ()

const gchar *
as_component_get_name_original (AsComponent *self);

Returns


as_component_get_project_license ()

const gchar *
as_component_get_project_license (AsComponent *self);

Get the license of the project this component belongs to.

Returns


as_component_get_project_group ()

const gchar *
as_component_get_project_group (AsComponent *self);

Get the component's project group.

Returns


as_component_get_compulsory_for_desktops ()

gchar **
as_component_get_compulsory_for_desktops
                               (AsComponent *self);

Returns

A list of desktops where this component is compulsory.

[transfer none]


as_component_get_summary ()

const gchar *
as_component_get_summary (AsComponent *self);

Returns


as_component_get_categories ()

gchar **
as_component_get_categories (AsComponent *self);

Returns

String array of component names.

[transfer full]


as_component_get_screenshots ()

GPtrArray *
as_component_get_screenshots (AsComponent *self);

Get a list of associated screenshots.

Returns

an array of AsScreenshot instances.

[element-type AsScreenshot][transfer none]


as_component_get_description ()

const gchar *
as_component_get_description (AsComponent *self);

Returns


as_component_get_keywords ()

gchar **
as_component_get_keywords (AsComponent *self);

Returns

String array of keywords.

[transfer full]


as_component_get_icon ()

const gchar *
as_component_get_icon (AsComponent *self);

Returns


as_component_get_icon_url ()

const gchar *
as_component_get_icon_url (AsComponent *self);

Returns


as_component_get_homepage ()

const gchar *
as_component_get_homepage (AsComponent *self);

Returns


as_component_get_mimetypes ()

gchar **
as_component_get_mimetypes (AsComponent *self);

Returns

String array of mimetype identifiers.

[transfer full]


as_component_get_provided_items ()

GPtrArray *
as_component_get_provided_items (AsComponent *self);

Get an array of the provides-items this component is associated with.

Returns

A list of desktops where this component is compulsory.

[element-type utf8][transfer none]


as_component_get_releases ()

GPtrArray *
as_component_get_releases (AsComponent *self);

Get an array of the AsRelease items this component provides.

Returns

A list of releases.

[element-type AsRelease][transfer none]


as_component_add_screenshot ()

void
as_component_add_screenshot (AsComponent *self,
                             AsScreenshot *sshot);

Add an AsScreenshot to this component.

Parameters

self

a AsComponent instance.

 

sshot

The AsScreenshot to add

 

as_component_add_release ()

void
as_component_add_release (AsComponent *self,
                          AsRelease *release);

Add an AsRelease to this component.

Parameters

self

a AsComponent instance.

 

release

The AsRelease to add

 

as_component_set_categories_from_str ()

void
as_component_set_categories_from_str (AsComponent *self,
                                      const gchar *categories_str);

Set the categories list from a string

self a valid AsComponent instance categories_str Comma-separated list of category-names


as_component_set_kind ()

void
as_component_set_kind (AsComponent *self,
                       AsComponentKind value);

Sets the AsComponentKind of this component.


as_component_set_name ()

void
as_component_set_name (AsComponent *self,
                       const gchar *value);


as_component_set_keywords ()

void
as_component_set_keywords (AsComponent *self,
                           gchar **value);


as_component_set_mimetypes ()

void
as_component_set_mimetypes (AsComponent *self,
                            gchar **value);


as_component_set_compulsory_for_desktops ()

void
as_component_set_compulsory_for_desktops
                               (AsComponent *self,
                                gchar **value);

Set a list of desktops where this component is compulsory.


as_component_set_pkgname ()

void
as_component_set_pkgname (AsComponent *self,
                          const gchar *value);


as_component_set_idname ()

void
as_component_set_idname (AsComponent *self,
                         const gchar *value);


as_component_set_name_original ()

void
as_component_set_name_original (AsComponent *self,
                                const gchar *value);


as_component_set_summary ()

void
as_component_set_summary (AsComponent *self,
                          const gchar *value);


as_component_set_description ()

void
as_component_set_description (AsComponent *self,
                              const gchar *value);


as_component_set_homepage ()

void
as_component_set_homepage (AsComponent *self,
                           const gchar *value);


as_component_set_icon ()

void
as_component_set_icon (AsComponent *self,
                       const gchar *value);


as_component_set_icon_url ()

void
as_component_set_icon_url (AsComponent *self,
                           const gchar *value);


as_component_set_project_license ()

void
as_component_set_project_license (AsComponent *self,
                                  const gchar *value);

Set the project license.


as_component_set_project_group ()

void
as_component_set_project_group (AsComponent *self,
                                const gchar *value);

Set the component's project group.


as_component_set_categories ()

void
as_component_set_categories (AsComponent *self,
                             gchar **value);

Types and Values

Property Details

The “categories” property

  “categories”               GStrv

categories.

Flags: Read / Write


The “description” property

  “description”              gchar *

description.

Flags: Read / Write

Default value: NULL


The “homepage” property

  “homepage”                 gchar *

homepage.

Flags: Read / Write

Default value: NULL


The “icon” property

  “icon”                     gchar *

icon.

Flags: Read / Write

Default value: NULL


The “icon-url” property

  “icon-url”                 gchar *

icon-url.

Flags: Read / Write

Default value: NULL


The “idname” property

  “idname”                   gchar *

idname.

Flags: Read / Write

Default value: NULL


The “keywords” property

  “keywords”                 GStrv

keywords.

Flags: Read / Write


The “kind” property

  “kind”                     AsComponentKind

kind.

Flags: Read / Write

Default value: AS_COMPONENT_KIND_UNKNOWN


The “mimetypes” property

  “mimetypes”                GStrv

mimetypes.

Flags: Read / Write


The “name” property

  “name”                     gchar *

name.

Flags: Read / Write

Default value: NULL


The “name-original” property

  “name-original”            gchar *

name-original.

Flags: Read / Write

Default value: NULL


The “pkgname” property

  “pkgname”                  gchar *

pkgname.

Flags: Read / Write

Default value: NULL


The “project-license” property

  “project-license”          gchar *

project-license.

Flags: Read / Write

Default value: NULL


The “screenshots” property

  “screenshots”              GPtrArray *

screenshots.

Flags: Read


The “summary” property

  “summary”                  gchar *

summary.

Flags: Read / Write

Default value: NULL