Class (GI Class)

AppStream-1.0 ▶ AppStream ▶ Component

Hierarchy (View Summary)

Index

Constructors

constructor

Properties

$signals $gtype

Accessors

categories description icons id keywords kind name pkgnames project_group project_license projectGroup projectLicense screenshots summary urls

Methods

_init add_addon add_agreement add_bundle add_category add_content_rating add_extends add_icon add_keyword add_language add_launchable add_provided add_provided_item add_reference add_relation add_release add_replaces add_review add_screenshot add_suggested add_tag add_translation add_url check_relations clear_keywords clear_languages clear_tags connect connect_after emit get_addons get_agreement_by_kind get_agreements get_branch get_branding get_bundle get_bundles get_categories get_compulsory_for_desktops get_content_rating get_content_ratings get_context get_custom get_custom_value get_data_id get_date_eol get_description get_developer get_extends get_icon_by_size get_icon_stock get_icons get_id get_keywords get_keywords_table get_kind get_language get_languages get_launchable get_launchables get_merge_kind get_metadata_license get_name get_name_table get_name_variant_suffix get_origin get_pkgname get_pkgnames get_priority get_project_group get_project_license get_provided get_provided_for_kind get_recommends get_references get_releases_plain get_replaces get_requires get_reviews get_scope get_screenshots_all get_search_tokens get_sort_score get_source_pkgname get_suggested get_summary get_summary_table get_supports get_system_compatibility_score get_timestamp_eol get_translations get_url has_bundle has_category has_tag insert_custom_value is_compulsory_for_desktop is_floss is_ignored is_member_of_category is_valid load_from_bytes load_releases remove_tag search_matches search_matches_all set_branch set_branding set_compulsory_for_desktop set_context set_context_locale set_data_id set_date_eol set_description set_developer set_id set_keywords set_kind set_merge_kind set_metadata_license set_name set_name_variant_suffix set_origin set_pkgname set_pkgnames set_priority set_project_group set_project_license set_releases set_scope set_sort_score set_source_pkgname set_summary sort_screenshots to_string to_xml_data new

Methods - Inherited from GObject

bind_property bind_property_full block_signal_handler disconnect force_floating freeze_notify get_data get_property get_qdata getv is_floating notify notify_by_pspec ref ref_sink run_dispose set set_data set_property steal_data steal_qdata stop_emission_by_name thaw_notify unblock_signal_handler unref vfunc_constructed vfunc_dispatch_properties_changed vfunc_dispose vfunc_finalize vfunc_get_property vfunc_notify vfunc_set_property watch_closure _classInit compat_control find_property install_properties install_property interface_find_property interface_install_property interface_list_properties list_properties newv override_property

Constructors

Properties

$signals: AppStream.Component.SignalSignatures

Compile-time signal type information.

This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.

$gtype: GType<AppStream.Component>

Accessors

Methods

_init

add_content_rating

  • Add a reference to the extended component

    Parameters

    • cpt_id: string

      The id of a component which is extended by this component

    Returns void

  • Add a new keyword to the keywords list for the given locale. This function does not check for duplicate keywords.

    Parameters

    • keyword: string

      The new keyword to add.

    • Optionallocale: string

      BCP47 locale of the values, or null to use current locale.

    Returns void

  • Adds a language to the component.

    Parameters

    • locale: string

      the BCP47 locale, or null. e.g. "en-GB"

    • percentage: number

      the percentage completion of the translation, 0 for locales with unknown amount of translation

    Returns void

  • Add the component ID of a component that gets replaced by the current component.

    Parameters

    • cid: string

      an AppStream component ID

    Returns void

  • Add a tag to this component.

    Parameters

    • ns: string

      The namespace the tag belongs to

    • tag: string

      The tag name

    Returns boolean

    true if the tag was added.

  • Remove all keywords for the given locale.

    Parameters

    • Optionallocale: string

      BCP47 locale of the values, or null to use current locale.

    Returns void

get_content_rating

get_content_ratings

  • Retrieve value for a custom data entry with the given key.

    Parameters

    • key: string

      Field name.

    Returns string

  • Get a unique identifier for this metadata set. This unique ID is only valid for the current session, as opposed to the AppStream ID which uniquely identifies a software component.

    The format of the unique id usually is: %{scope}/%{origin}/%{distribution_system}/%{appstream_id}

    For example: system/os/package/org.example.FooBar

    Returns string

    the unique session-specific identifier.

  • Gets an icon matching the size constraints. The icons are not filtered by type, and the first icon which matches the size is returned. If you want more control over which icons you use for displaying, use the %as_component_get_icons() function to get a list of all icons.

    Note that this function is not HiDPI aware! It will never return an icon with a scaling factor > 1.

    Parameters

    • width: number

      The icon width in pixels.

    • height: number

      the icon height in pixels.

    Returns AppStream.Icon

    An icon matching the given width/height, or null if not found.

  • Get the unique AppStream identifier for this component. This ID is unique for the described component, but does not uniquely identify the metadata set.

    For a unique ID for this metadata set in the current session, use %as_component_get_data_id()

    Returns string

    the unique AppStream identifier.

  • Gets the translation coverage in percent for a specific locale

    Parameters

    • Optionallocale: string

      the BCP47 locale, or null. e.g. "en-GB"

    Returns number

    a percentage value, -1 if locale was not found

  • Get variant suffix for the component name (only to be displayed if two components have the same name).

    Returns string

    the variant suffix

  • Get the first package name of the list of packages that need to be installed for this component to be present on the system. Since most components consist of only one package, this is safe to use for about 90% of all cases.

    However, to support a component fully, please use %as_component_get_pkgnames() for getting all packages that need to be installed, and use this method only to e.g. get the main package to perform a quick "is it installed?" check.

    Returns string

    String array of package names

  • Get a list of package names which this component consists of. This usually is just one package name.

    Returns string[]

    String array of package names

  • Get a list of component IDs of components that this software replaces entirely.

    Returns string[]

    an array of component-IDs

  • Returns the sorting priority of this component.

    This will only return a valid value if this component was the result of or involved in a search operation which returned sorted results. In most cases you will not need to access this value explicitly, as all results of search operations in AppStream are already sorted from best match to worst.

    The returned value is an arbitrary integer value, valid only for the search terms involved in the search operation that yielded this component as a result.

    Returns number

  • Gets the UNIX timestamp for the date when this component is out of support (end-of-life) and will receive no more updates, not even security fixes.

    Returns number

    UNIX timestamp, or 0 for unset or invalid.

  • Check if component is in the specified category.

    Parameters

    • category: string

      the specified category to check

    Returns boolean

    true if the component is in the specified category.

  • Test if the component is tagged with the selected tag.

    Parameters

    • ns: string

      The namespace the tag belongs to

    • tag: string

      The tag name

    Returns boolean

    true if tag exists.

  • Add a key and value pair to the custom data table.

    Parameters

    • key: string

      Key name.

    • value: string

      A string value.

    Returns boolean

    true if the key did not exist yet.

  • Check if this component is compulsory for the given desktop.

    Parameters

    • desktop: string

      the desktop-id to test for

    Returns boolean

    true if compulsory, false otherwise.

  • Returns true if this component is free and open source software. To determine this status, this function will check if it comes from a vetted free-software-only source or whether its licenses are only free software licenses.

    Returns boolean

    true if this component is free software.

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

    Returns boolean

    TRUE if the component data was validated successfully.

  • Remove a tag from this component

    Parameters

    • ns: string

      The namespace the tag belongs to

    • tag: string

      The tag name

    Returns boolean

    true if the tag was removed.

  • Searches component data for a specific keyword.

    Parameters

    • term: string

      the search term.

    Returns number

    a match scrore, where 0 is no match and 100 is the best match.

  • Searches component data for all the specific keywords.

    Parameters

    • terms: string

      the search terms.

    Returns number

    a match score, where 0 is no match and larger numbers are better matches.

  • Set the branch that the component instance was sourced from.

    Parameters

    • branch: string

      the branch, e.g. "master" or "3-16".

    Returns void

  • Mark this component to be compulsory for the specified desktop environment.

    Parameters

    • desktop: string

      The name of the desktop.

    Returns void

  • Set the active locale on the context assoaiacted with this component, creating a new context for the component if none exists yet.

    Please not that this will flip the locale of all other components and entities that use the same context as well! This function is just a convenience method, and does not replace proper AppStream.Context management.

    Parameters

    • locale: string

      the new locale.

    Returns void

  • Set the session-specific unique metadata identifier for this component. If two components have a different data_id but the same ID, they will be treated as independent sets of metadata describing the same component type.

    Parameters

    • value: string

      the unique session-specific identifier.

    Returns void

  • Sets an end-of-life date for this component.

    Parameters

    • date: string

      the EOL date in ISO8601 format.

    Returns void

  • Set long description for this component.

    Parameters

    • value: string

      The long description

    • Optionallocale: string

      The BCP47 locale for this value, or null to use the current active one.

    Returns void

  • Set keywords for this component, replacing all existing ones for the selected locale.

    Parameters

    • new_keywords: string[]

      Array of keywords

    • locale: string

      BCP47 locale of the values, or null to use current locale.

    • deep_copy: boolean

      Set to true if the keywords array should be copied, false to set by reference.

    Returns void

  • Set the license this metadata is licensed under.

    Parameters

    • value: string

      the metadata license.

    Returns void

  • Set a human-readable name for this component.

    Parameters

    • value: string

      The name

    • Optionallocale: string

      The BCP47 locale for this value, or null to use the current active one.

    Returns void

  • Set a variant suffix for the component name (only to be displayed if components have the same name).

    Parameters

    • value: string

      the developer or developer team name

    • Optionallocale: string

      the BCP47 locale, or null. e.g. "en-GB"

    Returns void

  • Set the package name that provides this component.

    Parameters

    • pkgname: string

      the package name

    Returns void

  • Set a list of package names this component consists of. (This should usually be just one package name)

    Parameters

    • packages: string[]

    Returns void

  • Sets the priority of this component. This method is used internally.

    Parameters

    • priority: number

      the given priority

    Returns void

  • Set a short description for this component.

    Parameters

    • value: string

      The summary

    • Optionallocale: string

      The BCP47 locale for this value, or null to use the current active one.

    Returns void

  • Reorder the screenshots to prioritize a certain environment or style, instead of using the default screenshot order.

    If both "environment" and "style" are null, the previous default order is restored.

    Parameters

    • environment: string

      a GUI environment string, e.g. "plasma" or "gnome"

    • style: string

      and environment style string, e.g. "light" or "dark"

    • prioritize_style: boolean

      if true, order screenshots of the given style earlier than ones of the given environment.

    Returns void

Methods - Inherited from GObject

  • Creates a binding between source_property on source and target_property on target.

    Whenever the source_property is changed the target_property is updated using the same value. For instance:

      g_object_bind_property (action, "active", widget, "sensitive", 0);

    Will result in the "sensitive" property of the widget GObject.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.

    If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well.

    The binding will automatically be removed when either the source or the target instances are finalized. To remove the binding without affecting the source and the target you can just call g_object_unref() on the returned GObject.Binding instance.

    Removing the binding by calling g_object_unref() on it must only be done if the binding, source and target are only used from a single thread and it is clear that both source and target outlive the binding. Especially it is not safe to rely on this if the binding, source or target can be finalized from different threads. Keep another reference to the binding and use g_binding_unbind() instead to be on the safe side.

    A GObject.Object can have multiple bindings.

    Parameters

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • Complete version of g_object_bind_property().

    Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

    If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well. The transform_from function is only used in case of bidirectional bindings, otherwise it will be ignored

    The binding will automatically be removed when either the source or the target instances are finalized. This will release the reference that is being held on the GObject.Binding instance; if you want to hold on to the GObject.Binding instance, you will need to hold a reference to it.

    To remove the binding, call g_binding_unbind().

    A GObject.Object can have multiple bindings.

    The same user_data parameter will be used for both transform_to and transform_from transformation functions; the notify function will be called once, when the binding is removed. If you need different data for each transformation function, please use g_object_bind_property_with_closures() instead.

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target GObject.Object

    • target_property: string

      the property on target to bind

    • flags: GObject.BindingFlags

      flags to pass to GObject.Binding

    • Optionaltransform_to: BindingTransformFunc

      the transformation function from the source to the target, or null to use the default

    • Optionaltransform_from: BindingTransformFunc

      the transformation function from the target to the source, or null to use the default

    • Optionalnotify: DestroyNotify

      a function to call when disposing the binding, to free resources used by the transformation functions, or null if not required

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

    This function is the language bindings friendly version of g_object_bind_property_full(), using GClosures instead of function pointers.

    Parameters

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.

    Parameters

    • id: number

      Handler ID of the handler to be disconnected

    Returns void

  • This function is intended for GObject.Object implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().

    Returns void

  • Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one GObject.Object::notify signal is emitted for each property modified while the object is frozen.

    This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.

    Returns void

  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • key: string

      name of the key for that association

    Returns any

    the data if found, or null if no such data exists.

  • Gets a property of an object.

    The value can be:

    • an empty GObject.Value initialized by G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a GObject.Value initialized with the expected type of the property
    • a GObject.Value initialized with a type to which the expected type of the property can be transformed

    In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.

    Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.

    Parameters

    • property_name: string

      The name of the property to get

    • value: any

      Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type

    Returns any

  • This function gets back user data pointers stored via g_object_set_qdata().

    Parameters

    • quark: number

      A GLib.Quark, naming the user data pointer

    Returns any

    The user data pointer set, or null

  • Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

    Parameters

    • names: string[]

      the names of each property to get

    • values: any[]

      the values of each property to get

    Returns void

  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    Parameters

    • property_name: string

      the name of a property installed on the class of object.

    Returns void

  • Emits a "notify" signal for the property specified by pspec on object.

    This function omits the property name lookup, hence it is faster than g_object_notify().

    One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:

      typedef enum
      {
        PROP_FOO = 1,
        PROP_LAST
      } MyObjectProperty;

      static GParamSpec *properties[PROP_LAST];

      static void
      my_object_class_init (MyObjectClass *klass)
      {
        properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
                                                 0, 100,
                                                 50,
                                                 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
        g_object_class_install_property (gobject_class,
                                         PROP_FOO,
                                         properties[PROP_FOO]);
      }

    and then notify a change on the "foo" property with:

      g_object_notify_by_pspec (self, properties[PROP_FOO]);

    Parameters

    Returns void

  • Increases the reference count of object.

    Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type of object will be propagated to the return type (using the GCC typeof() extension), so any casting the caller needs to do on the return type must be explicit.

    Returns GObject.Object

    the same object

  • Increase the reference count of object, and possibly remove the [floating][floating-ref] reference, if object has a floating reference.

    In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.

    Since GLib 2.56, the type of object will be propagated to the return type under the same conditions as for g_object_ref().

    Returns GObject.Object

    object

  • Releases all references to other objects. This can be used to break reference cycles.

    This function should only be called from object system implementations.

    Returns void

  • Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.

    Parameters

    • properties: { [key: string]: any }

      Object containing the properties to set

    Returns void

  • Each object carries around a table of associations from strings to pointers. This function lets you set an association.

    If the object already had an association with that name, the old association will be destroyed.

    Internally, the key is converted to a GLib.Quark using g_quark_from_string(). This means a copy of key is kept permanently (even after object has been finalized) — so it is recommended to only use a small, bounded set of values for key in your program, to avoid the GLib.Quark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optionaldata: any

      data to associate with that key

    Returns void

  • Sets a property on an object.

    Parameters

    • property_name: string

      The name of the property to set

    • value: any

      The value to set the property to

    Returns void

  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • key: string

      name of the key

    Returns any

    the data if found, or null if no such data exists.

  • This function gets back user data pointers stored via g_object_set_qdata() and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

    void
    object_add_to_user_list (GObject     *object,
                             const gchar *new_string)
    {
      // the quark, naming the object data
      GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
      // retrieve the old string list
      GList *list = g_object_steal_qdata (object, quark_string_list);

      // prepend new string
      list = g_list_prepend (list, g_strdup (new_string));
      // this changed 'list', so we need to set it again
      g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
    }
    static void
    free_string_list (gpointer data)
    {
      GList *node, *list = data;

      for (node = list; node; node = node->next)
        g_free (node->data);
      g_list_free (list);
    }

    Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().

    Parameters

    • quark: number

      A GLib.Quark, naming the user data pointer

    Returns any

    The user data pointer set, or null

  • Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.

    Parameters

    • detailedName: string

      Name of the signal to stop emission of

    Returns void

  • Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

    Duplicate notifications for each property are squashed so that at most one GObject.Object::notify signal is emitted for each property, in the reverse order in which they have been queued.

    It is an error to call this function when the freeze count is zero.

    Returns void

  • Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

    If the pointer to the GObject.Object may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to null rather than retain a dangling pointer to a potentially invalid GObject.Object instance. Use g_clear_object() for this.

    Returns void

  • the constructed function is called by g_object_new() as the final step of the object creation process. At the point of the call, all construction properties have been set on the object. The purpose of this call is to allow for object initialisation steps that can only be performed after construction properties have been set. constructed implementors should chain up to the constructed call of their parent class to allow it to complete its initialisation.

    Returns void

  • the dispose function is supposed to drop all references to other objects, but keep the instance otherwise intact, so that client method invocations still work. It may be run multiple times (due to reference loops). Before returning, dispose should chain up to the dispose method of the parent class.

    Returns void

  • instance finalization function, should finish the finalization of the instance begun in dispose and chain up to the finalize method of the parent class.

    Returns void

  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    Parameters

    Returns void

  • the generic setter for all properties of this type. Should be overridden for every type with properties. If implementations of set_property don't emit property change notification explicitly, this will be done implicitly by the type system. However, if the notify signal is emitted explicitly, the type system will not emit it a second time.

    Parameters

    Returns void

  • This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_unref() are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

    Parameters

    Returns void

Static_classInit

  • Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created GObject.ParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.

    This function is meant to be called from the interface's default vtable initialization function (the class_init member of GObject.TypeInfo.) It must not be called after after class_init has been called for any object types implementing this interface.

    If pspec is a floating reference, it will be consumed.

    Parameters

    Returns void

  • Parameters

    • property_id: number

      the new property ID

    • name: string

      the name of a property registered in a parent class or in an interface of this class.

    Returns void

Interfaces

ConstructorProps
SignalSignatures