<?xml version="1.0"?>
<!-- This file was automatically generated from C sources - DO NOT EDIT!
To affect the contents of this file, edit the original C definitions,
and/or use gtk-doc annotations. -->
<repository version="1.2"
xmlns="http://www.gtk.org/introspection/core/1.0"
xmlns:c="http://www.gtk.org/introspection/c/1.0"
xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
<include name="GObject" version="2.0"/>
<include name="Gio" version="2.0"/>
<package name="appstream"/>
<c:include name="appstream.h"/>
<namespace name="AppStream"
version="1.0"
shared-library="libappstream.so.5"
c:identifier-prefixes="As"
c:symbol-prefixes="as">
<class name="Agreement"
c:symbol-prefix="agreement"
c:type="AsAgreement"
parent="GObject.Object"
glib:type-name="AsAgreement"
glib:get-type="as_agreement_get_type"
glib:type-struct="AgreementClass">
<source-position filename="src/as-agreement.h" line="49"/>
<constructor name="new" c:identifier="as_agreement_new" version="0.12.1">
<doc xml:space="preserve"
filename="src/as-agreement.c"
line="435">Creates a new #AsAgreement.</doc>
<source-position filename="src/as-agreement.h" line="69"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-agreement.c"
line="440">a #AsAgreement</doc>
<type name="Agreement" c:type="AsAgreement*"/>
</return-value>
</constructor>
<method name="add_section" c:identifier="as_agreement_add_section">
<source-position filename="src/as-agreement.h" line="82"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="agreement" transfer-ownership="none">
<type name="Agreement" c:type="AsAgreement*"/>
</instance-parameter>
<parameter name="agreement_section" transfer-ownership="none">
<type name="AgreementSection" c:type="AsAgreementSection*"/>
</parameter>
</parameters>
</method>
<method name="get_kind"
c:identifier="as_agreement_get_kind"
version="0.12.1">
<doc xml:space="preserve"
filename="src/as-agreement.c"
line="126">Gets the agreement kind.</doc>
<source-position filename="src/as-agreement.h" line="74"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-agreement.c"
line="132">a string, e.g. %AS_AGREEMENT_KIND_EULA</doc>
<type name="AgreementKind" c:type="AsAgreementKind"/>
</return-value>
<parameters>
<instance-parameter name="agreement" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-agreement.c"
line="128">a #AsAgreement instance.</doc>
<type name="Agreement" c:type="AsAgreement*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_section_default"
c:identifier="as_agreement_get_section_default"
version="0.12.1">
<doc xml:space="preserve"
filename="src/as-agreement.c"
line="209">Gets the first section in the agreement.</doc>
<source-position filename="src/as-agreement.h" line="80"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="src/as-agreement.c"
line="215">agreement section, or %NULL</doc>
<type name="AgreementSection" c:type="AsAgreementSection*"/>
</return-value>
<parameters>
<instance-parameter name="agreement" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-agreement.c"
line="211">a #AsAgreement instance.</doc>
<type name="Agreement" c:type="AsAgreement*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_sections"
c:identifier="as_agreement_get_sections"
version="0.12.1">
<doc xml:space="preserve"
filename="src/as-agreement.c"
line="192">Gets all the sections in the agreement.</doc>
<source-position filename="src/as-agreement.h" line="81"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-agreement.c"
line="198">array</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="AgreementSection"/>
</array>
</return-value>
<parameters>
<instance-parameter name="agreement" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-agreement.c"
line="194">a #AsAgreement instance.</doc>
<type name="Agreement" c:type="AsAgreement*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_version_id"
c:identifier="as_agreement_get_version_id"
version="0.12.1">
<doc xml:space="preserve"
filename="src/as-agreement.c"
line="159">Gets the agreement version_id.</doc>
<source-position filename="src/as-agreement.h" line="77"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-agreement.c"
line="165">a string, e.g. "1.4a", or NULL</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="agreement" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-agreement.c"
line="161">a #AsAgreement instance.</doc>
<type name="Agreement" c:type="AsAgreement*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_kind"
c:identifier="as_agreement_set_kind"
version="0.12.1">
<doc xml:space="preserve"
filename="src/as-agreement.c"
line="143">Sets the agreement kind.</doc>
<source-position filename="src/as-agreement.h" line="75"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="agreement" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-agreement.c"
line="145">a #AsAgreement instance.</doc>
<type name="Agreement" c:type="AsAgreement*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-agreement.c"
line="146">the agreement kind, e.g. %AS_AGREEMENT_KIND_EULA</doc>
<type name="AgreementKind" c:type="AsAgreementKind"/>
</parameter>
</parameters>
</method>
<method name="set_version_id"
c:identifier="as_agreement_set_version_id"
version="0.12.1">
<doc xml:space="preserve"
filename="src/as-agreement.c"
line="176">Sets the agreement version identifier.</doc>
<source-position filename="src/as-agreement.h" line="78"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="agreement" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-agreement.c"
line="178">a #AsAgreement instance.</doc>
<type name="Agreement" c:type="AsAgreement*"/>
</instance-parameter>
<parameter name="version_id" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-agreement.c"
line="179">the agreement version ID, e.g. "1.4a"</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<record name="AgreementClass"
c:type="AsAgreementClass"
glib:is-gtype-struct-for="Agreement">
<source-position filename="src/as-agreement.h" line="49"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_as_reserved1" introspectable="0">
<callback name="_as_reserved1">
<source-position filename="src/as-agreement.h" line="41"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved2" introspectable="0">
<callback name="_as_reserved2">
<source-position filename="src/as-agreement.h" line="42"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved3" introspectable="0">
<callback name="_as_reserved3">
<source-position filename="src/as-agreement.h" line="43"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved4" introspectable="0">
<callback name="_as_reserved4">
<source-position filename="src/as-agreement.h" line="44"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved5" introspectable="0">
<callback name="_as_reserved5">
<source-position filename="src/as-agreement.h" line="45"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved6" introspectable="0">
<callback name="_as_reserved6">
<source-position filename="src/as-agreement.h" line="46"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved7" introspectable="0">
<callback name="_as_reserved7">
<source-position filename="src/as-agreement.h" line="47"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved8" introspectable="0">
<callback name="_as_reserved8">
<source-position filename="src/as-agreement.h" line="48"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
</record>
<enumeration name="AgreementKind"
glib:type-name="AsAgreementKind"
glib:get-type="as_agreement_kind_get_type"
c:type="AsAgreementKind">
<doc xml:space="preserve"
filename="src/as-agreement.h"
line="51">The kind of the agreement.</doc>
<member name="unknown"
value="0"
c:identifier="AS_AGREEMENT_KIND_UNKNOWN"
glib:nick="unknown"
glib:name="AS_AGREEMENT_KIND_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-agreement.h"
line="53">Unknown value</doc>
</member>
<member name="generic"
value="1"
c:identifier="AS_AGREEMENT_KIND_GENERIC"
glib:nick="generic"
glib:name="AS_AGREEMENT_KIND_GENERIC">
<doc xml:space="preserve"
filename="src/as-agreement.h"
line="54">A generic agreement without a specific type</doc>
</member>
<member name="eula"
value="2"
c:identifier="AS_AGREEMENT_KIND_EULA"
glib:nick="eula"
glib:name="AS_AGREEMENT_KIND_EULA">
<doc xml:space="preserve"
filename="src/as-agreement.h"
line="55">An End User License Agreement</doc>
</member>
<member name="privacy"
value="3"
c:identifier="AS_AGREEMENT_KIND_PRIVACY"
glib:nick="privacy"
glib:name="AS_AGREEMENT_KIND_PRIVACY">
<doc xml:space="preserve"
filename="src/as-agreement.h"
line="56">A privacy agreement, typically a GDPR statement</doc>
</member>
<function name="from_string"
c:identifier="as_agreement_kind_from_string"
version="0.12.1">
<doc xml:space="preserve"
filename="src/as-agreement.c"
line="102">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-agreement.h" line="72"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-agreement.c"
line="108">a #AsAgreementKind or %AS_AGREEMENT_KIND_UNKNOWN for unknown</doc>
<type name="AgreementKind" c:type="AsAgreementKind"/>
</return-value>
<parameters>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-agreement.c"
line="104">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="to_string"
c:identifier="as_agreement_kind_to_string"
version="0.12.1">
<doc xml:space="preserve"
filename="src/as-agreement.c"
line="80">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-agreement.h" line="71"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-agreement.c"
line="86">string version of @value</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-agreement.c"
line="82">the #AsAgreementKind.</doc>
<type name="AgreementKind" c:type="AsAgreementKind"/>
</parameter>
</parameters>
</function>
</enumeration>
<class name="AgreementSection"
c:symbol-prefix="agreement_section"
c:type="AsAgreementSection"
parent="GObject.Object"
glib:type-name="AsAgreementSection"
glib:get-type="as_agreement_section_get_type"
glib:type-struct="AgreementSectionClass">
<source-position filename="src/as-agreement-section.h" line="49"/>
<constructor name="new"
c:identifier="as_agreement_section_new"
version="0.12.1">
<doc xml:space="preserve"
filename="src/as-agreement-section.c"
line="389">Creates a new #AsAgreementSection.</doc>
<source-position filename="src/as-agreement-section.h" line="51"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-agreement-section.c"
line="394">a #AsAgreementSection</doc>
<type name="AgreementSection" c:type="AsAgreementSection*"/>
</return-value>
</constructor>
<method name="get_context"
c:identifier="as_agreement_section_get_context"
version="0.12.1">
<doc xml:space="preserve"
filename="src/as-agreement-section.c"
line="197">Returns the #AsContext associated with this section.
This function may return %NULL if no context is set.</doc>
<source-position filename="src/as-agreement-section.h" line="53"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="src/as-agreement-section.c"
line="204">the #AsContext used by this agreement section.</doc>
<type name="Context" c:type="AsContext*"/>
</return-value>
<parameters>
<instance-parameter name="agreement_section"
transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-agreement-section.c"
line="199">An instance of #AsAgreementSection.</doc>
<type name="AgreementSection" c:type="AsAgreementSection*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_description"
c:identifier="as_agreement_section_get_description"
version="0.12.1">
<doc xml:space="preserve"
filename="src/as-agreement-section.c"
line="159">Gets the agreement section desc.</doc>
<source-position filename="src/as-agreement-section.h" line="64"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-agreement-section.c"
line="165">a string, e.g. "GDPR", or NULL</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="agreement_section"
transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-agreement-section.c"
line="161">a #AsAgreementSection instance.</doc>
<type name="AgreementSection" c:type="AsAgreementSection*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_kind"
c:identifier="as_agreement_section_get_kind"
version="0.12.1">
<doc xml:space="preserve"
filename="src/as-agreement-section.c"
line="88">Gets the agreement section kind.</doc>
<source-position filename="src/as-agreement-section.h" line="56"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-agreement-section.c"
line="94">a string, e.g. "GDPR", or NULL</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="agreement_section"
transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-agreement-section.c"
line="90">a #AsAgreementSection instance.</doc>
<type name="AgreementSection" c:type="AsAgreementSection*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_name"
c:identifier="as_agreement_section_get_name"
version="0.12.1">
<doc xml:space="preserve"
filename="src/as-agreement-section.c"
line="123">Gets the agreement section name.</doc>
<source-position filename="src/as-agreement-section.h" line="59"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-agreement-section.c"
line="129">a string, e.g. "GDPR", or NULL</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="agreement_section"
transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-agreement-section.c"
line="125">a #AsAgreementSection instance.</doc>
<type name="AgreementSection" c:type="AsAgreementSection*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_context"
c:identifier="as_agreement_section_set_context"
version="0.12.1">
<doc xml:space="preserve"
filename="src/as-agreement-section.c"
line="215">Sets the document context this release is associated
with.</doc>
<source-position filename="src/as-agreement-section.h" line="54"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="agreement_section"
transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-agreement-section.c"
line="217">An instance of #AsAgreementSection.</doc>
<type name="AgreementSection" c:type="AsAgreementSection*"/>
</instance-parameter>
<parameter name="context" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-agreement-section.c"
line="218">the #AsContext.</doc>
<type name="Context" c:type="AsContext*"/>
</parameter>
</parameters>
</method>
<method name="set_description"
c:identifier="as_agreement_section_set_description"
version="0.12.1">
<doc xml:space="preserve"
filename="src/as-agreement-section.c"
line="178">Sets the agreement section desc.</doc>
<source-position filename="src/as-agreement-section.h" line="65"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="agreement_section"
transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-agreement-section.c"
line="180">a #AsAgreementSection instance.</doc>
<type name="AgreementSection" c:type="AsAgreementSection*"/>
</instance-parameter>
<parameter name="desc" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-agreement-section.c"
line="182">the agreement description, e.g. "GDPR"</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="locale"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="src/as-agreement-section.c"
line="181">the locale in BCP47 format. e.g. "en-GB"</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_kind"
c:identifier="as_agreement_section_set_kind"
version="0.12.1">
<doc xml:space="preserve"
filename="src/as-agreement-section.c"
line="105">Sets the agreement section kind.</doc>
<source-position filename="src/as-agreement-section.h" line="57"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="agreement_section"
transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-agreement-section.c"
line="107">a #AsAgreementSection instance.</doc>
<type name="AgreementSection" c:type="AsAgreementSection*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-agreement-section.c"
line="108">the agreement kind, e.g. "GDPR"</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_name"
c:identifier="as_agreement_section_set_name"
version="0.12.1">
<doc xml:space="preserve"
filename="src/as-agreement-section.c"
line="140">Sets the agreement section name.</doc>
<source-position filename="src/as-agreement-section.h" line="60"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="agreement_section"
transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-agreement-section.c"
line="142">a #AsAgreementSection instance.</doc>
<type name="AgreementSection" c:type="AsAgreementSection*"/>
</instance-parameter>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-agreement-section.c"
line="143">the agreement name, e.g. "GDPR"</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="locale"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="src/as-agreement-section.c"
line="144">the locale. e.g. "en_GB"</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<record name="AgreementSectionClass"
c:type="AsAgreementSectionClass"
glib:is-gtype-struct-for="AgreementSection">
<source-position filename="src/as-agreement-section.h" line="49"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_as_reserved1" introspectable="0">
<callback name="_as_reserved1">
<source-position filename="src/as-agreement-section.h" line="41"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved2" introspectable="0">
<callback name="_as_reserved2">
<source-position filename="src/as-agreement-section.h" line="42"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved3" introspectable="0">
<callback name="_as_reserved3">
<source-position filename="src/as-agreement-section.h" line="43"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved4" introspectable="0">
<callback name="_as_reserved4">
<source-position filename="src/as-agreement-section.h" line="44"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved5" introspectable="0">
<callback name="_as_reserved5">
<source-position filename="src/as-agreement-section.h" line="45"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved6" introspectable="0">
<callback name="_as_reserved6">
<source-position filename="src/as-agreement-section.h" line="46"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved7" introspectable="0">
<callback name="_as_reserved7">
<source-position filename="src/as-agreement-section.h" line="47"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved8" introspectable="0">
<callback name="_as_reserved8">
<source-position filename="src/as-agreement-section.h" line="48"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
</record>
<class name="Artifact"
c:symbol-prefix="artifact"
c:type="AsArtifact"
parent="GObject.Object"
glib:type-name="AsArtifact"
glib:get-type="as_artifact_get_type"
glib:type-struct="ArtifactClass">
<source-position filename="src/as-artifact.h" line="46"/>
<constructor name="new" c:identifier="as_artifact_new">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="646">Creates a new #AsArtifact.</doc>
<source-position filename="src/as-artifact.h" line="88"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="651">a #AsArtifact</doc>
<type name="Artifact" c:type="AsArtifact*"/>
</return-value>
</constructor>
<method name="add_checksum" c:identifier="as_artifact_add_checksum">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="253">Add a checksum for the file associated with this artifact.</doc>
<source-position filename="src/as-artifact.h" line="98"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="artifact" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="255">An instance of #AsArtifact.</doc>
<type name="Artifact" c:type="AsArtifact*"/>
</instance-parameter>
<parameter name="cs" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="256">The #AsChecksum.</doc>
<type name="Checksum" c:type="AsChecksum*"/>
</parameter>
</parameters>
</method>
<method name="add_location" c:identifier="as_artifact_add_location">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="204">Adds a artifact location.</doc>
<source-position filename="src/as-artifact.h" line="94"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="artifact" transfer-ownership="none">
<type name="Artifact" c:type="AsArtifact*"/>
</instance-parameter>
<parameter name="location" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="206">An URL of the download location</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="get_bundle_kind"
c:identifier="as_artifact_get_bundle_kind">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="331">Gets the bundle kind of this artifact.</doc>
<source-position filename="src/as-artifact.h" line="106"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="337">the #AsBundleKind</doc>
<type name="BundleKind" c:type="AsBundleKind"/>
</return-value>
<parameters>
<instance-parameter name="artifact" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="333">an #AsArtifact instance.</doc>
<type name="Artifact" c:type="AsArtifact*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_checksum" c:identifier="as_artifact_get_checksum">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="231">Gets the artifact checksum</doc>
<source-position filename="src/as-artifact.h" line="97"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="237">an #AsChecksum, or %NULL for not set or invalid</doc>
<type name="Checksum" c:type="AsChecksum*"/>
</return-value>
<parameters>
<instance-parameter name="artifact" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="233">a #AsArtifact instance.</doc>
<type name="Artifact" c:type="AsArtifact*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<type name="ChecksumKind" c:type="AsChecksumKind"/>
</parameter>
</parameters>
</method>
<method name="get_checksums" c:identifier="as_artifact_get_checksums">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="217">Get a list of all checksums we have for this artifact.</doc>
<source-position filename="src/as-artifact.h" line="96"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="222">an array of #AsChecksum objects.</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="Checksum"/>
</array>
</return-value>
<parameters>
<instance-parameter name="artifact" transfer-ownership="none">
<type name="Artifact" c:type="AsArtifact*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_filename" c:identifier="as_artifact_get_filename">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="360">Gets a suggested filename for the downloaded artifact,
or %NULL if none is suggested.</doc>
<source-position filename="src/as-artifact.h" line="109"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="367">The platform triplet or identifier string.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="artifact" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="362">a #AsArtifact instance.</doc>
<type name="Artifact" c:type="AsArtifact*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_kind" c:identifier="as_artifact_get_kind">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="174">Gets the artifact kind.</doc>
<source-position filename="src/as-artifact.h" line="90"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="180">the #AsArtifactKind</doc>
<type name="ArtifactKind" c:type="AsArtifactKind"/>
</return-value>
<parameters>
<instance-parameter name="artifact" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="176">a #AsArtifact instance.</doc>
<type name="Artifact" c:type="AsArtifact*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_locations" c:identifier="as_artifact_get_locations">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="190">Gets the artifact locations, typically URLs.</doc>
<source-position filename="src/as-artifact.h" line="93"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="195">list of locations</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="utf8"/>
</array>
</return-value>
<parameters>
<instance-parameter name="artifact" transfer-ownership="none">
<type name="Artifact" c:type="AsArtifact*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_platform" c:identifier="as_artifact_get_platform">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="302">Gets the artifact platform string (e.g. a triplet like "x86_64-linux-gnu").</doc>
<source-position filename="src/as-artifact.h" line="103"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="308">The platform triplet or identifier string.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="artifact" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="304">a #AsArtifact instance.</doc>
<type name="Artifact" c:type="AsArtifact*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_size" c:identifier="as_artifact_get_size">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="267">Gets the artifact size.</doc>
<source-position filename="src/as-artifact.h" line="100"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="274">The size of the given kind of this artifact.</doc>
<type name="guint64" c:type="guint64"/>
</return-value>
<parameters>
<instance-parameter name="artifact" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="269">a #AsArtifact instance</doc>
<type name="Artifact" c:type="AsArtifact*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="270">a #AsSizeKind</doc>
<type name="SizeKind" c:type="AsSizeKind"/>
</parameter>
</parameters>
</method>
<method name="set_bundle_kind"
c:identifier="as_artifact_set_bundle_kind">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="346">Sets the bundle kind for this release artifact.</doc>
<source-position filename="src/as-artifact.h" line="107"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="artifact" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="348">an #AsArtifact instance.</doc>
<type name="Artifact" c:type="AsArtifact*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="349">the #AsBundleKind, e.g. %AS_BUNDLE_KIND_TARBALL.</doc>
<type name="BundleKind" c:type="AsBundleKind"/>
</parameter>
</parameters>
</method>
<method name="set_filename" c:identifier="as_artifact_set_filename">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="376">Sets a suggested filename for this artifact after it has been downloaded.</doc>
<source-position filename="src/as-artifact.h" line="110"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="artifact" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="378">a #AsArtifact instance.</doc>
<type name="Artifact" c:type="AsArtifact*"/>
</instance-parameter>
<parameter name="filename" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="379">the file name suggestion.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_kind" c:identifier="as_artifact_set_kind">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="159">Sets the artifact kind.</doc>
<source-position filename="src/as-artifact.h" line="91"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="artifact" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="161">a #AsArtifact instance.</doc>
<type name="Artifact" c:type="AsArtifact*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="162">the #AsArtifactKind, e.g. %AS_ARTIFACT_KIND_SOURCE.</doc>
<type name="ArtifactKind" c:type="AsArtifactKind"/>
</parameter>
</parameters>
</method>
<method name="set_platform" c:identifier="as_artifact_set_platform">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="317">Sets the artifact platform triplet or identifier string.</doc>
<source-position filename="src/as-artifact.h" line="104"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="artifact" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="319">a #AsArtifact instance.</doc>
<type name="Artifact" c:type="AsArtifact*"/>
</instance-parameter>
<parameter name="platform" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="320">the platform triplet.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_size" c:identifier="as_artifact_set_size">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="284">Sets the artifact size for the given kind.</doc>
<source-position filename="src/as-artifact.h" line="101"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="artifact" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="286">a #AsArtifact instance</doc>
<type name="Artifact" c:type="AsArtifact*"/>
</instance-parameter>
<parameter name="size" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="287">a size in bytes, or 0 for unknown</doc>
<type name="guint64" c:type="guint64"/>
</parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="288">a #AsSizeKind</doc>
<type name="SizeKind" c:type="AsSizeKind"/>
</parameter>
</parameters>
</method>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<record name="ArtifactClass"
c:type="AsArtifactClass"
glib:is-gtype-struct-for="Artifact">
<source-position filename="src/as-artifact.h" line="46"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_as_reserved1" introspectable="0">
<callback name="_as_reserved1">
<source-position filename="src/as-artifact.h" line="40"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved2" introspectable="0">
<callback name="_as_reserved2">
<source-position filename="src/as-artifact.h" line="41"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved3" introspectable="0">
<callback name="_as_reserved3">
<source-position filename="src/as-artifact.h" line="42"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved4" introspectable="0">
<callback name="_as_reserved4">
<source-position filename="src/as-artifact.h" line="43"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved5" introspectable="0">
<callback name="_as_reserved5">
<source-position filename="src/as-artifact.h" line="44"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved6" introspectable="0">
<callback name="_as_reserved6">
<source-position filename="src/as-artifact.h" line="45"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
</record>
<enumeration name="ArtifactKind"
glib:type-name="AsArtifactKind"
glib:get-type="as_artifact_kind_get_type"
c:type="AsArtifactKind">
<doc xml:space="preserve"
filename="src/as-artifact.h"
line="69">The artifact type.</doc>
<member name="unknown"
value="0"
c:identifier="AS_ARTIFACT_KIND_UNKNOWN"
glib:nick="unknown"
glib:name="AS_ARTIFACT_KIND_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-artifact.h"
line="71">Type invalid or not known</doc>
</member>
<member name="source"
value="1"
c:identifier="AS_ARTIFACT_KIND_SOURCE"
glib:nick="source"
glib:name="AS_ARTIFACT_KIND_SOURCE">
<doc xml:space="preserve"
filename="src/as-artifact.h"
line="72">The artifact describes software sources.</doc>
</member>
<member name="binary"
value="2"
c:identifier="AS_ARTIFACT_KIND_BINARY"
glib:nick="binary"
glib:name="AS_ARTIFACT_KIND_BINARY">
<doc xml:space="preserve"
filename="src/as-artifact.h"
line="73">The artifact describes a binary distribution of the component.</doc>
</member>
<function name="from_string" c:identifier="as_artifact_kind_from_string">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="88">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-artifact.h" line="85"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="94">a #AsArtifactKind, or %AS_ARTIFACT_KIND_UNKNOWN for unknown.</doc>
<type name="ArtifactKind" c:type="AsArtifactKind"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="90">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="to_string" c:identifier="as_artifact_kind_to_string">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="107">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-artifact.h" line="86"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="113">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="109">the #AsArtifactKind.</doc>
<type name="ArtifactKind" c:type="AsArtifactKind"/>
</parameter>
</parameters>
</function>
</enumeration>
<class name="Branding"
c:symbol-prefix="branding"
c:type="AsBranding"
parent="GObject.Object"
glib:type-name="AsBranding"
glib:get-type="as_branding_get_type"
glib:type-struct="BrandingClass">
<source-position filename="src/as-branding.h" line="44"/>
<constructor name="new" c:identifier="as_branding_new" version="0.10">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="534">Creates a new #AsBranding.</doc>
<source-position filename="src/as-branding.h" line="92"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="539">a #AsBranding</doc>
<type name="Branding" c:type="AsBranding*"/>
</return-value>
</constructor>
<method name="get_color"
c:identifier="as_branding_get_color"
version="0.15.2">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="327">Retrieve a color of the given @kind that matches @scheme_kind.
If a color has no scheme preference defined, it will be returned for either scheme type,
unless a more suitable color was found.</doc>
<source-position filename="src/as-branding.h" line="108"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="337">The HTML color code of the found color, or %NULL if no color was found.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="branding" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="329">an #AsBranding instance.</doc>
<type name="Branding" c:type="AsBranding*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="330">the #AsColorKind, e.g. %AS_COLOR_KIND_PRIMARY.</doc>
<type name="ColorKind" c:type="AsColorKind"/>
</parameter>
<parameter name="scheme_kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="331">Color scheme preference for the color, e.g. %AS_COLOR_SCHEME_KIND_LIGHT</doc>
<type name="ColorSchemeKind" c:type="AsColorSchemeKind"/>
</parameter>
</parameters>
</method>
<method name="remove_color"
c:identifier="as_branding_remove_color"
version="0.15.2">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="225">Deletes a color that matches the given type and scheme preference.</doc>
<source-position filename="src/as-branding.h" line="98"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="branding" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="227">an #AsBranding instance.</doc>
<type name="Branding" c:type="AsBranding*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="228">the #AsColorKind, e.g. %AS_COLOR_KIND_PRIMARY.</doc>
<type name="ColorKind" c:type="AsColorKind"/>
</parameter>
<parameter name="scheme_preference" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="229">Type of color scheme preferred for this color, e.g. %AS_COLOR_SCHEME_KIND_LIGHT</doc>
<type name="ColorSchemeKind" c:type="AsColorSchemeKind"/>
</parameter>
</parameters>
</method>
<method name="set_color"
c:identifier="as_branding_set_color"
version="0.15.2">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="189">Sets a new accent color. If a color of the given kind with the given scheme preference already exists,
it will be overriden with the new color code.</doc>
<source-position filename="src/as-branding.h" line="94"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="branding" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="191">an #AsBranding instance.</doc>
<type name="Branding" c:type="AsBranding*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="192">the #AsColorKind, e.g. %AS_COLOR_KIND_PRIMARY.</doc>
<type name="ColorKind" c:type="AsColorKind"/>
</parameter>
<parameter name="scheme_preference" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="193">Type of color scheme preferred for this color, e.g. %AS_COLOR_SCHEME_KIND_LIGHT</doc>
<type name="ColorSchemeKind" c:type="AsColorSchemeKind"/>
</parameter>
<parameter name="colorcode" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="194">a HTML color code.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<record name="BrandingClass"
c:type="AsBrandingClass"
glib:is-gtype-struct-for="Branding">
<source-position filename="src/as-branding.h" line="44"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_as_reserved1" introspectable="0">
<callback name="_as_reserved1">
<source-position filename="src/as-branding.h" line="38"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved2" introspectable="0">
<callback name="_as_reserved2">
<source-position filename="src/as-branding.h" line="39"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved3" introspectable="0">
<callback name="_as_reserved3">
<source-position filename="src/as-branding.h" line="40"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved4" introspectable="0">
<callback name="_as_reserved4">
<source-position filename="src/as-branding.h" line="41"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved5" introspectable="0">
<callback name="_as_reserved5">
<source-position filename="src/as-branding.h" line="42"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved6" introspectable="0">
<callback name="_as_reserved6">
<source-position filename="src/as-branding.h" line="43"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
</record>
<record name="BrandingColorIter" c:type="AsBrandingColorIter">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="43">A #AsBrandingColorIter structure represents an iterator that can be used
to iterate over the accent colors of an #AsBranding object.
#AsBrandingColorIter structures are typically allocated on the stack and
then initialized with as_branding_color_iter_init().</doc>
<source-position filename="src/as-branding.h" line="54"/>
<field name="dummy1" readable="0" private="1">
<type name="gpointer" c:type="gpointer"/>
</field>
<field name="dummy2" readable="0" private="1">
<type name="guint" c:type="guint"/>
</field>
<field name="dummy3" readable="0" private="1">
<type name="gpointer" c:type="gpointer"/>
</field>
<field name="dummy4" readable="0" private="1">
<type name="gpointer" c:type="gpointer"/>
</field>
<field name="dummy5" readable="0" private="1">
<type name="gpointer" c:type="gpointer"/>
</field>
<field name="dummy6" readable="0" private="1">
<type name="gpointer" c:type="gpointer"/>
</field>
<method name="init" c:identifier="as_branding_color_iter_init">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="251">Initializes a color iterator for the accent color list and associates it
it with @branding.
The #AsBrandingColorIter structure is typically allocated on the stack
and does not need to be freed explicitly.</doc>
<source-position filename="src/as-branding.h" line="102"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="iter" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="253">an uninitialized #AsBrandingColorIter</doc>
<type name="BrandingColorIter" c:type="AsBrandingColorIter*"/>
</instance-parameter>
<parameter name="branding" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="254">an #AsBranding</doc>
<type name="Branding" c:type="AsBranding*"/>
</parameter>
</parameters>
</method>
<method name="next" c:identifier="as_branding_color_iter_next">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="273">Returns the current color entry and advances the iterator.
Example:
|[<!-- language="C" -->
AsBrandingColorIter iter;
AsColorKind ckind;
AsColorSchemeKind scheme_preference;
const gchar *color_value;
as_branding_color_iter_init (&iter, branding);
while (as_branding_color_iter_next (&iter, &ckind, &scheme_preference, &color_value)) {
// do something with the color data
}
]|</doc>
<source-position filename="src/as-branding.h" line="103"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="294">%FALSE if the last entry has been reached.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="iter" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="275">an initialized #AsBrandingColorIter</doc>
<type name="BrandingColorIter" c:type="AsBrandingColorIter*"/>
</instance-parameter>
<parameter name="kind"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="276">Destination of the returned color kind.</doc>
<type name="ColorKind" c:type="AsColorKind*"/>
</parameter>
<parameter name="scheme_preference"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="277">Destination of the returned color's scheme preference.</doc>
<type name="ColorSchemeKind" c:type="AsColorSchemeKind*"/>
</parameter>
<parameter name="value"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="278">Destination of the returned color code.</doc>
<type name="utf8" c:type="const gchar**"/>
</parameter>
</parameters>
</method>
</record>
<class name="Bundle"
c:symbol-prefix="bundle"
c:type="AsBundle"
parent="GObject.Object"
glib:type-name="AsBundle"
glib:get-type="as_bundle_get_type"
glib:type-struct="BundleClass">
<source-position filename="src/as-bundle.h" line="44"/>
<constructor name="new" c:identifier="as_bundle_new" version="0.10">
<doc xml:space="preserve"
filename="src/as-bundle.c"
line="308">Creates a new #AsBundle.</doc>
<source-position filename="src/as-bundle.h" line="79"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-bundle.c"
line="313">a #AsBundle</doc>
<type name="Bundle" c:type="AsBundle*"/>
</return-value>
</constructor>
<method name="get_id" c:identifier="as_bundle_get_id" version="0.10">
<doc xml:space="preserve"
filename="src/as-bundle.c"
line="133">Gets the ID for this bundle.</doc>
<source-position filename="src/as-bundle.h" line="84"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-bundle.c"
line="139">ID, e.g. "foobar-1.0.2"</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="bundle" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-bundle.c"
line="135">an #AsBundle instance.</doc>
<type name="Bundle" c:type="AsBundle*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_kind" c:identifier="as_bundle_get_kind" version="0.10">
<doc xml:space="preserve"
filename="src/as-bundle.c"
line="167">Gets the bundle kind.</doc>
<source-position filename="src/as-bundle.h" line="81"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-bundle.c"
line="173">the #AsBundleKind</doc>
<type name="BundleKind" c:type="AsBundleKind"/>
</return-value>
<parameters>
<instance-parameter name="bundle" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-bundle.c"
line="169">an #AsBundle instance.</doc>
<type name="Bundle" c:type="AsBundle*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_id" c:identifier="as_bundle_set_id" version="0.10">
<doc xml:space="preserve"
filename="src/as-bundle.c"
line="150">Sets the ID for this bundle.</doc>
<source-position filename="src/as-bundle.h" line="85"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="bundle" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-bundle.c"
line="152">an #AsBundle instance.</doc>
<type name="Bundle" c:type="AsBundle*"/>
</instance-parameter>
<parameter name="id" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-bundle.c"
line="153">the URL.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_kind" c:identifier="as_bundle_set_kind" version="0.10">
<doc xml:space="preserve"
filename="src/as-bundle.c"
line="184">Sets the bundle kind.</doc>
<source-position filename="src/as-bundle.h" line="82"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="bundle" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-bundle.c"
line="186">an #AsBundle instance.</doc>
<type name="Bundle" c:type="AsBundle*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-bundle.c"
line="187">the #AsBundleKind, e.g. %AS_BUNDLE_KIND_LIMBA.</doc>
<type name="BundleKind" c:type="AsBundleKind"/>
</parameter>
</parameters>
</method>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<record name="BundleClass"
c:type="AsBundleClass"
glib:is-gtype-struct-for="Bundle">
<source-position filename="src/as-bundle.h" line="44"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_as_reserved1" introspectable="0">
<callback name="_as_reserved1">
<source-position filename="src/as-bundle.h" line="38"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved2" introspectable="0">
<callback name="_as_reserved2">
<source-position filename="src/as-bundle.h" line="39"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved3" introspectable="0">
<callback name="_as_reserved3">
<source-position filename="src/as-bundle.h" line="40"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved4" introspectable="0">
<callback name="_as_reserved4">
<source-position filename="src/as-bundle.h" line="41"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved5" introspectable="0">
<callback name="_as_reserved5">
<source-position filename="src/as-bundle.h" line="42"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved6" introspectable="0">
<callback name="_as_reserved6">
<source-position filename="src/as-bundle.h" line="43"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
</record>
<enumeration name="BundleKind"
glib:type-name="AsBundleKind"
glib:get-type="as_bundle_kind_get_type"
c:type="AsBundleKind">
<doc xml:space="preserve"
filename="src/as-bundle.h"
line="46">The bundle type.</doc>
<member name="unknown"
value="0"
c:identifier="AS_BUNDLE_KIND_UNKNOWN"
glib:nick="unknown"
glib:name="AS_BUNDLE_KIND_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-bundle.h"
line="48">Type invalid or not known</doc>
</member>
<member name="package"
value="1"
c:identifier="AS_BUNDLE_KIND_PACKAGE"
glib:nick="package"
glib:name="AS_BUNDLE_KIND_PACKAGE">
<doc xml:space="preserve"
filename="src/as-bundle.h"
line="49">A native package (currently not used)</doc>
</member>
<member name="limba"
value="2"
c:identifier="AS_BUNDLE_KIND_LIMBA"
glib:nick="limba"
glib:name="AS_BUNDLE_KIND_LIMBA">
<doc xml:space="preserve"
filename="src/as-bundle.h"
line="50">A Limba bundle</doc>
</member>
<member name="flatpak"
value="3"
c:identifier="AS_BUNDLE_KIND_FLATPAK"
glib:nick="flatpak"
glib:name="AS_BUNDLE_KIND_FLATPAK">
<doc xml:space="preserve"
filename="src/as-bundle.h"
line="51">A Flatpak bundle</doc>
</member>
<member name="appimage"
value="4"
c:identifier="AS_BUNDLE_KIND_APPIMAGE"
glib:nick="appimage"
glib:name="AS_BUNDLE_KIND_APPIMAGE">
<doc xml:space="preserve"
filename="src/as-bundle.h"
line="52">An AppImageKit bundle</doc>
</member>
<member name="snap"
value="5"
c:identifier="AS_BUNDLE_KIND_SNAP"
glib:nick="snap"
glib:name="AS_BUNDLE_KIND_SNAP">
<doc xml:space="preserve"
filename="src/as-bundle.h"
line="53">A Snap/Snappy bundle</doc>
</member>
<member name="tarball"
value="6"
c:identifier="AS_BUNDLE_KIND_TARBALL"
glib:nick="tarball"
glib:name="AS_BUNDLE_KIND_TARBALL">
<doc xml:space="preserve"
filename="src/as-bundle.h"
line="54">A (maybe compressed) tarball.</doc>
</member>
<member name="cabinet"
value="7"
c:identifier="AS_BUNDLE_KIND_CABINET"
glib:nick="cabinet"
glib:name="AS_BUNDLE_KIND_CABINET">
<doc xml:space="preserve"
filename="src/as-bundle.h"
line="55">Cabinet firmware deployment</doc>
</member>
<member name="linglong"
value="8"
c:identifier="AS_BUNDLE_KIND_LINGLONG"
glib:nick="linglong"
glib:name="AS_BUNDLE_KIND_LINGLONG">
<doc xml:space="preserve"
filename="src/as-bundle.h"
line="56">A Linglong bundle</doc>
</member>
<member name="sysupdate"
value="9"
c:identifier="AS_BUNDLE_KIND_SYSUPDATE"
glib:nick="sysupdate"
glib:name="AS_BUNDLE_KIND_SYSUPDATE">
<doc xml:space="preserve"
filename="src/as-bundle.h"
line="57">A systemd-sysupdate bundle</doc>
</member>
<function name="from_string" c:identifier="as_bundle_kind_from_string">
<doc xml:space="preserve"
filename="src/as-bundle.c"
line="78">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-bundle.h" line="77"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-bundle.c"
line="84">a #AsBundleKind or %AS_BUNDLE_KIND_UNKNOWN for unknown</doc>
<type name="BundleKind" c:type="AsBundleKind"/>
</return-value>
<parameters>
<parameter name="bundle_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-bundle.c"
line="80">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="to_string"
c:identifier="as_bundle_kind_to_string"
version="0.8.0">
<doc xml:space="preserve"
filename="src/as-bundle.c"
line="44">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-bundle.h" line="76"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-bundle.c"
line="50">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-bundle.c"
line="46">the %AsBundleKind.</doc>
<type name="BundleKind" c:type="AsBundleKind"/>
</parameter>
</parameters>
</function>
</enumeration>
<function-macro name="CHECK_VERSION"
c:identifier="AS_CHECK_VERSION"
introspectable="0">
<source-position filename="src/as-version.h" line="41"/>
<parameters>
<parameter name="major">
</parameter>
<parameter name="minor">
</parameter>
<parameter name="micro">
</parameter>
</parameters>
</function-macro>
<function-macro name="COMPONENT_BOX"
c:identifier="AS_COMPONENT_BOX"
introspectable="0">
<source-position filename="src/as-component-box.h" line="55"/>
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<bitfield name="CacheFlags"
glib:type-name="AsCacheFlags"
glib:get-type="as_cache_flags_get_type"
c:type="AsCacheFlags">
<doc xml:space="preserve"
filename="src/as-pool.h"
line="77">Flags on how caching should be used.</doc>
<member name="none"
value="0"
c:identifier="AS_CACHE_FLAG_NONE"
glib:nick="none"
glib:name="AS_CACHE_FLAG_NONE">
<doc xml:space="preserve"
filename="src/as-pool.h"
line="79">No flags.</doc>
</member>
<member name="use_user"
value="1"
c:identifier="AS_CACHE_FLAG_USE_USER"
glib:nick="use-user"
glib:name="AS_CACHE_FLAG_USE_USER">
<doc xml:space="preserve"
filename="src/as-pool.h"
line="80">Create an user-specific metadata cache.</doc>
</member>
<member name="use_system"
value="2"
c:identifier="AS_CACHE_FLAG_USE_SYSTEM"
glib:nick="use-system"
glib:name="AS_CACHE_FLAG_USE_SYSTEM">
<doc xml:space="preserve"
filename="src/as-pool.h"
line="81">Use and - if possible - update the system metadata cache.</doc>
</member>
<member name="no_clear"
value="4"
c:identifier="AS_CACHE_FLAG_NO_CLEAR"
glib:nick="no-clear"
glib:name="AS_CACHE_FLAG_NO_CLEAR">
<doc xml:space="preserve"
filename="src/as-pool.h"
line="82">Don't clear the cache when opening it.</doc>
</member>
<member name="refresh_system"
value="8"
c:identifier="AS_CACHE_FLAG_REFRESH_SYSTEM"
glib:nick="refresh-system"
glib:name="AS_CACHE_FLAG_REFRESH_SYSTEM">
<doc xml:space="preserve"
filename="src/as-pool.h"
line="83">Refresh the system cache that is shared between applications.</doc>
</member>
</bitfield>
<class name="Category"
c:symbol-prefix="category"
c:type="AsCategory"
parent="GObject.Object"
glib:type-name="AsCategory"
glib:get-type="as_category_get_type"
glib:type-struct="CategoryClass">
<source-position filename="src/as-category.h" line="44"/>
<constructor name="new" c:identifier="as_category_new">
<doc xml:space="preserve"
filename="src/as-category.c"
line="763">Creates a new #AsCategory.</doc>
<source-position filename="src/as-category.h" line="46"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-category.c"
line="768">a new #AsCategory</doc>
<type name="Category" c:type="AsCategory*"/>
</return-value>
</constructor>
<method name="add_child" c:identifier="as_category_add_child">
<doc xml:space="preserve"
filename="src/as-category.c"
line="465">Add a subcategory to this category.</doc>
<source-position filename="src/as-category.h" line="62"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="category" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-category.c"
line="467">An instance of #AsCategory.</doc>
<type name="Category" c:type="AsCategory*"/>
</instance-parameter>
<parameter name="subcat" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-category.c"
line="468">A subcategory to add.</doc>
<type name="Category" c:type="AsCategory*"/>
</parameter>
</parameters>
</method>
<method name="add_component" c:identifier="as_category_add_component">
<doc xml:space="preserve"
filename="src/as-category.c"
line="607">Add a component to this category.</doc>
<source-position filename="src/as-category.h" line="69"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="category" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-category.c"
line="609">An instance of #AsCategory.</doc>
<type name="Category" c:type="AsCategory*"/>
</instance-parameter>
<parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-category.c"
line="610">The #AsComponent to add.</doc>
<type name="Component" c:type="AsComponent*"/>
</parameter>
</parameters>
</method>
<method name="add_desktop_group"
c:identifier="as_category_add_desktop_group">
<doc xml:space="preserve"
filename="src/as-category.c"
line="578">Add a desktop-file category to this #AsCategory.</doc>
<source-position filename="src/as-category.h" line="66"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="category" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-category.c"
line="580">An instance of #AsCategory.</doc>
<type name="Category" c:type="AsCategory*"/>
</instance-parameter>
<parameter name="group_name" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-category.c"
line="581">A subcategory to add.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="get_children"
c:identifier="as_category_get_children"
glib:get-property="children">
<source-position filename="src/as-category.h" line="60"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-category.c"
line="456">A list of subcategories.</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="Category"/>
</array>
</return-value>
<parameters>
<instance-parameter name="category" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-category.c"
line="454">An instance of #AsCategory.</doc>
<type name="Category" c:type="AsCategory*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_components" c:identifier="as_category_get_components">
<doc xml:space="preserve"
filename="src/as-category.c"
line="592">Get list of components which have been sorted into this category.</doc>
<source-position filename="src/as-category.h" line="68"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-category.c"
line="598">List of #AsCategory</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="Component"/>
</array>
</return-value>
<parameters>
<instance-parameter name="category" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-category.c"
line="594">An instance of #AsCategory.</doc>
<type name="Category" c:type="AsCategory*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_desktop_groups"
c:identifier="as_category_get_desktop_groups">
<source-position filename="src/as-category.h" line="65"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-category.c"
line="569">A list of desktop-file categories.</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="utf8"/>
</array>
</return-value>
<parameters>
<instance-parameter name="category" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-category.c"
line="567">An instance of #AsCategory.</doc>
<type name="Category" c:type="AsCategory*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_icon"
c:identifier="as_category_get_icon"
glib:get-property="icon">
<doc xml:space="preserve"
filename="src/as-category.c"
line="537">Get the stock icon name for this category.</doc>
<source-position filename="src/as-category.h" line="57"/>
<return-value transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="category" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-category.c"
line="539">An instance of #AsCategory.</doc>
<type name="Category" c:type="AsCategory*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_id"
c:identifier="as_category_get_id"
glib:get-property="id">
<doc xml:space="preserve"
filename="src/as-category.c"
line="396">Get the ID of this category.</doc>
<source-position filename="src/as-category.h" line="48"/>
<return-value transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="category" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-category.c"
line="398">An instance of #AsCategory.</doc>
<type name="Category" c:type="AsCategory*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_name"
c:identifier="as_category_get_name"
glib:get-property="name">
<doc xml:space="preserve"
filename="src/as-category.c"
line="424">Get the name of this category.</doc>
<source-position filename="src/as-category.h" line="51"/>
<return-value transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="category" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-category.c"
line="426">An instance of #AsCategory.</doc>
<type name="Category" c:type="AsCategory*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_summary"
c:identifier="as_category_get_summary"
glib:get-property="summary">
<doc xml:space="preserve"
filename="src/as-category.c"
line="508">Get the summary (short description) of this category.</doc>
<source-position filename="src/as-category.h" line="54"/>
<return-value transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="category" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-category.c"
line="510">An instance of #AsCategory.</doc>
<type name="Category" c:type="AsCategory*"/>
</instance-parameter>
</parameters>
</method>
<method name="has_children" c:identifier="as_category_has_children">
<doc xml:space="preserve"
filename="src/as-category.c"
line="493">Test for sub-categories.</doc>
<source-position filename="src/as-category.h" line="61"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-category.c"
line="499">%TRUE if this category has any subcategory</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="category" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-category.c"
line="495">An instance of #AsCategory.</doc>
<type name="Category" c:type="AsCategory*"/>
</instance-parameter>
</parameters>
</method>
<method name="has_component" c:identifier="as_category_has_component">
<doc xml:space="preserve"
filename="src/as-category.c"
line="621">Check if the exact #AsComponent @cpt is a member of this
category already.</doc>
<source-position filename="src/as-category.h" line="70"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-category.c"
line="629">%TRUE if the component is present.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="category" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-category.c"
line="623">An instance of #AsCategory.</doc>
<type name="Category" c:type="AsCategory*"/>
</instance-parameter>
<parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-category.c"
line="624">The #AsComponent to look for.</doc>
<type name="Component" c:type="AsComponent*"/>
</parameter>
</parameters>
</method>
<method name="remove_child" c:identifier="as_category_remove_child">
<doc xml:space="preserve"
filename="src/as-category.c"
line="479">Drop a subcategory from this #AsCategory.</doc>
<source-position filename="src/as-category.h" line="63"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="category" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-category.c"
line="481">An instance of #AsCategory.</doc>
<type name="Category" c:type="AsCategory*"/>
</instance-parameter>
<parameter name="subcat" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-category.c"
line="482">A subcategory to remove.</doc>
<type name="Category" c:type="AsCategory*"/>
</parameter>
</parameters>
</method>
<method name="set_icon"
c:identifier="as_category_set_icon"
glib:set-property="icon">
<doc xml:space="preserve"
filename="src/as-category.c"
line="550">Set the stock icon name for this category.</doc>
<source-position filename="src/as-category.h" line="58"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="category" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-category.c"
line="552">An instance of #AsCategory.</doc>
<type name="Category" c:type="AsCategory*"/>
</instance-parameter>
<parameter name="value" transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_id"
c:identifier="as_category_set_id"
glib:set-property="id">
<doc xml:space="preserve"
filename="src/as-category.c"
line="409">Set the ID of this category.</doc>
<source-position filename="src/as-category.h" line="49"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="category" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-category.c"
line="411">An instance of #AsCategory.</doc>
<type name="Category" c:type="AsCategory*"/>
</instance-parameter>
<parameter name="id" transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_name"
c:identifier="as_category_set_name"
glib:set-property="name">
<doc xml:space="preserve"
filename="src/as-category.c"
line="437">Set the name of this category.</doc>
<source-position filename="src/as-category.h" line="52"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="category" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-category.c"
line="439">An instance of #AsCategory.</doc>
<type name="Category" c:type="AsCategory*"/>
</instance-parameter>
<parameter name="value" transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_summary" c:identifier="as_category_set_summary">
<doc xml:space="preserve"
filename="src/as-category.c"
line="521">Get the summary (short description) of this category.</doc>
<source-position filename="src/as-category.h" line="55"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="category" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-category.c"
line="523">An instance of #AsCategory.</doc>
<type name="Category" c:type="AsCategory*"/>
</instance-parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-category.c"
line="524">A new short summary of this category.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<property name="children"
transfer-ownership="none"
getter="get_children">
<type name="gpointer" c:type="gpointer"/>
</property>
<property name="icon"
writable="1"
transfer-ownership="none"
setter="set_icon"
getter="get_icon"
default-value="NULL">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="id"
writable="1"
transfer-ownership="none"
setter="set_id"
getter="get_id"
default-value="NULL">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="name"
writable="1"
transfer-ownership="none"
setter="set_name"
getter="get_name"
default-value="NULL">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="summary"
transfer-ownership="none"
getter="get_summary"
default-value="NULL">
<type name="utf8" c:type="gchar*"/>
</property>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<record name="CategoryClass"
c:type="AsCategoryClass"
glib:is-gtype-struct-for="Category">
<source-position filename="src/as-category.h" line="44"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_as_reserved1" introspectable="0">
<callback name="_as_reserved1">
<source-position filename="src/as-category.h" line="40"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved2" introspectable="0">
<callback name="_as_reserved2">
<source-position filename="src/as-category.h" line="41"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved3" introspectable="0">
<callback name="_as_reserved3">
<source-position filename="src/as-category.h" line="42"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved4" introspectable="0">
<callback name="_as_reserved4">
<source-position filename="src/as-category.h" line="43"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
</record>
<enumeration name="ChassisKind"
glib:type-name="AsChassisKind"
glib:get-type="as_chassis_kind_get_type"
c:type="AsChassisKind">
<doc xml:space="preserve"
filename="src/as-system-info.h"
line="66">The type of chassis a computing device is built into.</doc>
<member name="unknown"
value="0"
c:identifier="AS_CHASSIS_KIND_UNKNOWN"
glib:nick="unknown"
glib:name="AS_CHASSIS_KIND_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-system-info.h"
line="68">Unknown chassis.</doc>
</member>
<member name="desktop"
value="1"
c:identifier="AS_CHASSIS_KIND_DESKTOP"
glib:nick="desktop"
glib:name="AS_CHASSIS_KIND_DESKTOP">
<doc xml:space="preserve"
filename="src/as-system-info.h"
line="69">A desktop/workstation</doc>
</member>
<member name="laptop"
value="2"
c:identifier="AS_CHASSIS_KIND_LAPTOP"
glib:nick="laptop"
glib:name="AS_CHASSIS_KIND_LAPTOP">
<doc xml:space="preserve"
filename="src/as-system-info.h"
line="70">A mobile computer with a bigger screen / laptop</doc>
</member>
<member name="server"
value="3"
c:identifier="AS_CHASSIS_KIND_SERVER"
glib:nick="server"
glib:name="AS_CHASSIS_KIND_SERVER">
<doc xml:space="preserve"
filename="src/as-system-info.h"
line="71">A server, often without GUI</doc>
</member>
<member name="tablet"
value="4"
c:identifier="AS_CHASSIS_KIND_TABLET"
glib:nick="tablet"
glib:name="AS_CHASSIS_KIND_TABLET">
<doc xml:space="preserve"
filename="src/as-system-info.h"
line="72">A tablet with touch as primary input method</doc>
</member>
<member name="handset"
value="5"
c:identifier="AS_CHASSIS_KIND_HANDSET"
glib:nick="handset"
glib:name="AS_CHASSIS_KIND_HANDSET">
<doc xml:space="preserve"
filename="src/as-system-info.h"
line="73">A smaller touch-input device, like a smartphone</doc>
</member>
<function name="from_string"
c:identifier="as_chassis_kind_from_string"
version="1.0.0">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="138">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-system-info.h" line="89"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="144">a #AsChassisKind or %AS_CHASSIS_KIND_UNKNOWN for unknown</doc>
<type name="ChassisKind" c:type="AsChassisKind"/>
</return-value>
<parameters>
<parameter name="kind_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="140">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="to_string"
c:identifier="as_chassis_kind_to_string"
version="1.0.0">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="111">Converts the enumerated value to a text representation.</doc>
<source-position filename="src/as-system-info.h" line="88"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="117">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="113">the #AsChassisKind.</doc>
<type name="ChassisKind" c:type="AsChassisKind"/>
</parameter>
</parameters>
</function>
</enumeration>
<enumeration name="CheckResult"
glib:type-name="AsCheckResult"
glib:get-type="as_check_result_get_type"
c:type="AsCheckResult">
<doc xml:space="preserve"
filename="src/as-system-info.h"
line="48">Result of a check operation.</doc>
<member name="error"
value="0"
c:identifier="AS_CHECK_RESULT_ERROR"
glib:nick="error"
glib:name="AS_CHECK_RESULT_ERROR">
<doc xml:space="preserve"
filename="src/as-system-info.h"
line="50">The check failed.</doc>
</member>
<member name="unknown"
value="1"
c:identifier="AS_CHECK_RESULT_UNKNOWN"
glib:nick="unknown"
glib:name="AS_CHECK_RESULT_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-system-info.h"
line="51">The outcome could not be determined.</doc>
</member>
<member name="false"
value="2"
c:identifier="AS_CHECK_RESULT_FALSE"
glib:nick="false"
glib:name="AS_CHECK_RESULT_FALSE">
<doc xml:space="preserve"
filename="src/as-system-info.h"
line="52">False/No</doc>
</member>
<member name="true"
value="3"
c:identifier="AS_CHECK_RESULT_TRUE"
glib:nick="true"
glib:name="AS_CHECK_RESULT_TRUE">
<doc xml:space="preserve"
filename="src/as-system-info.h"
line="53">True/Yes</doc>
</member>
</enumeration>
<class name="Checksum"
c:symbol-prefix="checksum"
c:type="AsChecksum"
parent="GObject.Object"
glib:type-name="AsChecksum"
glib:get-type="as_checksum_get_type"
glib:type-struct="ChecksumClass">
<source-position filename="src/as-checksum.h" line="44"/>
<constructor name="new" c:identifier="as_checksum_new">
<doc xml:space="preserve"
filename="src/as-checksum.c"
line="290">Creates a new #AsChecksum.</doc>
<source-position filename="src/as-checksum.h" line="71"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-checksum.c"
line="295">an #AsChecksum</doc>
<type name="Checksum" c:type="AsChecksum*"/>
</return-value>
</constructor>
<constructor name="new_with_value"
c:identifier="as_checksum_new_with_value"
version="0.12.11">
<doc xml:space="preserve"
filename="src/as-checksum.c"
line="271">Creates a new #AsChecksum with the given hash
function and hash value.</doc>
<source-position filename="src/as-checksum.h" line="72"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-checksum.c"
line="277">an #AsChecksum</doc>
<type name="Checksum" c:type="AsChecksum*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<type name="ChecksumKind" c:type="AsChecksumKind"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</constructor>
<method name="get_kind" c:identifier="as_checksum_get_kind">
<doc xml:space="preserve"
filename="src/as-checksum.c"
line="122">Gets the checksum type.</doc>
<source-position filename="src/as-checksum.h" line="74"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-checksum.c"
line="128">the #AsChecksumKind</doc>
<type name="ChecksumKind" c:type="AsChecksumKind"/>
</return-value>
<parameters>
<instance-parameter name="cs" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-checksum.c"
line="124">a #AsChecksum instance.</doc>
<type name="Checksum" c:type="AsChecksum*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_value" c:identifier="as_checksum_get_value">
<doc xml:space="preserve"
filename="src/as-checksum.c"
line="151">Gets the checksum, usually in its hexadecimal form.</doc>
<source-position filename="src/as-checksum.h" line="77"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-checksum.c"
line="157">the checksum.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="cs" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-checksum.c"
line="153">a #AsChecksum instance.</doc>
<type name="Checksum" c:type="AsChecksum*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_kind" c:identifier="as_checksum_set_kind">
<doc xml:space="preserve"
filename="src/as-checksum.c"
line="137">Sets the checksum type.</doc>
<source-position filename="src/as-checksum.h" line="75"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cs" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-checksum.c"
line="139">a #AsChecksum instance.</doc>
<type name="Checksum" c:type="AsChecksum*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-checksum.c"
line="140">the #AsChecksumKind, e.g. %AS_CHECKSUM_KIND_SHA256.</doc>
<type name="ChecksumKind" c:type="AsChecksumKind"/>
</parameter>
</parameters>
</method>
<method name="set_value" c:identifier="as_checksum_set_value">
<doc xml:space="preserve"
filename="src/as-checksum.c"
line="166">Sets the checksum value filename.</doc>
<source-position filename="src/as-checksum.h" line="78"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cs" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-checksum.c"
line="168">a #AsChecksum instance.</doc>
<type name="Checksum" c:type="AsChecksum*"/>
</instance-parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-checksum.c"
line="169">the new value.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<record name="ChecksumClass"
c:type="AsChecksumClass"
glib:is-gtype-struct-for="Checksum">
<source-position filename="src/as-checksum.h" line="44"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_as_reserved1" introspectable="0">
<callback name="_as_reserved1">
<source-position filename="src/as-checksum.h" line="38"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved2" introspectable="0">
<callback name="_as_reserved2">
<source-position filename="src/as-checksum.h" line="39"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved3" introspectable="0">
<callback name="_as_reserved3">
<source-position filename="src/as-checksum.h" line="40"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved4" introspectable="0">
<callback name="_as_reserved4">
<source-position filename="src/as-checksum.h" line="41"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved5" introspectable="0">
<callback name="_as_reserved5">
<source-position filename="src/as-checksum.h" line="42"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved6" introspectable="0">
<callback name="_as_reserved6">
<source-position filename="src/as-checksum.h" line="43"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
</record>
<enumeration name="ChecksumKind"
glib:type-name="AsChecksumKind"
glib:get-type="as_checksum_kind_get_type"
c:type="AsChecksumKind">
<doc xml:space="preserve"
filename="src/as-checksum.h"
line="46">Checksums supported by #AsRelease</doc>
<member name="none"
value="0"
c:identifier="AS_CHECKSUM_KIND_NONE"
glib:nick="none"
glib:name="AS_CHECKSUM_KIND_NONE">
<doc xml:space="preserve"
filename="src/as-checksum.h"
line="48">No checksum</doc>
</member>
<member name="sha1"
value="1"
c:identifier="AS_CHECKSUM_KIND_SHA1"
glib:nick="sha1"
glib:name="AS_CHECKSUM_KIND_SHA1">
<doc xml:space="preserve"
filename="src/as-checksum.h"
line="49">SHA1 checksum</doc>
</member>
<member name="sha256"
value="2"
c:identifier="AS_CHECKSUM_KIND_SHA256"
glib:nick="sha256"
glib:name="AS_CHECKSUM_KIND_SHA256">
<doc xml:space="preserve"
filename="src/as-checksum.h"
line="50">SHA256 checksum</doc>
</member>
<member name="sha512"
value="3"
c:identifier="AS_CHECKSUM_KIND_SHA512"
glib:nick="sha512"
glib:name="AS_CHECKSUM_KIND_SHA512">
<doc xml:space="preserve"
filename="src/as-checksum.h"
line="51">SHA512 checksum</doc>
</member>
<member name="blake2b"
value="4"
c:identifier="AS_CHECKSUM_KIND_BLAKE2B"
glib:nick="blake2b"
glib:name="AS_CHECKSUM_KIND_BLAKE2B">
<doc xml:space="preserve"
filename="src/as-checksum.h"
line="52">BLAKE2 checksum</doc>
</member>
<member name="blake3"
value="5"
c:identifier="AS_CHECKSUM_KIND_BLAKE3"
glib:nick="blake3"
glib:name="AS_CHECKSUM_KIND_BLAKE3">
<doc xml:space="preserve"
filename="src/as-checksum.h"
line="53">BLAKE3 checksum</doc>
</member>
<function name="from_string" c:identifier="as_checksum_kind_from_string">
<doc xml:space="preserve"
filename="src/as-checksum.c"
line="71">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-checksum.h" line="69"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-checksum.c"
line="77">a #AsChecksumKind or %AS_CHECKSUM_KIND_NONE for unknown</doc>
<type name="ChecksumKind" c:type="AsChecksumKind"/>
</return-value>
<parameters>
<parameter name="kind_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-checksum.c"
line="73">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="to_string" c:identifier="as_checksum_kind_to_string">
<doc xml:space="preserve"
filename="src/as-checksum.c"
line="45">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-checksum.h" line="68"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-checksum.c"
line="51">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-checksum.c"
line="47">the %AsChecksumKind.</doc>
<type name="ChecksumKind" c:type="AsChecksumKind"/>
</parameter>
</parameters>
</function>
</enumeration>
<enumeration name="ColorKind"
glib:type-name="AsColorKind"
glib:get-type="as_color_kind_get_type"
c:type="AsColorKind">
<doc xml:space="preserve"
filename="src/as-branding.h"
line="56">A branding color type.</doc>
<member name="unknown"
value="0"
c:identifier="AS_COLOR_KIND_UNKNOWN"
glib:nick="unknown"
glib:name="AS_COLOR_KIND_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-branding.h"
line="58">Color type invalid or not known</doc>
</member>
<member name="primary"
value="1"
c:identifier="AS_COLOR_KIND_PRIMARY"
glib:nick="primary"
glib:name="AS_COLOR_KIND_PRIMARY">
<doc xml:space="preserve"
filename="src/as-branding.h"
line="59">Primary accent color</doc>
</member>
<function name="from_string"
c:identifier="as_color_kind_from_string"
version="0.15.2">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="105">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-branding.h" line="87"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="111">a #AsColorKind or %AS_COLOR_KIND_UNKNOWN for unknown.</doc>
<type name="ColorKind" c:type="AsColorKind"/>
</return-value>
<parameters>
<parameter name="str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="107">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="to_string"
c:identifier="as_color_kind_to_string"
version="0.15.2">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="87">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-branding.h" line="86"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="93">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="89">the %AsColorKind.</doc>
<type name="ColorKind" c:type="AsColorKind"/>
</parameter>
</parameters>
</function>
</enumeration>
<enumeration name="ColorSchemeKind"
glib:type-name="AsColorSchemeKind"
glib:get-type="as_color_scheme_kind_get_type"
c:type="AsColorSchemeKind">
<doc xml:space="preserve"
filename="src/as-branding.h"
line="70">A color scheme type.</doc>
<member name="unknown"
value="0"
c:identifier="AS_COLOR_SCHEME_KIND_UNKNOWN"
glib:nick="unknown"
glib:name="AS_COLOR_SCHEME_KIND_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-branding.h"
line="72">Color scheme invalid or not known</doc>
</member>
<member name="light"
value="1"
c:identifier="AS_COLOR_SCHEME_KIND_LIGHT"
glib:nick="light"
glib:name="AS_COLOR_SCHEME_KIND_LIGHT">
<doc xml:space="preserve"
filename="src/as-branding.h"
line="73">A light color scheme</doc>
</member>
<member name="dark"
value="2"
c:identifier="AS_COLOR_SCHEME_KIND_DARK"
glib:nick="dark"
glib:name="AS_COLOR_SCHEME_KIND_DARK">
<doc xml:space="preserve"
filename="src/as-branding.h"
line="74">A dark color scheme</doc>
</member>
<function name="from_string"
c:identifier="as_color_scheme_kind_from_string"
version="0.15.2">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="143">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-branding.h" line="90"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="149">a #AsColorKind or %AS_COLOR_SCHEME_KIND_UNKNOWN for unknown.</doc>
<type name="ColorSchemeKind" c:type="AsColorSchemeKind"/>
</return-value>
<parameters>
<parameter name="str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="145">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="to_string"
c:identifier="as_color_scheme_kind_to_string"
version="0.15.2">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="123">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-branding.h" line="89"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="129">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="125">the %AsColorSchemeKind.</doc>
<type name="ColorSchemeKind" c:type="AsColorSchemeKind"/>
</parameter>
</parameters>
</function>
</enumeration>
<class name="Component"
c:symbol-prefix="component"
c:type="AsComponent"
parent="GObject.Object"
glib:type-name="AsComponent"
glib:get-type="as_component_get_type"
glib:type-struct="ComponentClass">
<source-position filename="src/as-component.h" line="66"/>
<constructor name="new" c:identifier="as_component_new">
<doc xml:space="preserve"
filename="src/as-component.c"
line="6876">Creates a new #AsComponent.</doc>
<source-position filename="src/as-component.h" line="189"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-component.c"
line="6881">a new #AsComponent</doc>
<type name="Component" c:type="AsComponent*"/>
</return-value>
</constructor>
<method name="add_addon"
c:identifier="as_component_add_addon"
version="0.9.2">
<doc xml:space="preserve"
filename="src/as-component.c"
line="806">Add a reference to the addon that is enhancing this component.</doc>
<source-position filename="src/as-component.h" line="296"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="808">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="addon" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="809">The #AsComponent that extends @cpt</doc>
<type name="Component" c:type="AsComponent*"/>
</parameter>
</parameters>
</method>
<method name="add_agreement"
c:identifier="as_component_add_agreement"
version="0.12.1">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3941">Adds an agreement to the software component.</doc>
<source-position filename="src/as-component.h" line="356"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3943">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="agreement" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3944">an #AsAgreement instance.</doc>
<type name="Agreement" c:type="AsAgreement*"/>
</parameter>
</parameters>
</method>
<method name="add_bundle"
c:identifier="as_component_add_bundle"
version="0.8.0">
<doc xml:space="preserve"
filename="src/as-component.c"
line="879">Adds a bundle to the component.</doc>
<source-position filename="src/as-component.h" line="309"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="881">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="bundle" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="882">The #AsBundle to add.</doc>
<type name="Bundle" c:type="AsBundle*"/>
</parameter>
</parameters>
</method>
<method name="add_category" c:identifier="as_component_add_category">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1704">Add a category.</doc>
<source-position filename="src/as-component.h" line="256"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1706">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="category" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1707">the categories name to add.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="add_content_rating"
c:identifier="as_component_add_content_rating"
version="0.11.0">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3544">Adds a content rating to this component.</doc>
<source-position filename="src/as-component.h" line="337"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3546">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="content_rating" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3547">a #AsContentRating instance.</doc>
<type name="ContentRating" c:type="AsContentRating*"/>
</parameter>
</parameters>
</method>
<method name="add_extends"
c:identifier="as_component_add_extends"
version="0.15.5">
<doc xml:space="preserve"
filename="src/as-component.c"
line="764">Add a reference to the extended component</doc>
<source-position filename="src/as-component.h" line="293"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="766">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="cpt_id" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="767">The id of a component which is extended by this component</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="add_icon" c:identifier="as_component_add_icon">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1677">Add an icon to this component.</doc>
<source-position filename="src/as-component.h" line="277"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1679">an #AsComponent instance</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="icon" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1680">the valid #AsIcon instance to add.</doc>
<type name="Icon" c:type="AsIcon*"/>
</parameter>
</parameters>
</method>
<method name="add_keyword" c:identifier="as_component_add_keyword">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1553">Add a new keyword to the keywords list for the given locale. This function does not
check for duplicate keywords.</doc>
<source-position filename="src/as-component.h" line="271"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1555">an #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="keyword" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1556">The new keyword to add.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="locale"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1557">BCP47 locale of the values, or %NULL to use current locale.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="add_language"
c:identifier="as_component_add_language"
version="0.7.0">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2491">Adds a language to the component.</doc>
<source-position filename="src/as-component.h" line="300"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2493">an #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="locale"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2494">the BCP47 locale, or %NULL. e.g. "en-GB"</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="percentage" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2495">the percentage completion of the translation, 0 for locales with unknown amount of translation</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="add_launchable"
c:identifier="as_component_add_launchable"
version="0.11.0">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3601">Adds a #AsLaunchable containing launchables entries for this component.</doc>
<source-position filename="src/as-component.h" line="236"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3603">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="launchable" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3604">a #AsLaunchable instance.</doc>
<type name="Launchable" c:type="AsLaunchable*"/>
</parameter>
</parameters>
</method>
<method name="add_provided"
c:identifier="as_component_add_provided"
version="0.6.2">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2293">Add a set of provided items to this component.</doc>
<source-position filename="src/as-component.h" line="280"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2295">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="prov" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2296">a #AsProvided instance.</doc>
<type name="Provided" c:type="AsProvided*"/>
</parameter>
</parameters>
</method>
<method name="add_provided_item"
c:identifier="as_component_add_provided_item">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2324">Adds a provided item to the component with the given @kind, creating a new
@AsProvided for this kind internally if necessary.</doc>
<source-position filename="src/as-component.h" line="282"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2326">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2327">the kind of the provided item (e.g. %AS_PROVIDED_KIND_MEDIATYPE)</doc>
<type name="ProvidedKind" c:type="AsProvidedKind"/>
</parameter>
<parameter name="item" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2328">the item to add.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="add_reference"
c:identifier="as_component_add_reference"
version="1.0.0">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2023">Adds an external reference to the software component.</doc>
<source-position filename="src/as-component.h" line="368"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2025">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="reference" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2026">an #AsReference instance.</doc>
<type name="Reference" c:type="AsReference*"/>
</parameter>
</parameters>
</method>
<method name="add_relation"
c:identifier="as_component_add_relation"
version="0.12.0">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3670">Adds a #AsRelation to set a recommends or requires relation of
component @cpt on the item mentioned in the #AsRelation.</doc>
<source-position filename="src/as-component.h" line="342"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3672">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="relation" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3673">a #AsRelation instance.</doc>
<type name="Relation" c:type="AsRelation*"/>
</parameter>
</parameters>
</method>
<method name="add_release" c:identifier="as_component_add_release">
<doc xml:space="preserve"
filename="src/as-component.c"
line="680">Add an #AsRelease to this component.</doc>
<source-position filename="src/as-component.h" line="290"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="682">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="release" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="683">The #AsRelease to add</doc>
<type name="Release" c:type="AsRelease*"/>
</parameter>
</parameters>
</method>
<method name="add_replaces" c:identifier="as_component_add_replaces">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3906">Add the component ID of a component that gets replaced by the current component.</doc>
<source-position filename="src/as-component.h" line="353"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3908">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="cid" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3909">an AppStream component ID</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="add_review"
c:identifier="as_component_add_review"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3485">Adds a user review to a software component.</doc>
<source-position filename="src/as-component.h" line="379"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3487">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="review" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3488">a #AsReview instance.</doc>
<type name="Review" c:type="AsReview*"/>
</parameter>
</parameters>
</method>
<method name="add_screenshot" c:identifier="as_component_add_screenshot">
<doc xml:space="preserve"
filename="src/as-component.c"
line="613">Add an #AsScreenshot to this component.</doc>
<source-position filename="src/as-component.h" line="260"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="615">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="sshot" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="616">The #AsScreenshot to add</doc>
<type name="Screenshot" c:type="AsScreenshot*"/>
</parameter>
</parameters>
</method>
<method name="add_suggested" c:identifier="as_component_add_suggested">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2353">Add an #AsSuggested to this component.</doc>
<source-position filename="src/as-component.h" line="312"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2355">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="suggested" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2356">The #AsSuggested</doc>
<type name="Suggested" c:type="AsSuggested*"/>
</parameter>
</parameters>
</method>
<method name="add_tag"
c:identifier="as_component_add_tag"
version="0.15.0">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1918">Add a tag to this component.</doc>
<source-position filename="src/as-component.h" line="363"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1926">%TRUE if the tag was added.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1920">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="ns" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1921">The namespace the tag belongs to</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="tag" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1922">The tag name</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="add_translation"
c:identifier="as_component_add_translation"
version="0.9.2">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2641">Assign an #AsTranslation object describing the translation system used
by this component.</doc>
<source-position filename="src/as-component.h" line="304"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2643">an #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="tr" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2644">an #AsTranslation instance.</doc>
<type name="Translation" c:type="AsTranslation*"/>
</parameter>
</parameters>
</method>
<method name="add_url"
c:identifier="as_component_add_url"
version="0.6.2">
<doc xml:space="preserve"
filename="src/as-component.c"
line="712">Adds some URL data to the component.</doc>
<source-position filename="src/as-component.h" line="285"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="714">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="url_kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="715">the URL kind, e.g. %AS_URL_KIND_HOMEPAGE</doc>
<type name="UrlKind" c:type="AsUrlKind"/>
</parameter>
<parameter name="url" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="716">the full URL.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="check_relations"
c:identifier="as_component_check_relations"
version="1.0.0">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3783">Verifies the respective relations and presents whether the system specified
in #AsSystemInfo @sysinfo and data from @pool supply the requested facilities.</doc>
<source-position filename="src/as-component.h" line="343"/>
<return-value transfer-ownership="container">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3793">An array of #AsRelationCheckResult</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="RelationCheckResult"/>
</array>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3785">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="sysinfo"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3786">an #AsSystemInfo to use for system information.</doc>
<type name="SystemInfo" c:type="AsSystemInfo*"/>
</parameter>
<parameter name="pool"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3787">an #AsPool to find component dependencies in.</doc>
<type name="Pool" c:type="AsPool*"/>
</parameter>
<parameter name="rel_kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3788">the kind of relations to check</doc>
<type name="RelationKind" c:type="AsRelationKind"/>
</parameter>
</parameters>
</method>
<method name="clear_keywords" c:identifier="as_component_clear_keywords">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1584">Remove all keywords for the given locale.</doc>
<source-position filename="src/as-component.h" line="272"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1586">an #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="locale"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1587">BCP47 locale of the values, or %NULL to use current locale.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="clear_languages"
c:identifier="as_component_clear_languages"
version="0.14.5">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2554">Remove all registered language translation information.</doc>
<source-position filename="src/as-component.h" line="301"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2556">an #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="clear_tags"
c:identifier="as_component_clear_tags"
version="0.15.0">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1903">Remove all tags associated with this component.</doc>
<source-position filename="src/as-component.h" line="362"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1905">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_addons"
c:identifier="as_component_get_addons"
version="0.9.2">
<doc xml:space="preserve"
filename="src/as-component.c"
line="786">Returns a list of #AsComponent objects which
are addons extending this component in functionality.
This is the reverse of %as_component_get_extends()</doc>
<source-position filename="src/as-component.h" line="295"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="795">An array of #AsComponent.</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="Component"/>
</array>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="788">an #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_agreement_by_kind"
c:identifier="as_component_get_agreement_by_kind"
version="0.12.1">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3957">Gets an agreement the component has specified for the particular kind.</doc>
<source-position filename="src/as-component.h" line="357"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3964">a #AsAgreement or %NULL for not found</doc>
<type name="Agreement" c:type="AsAgreement*"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3959">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3960">an agreement kind, e.g. %AS_AGREEMENT_KIND_EULA</doc>
<type name="AgreementKind" c:type="AsAgreementKind"/>
</parameter>
</parameters>
</method>
<method name="get_agreements"
c:identifier="as_component_get_agreements"
version="0.15.0">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3924">Get a list of all agreements registered with this software component.</doc>
<source-position filename="src/as-component.h" line="355"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3930">An array of #AsAgreement.</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="Agreement"/>
</array>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3926">an #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_branch"
c:identifier="as_component_get_branch"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1255">Gets the branch for the application.</doc>
<source-position filename="src/as-component.h" line="211"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1261">string, or %NULL if unset</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1257">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_branding"
c:identifier="as_component_get_branding"
version="0.15.2">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3982">Get the branding associated with this component, or %NULL
in case this component has no special branding.</doc>
<source-position filename="src/as-component.h" line="359"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3989">An #AsBranding.</doc>
<type name="Branding" c:type="AsBranding*"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3984">an #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_bundle"
c:identifier="as_component_get_bundle"
version="0.8.0">
<doc xml:space="preserve"
filename="src/as-component.c"
line="853">Gets a bundle identifier string.</doc>
<source-position filename="src/as-component.h" line="308"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="src/as-component.c"
line="860">An #AsBundle, or %NULL if not set.</doc>
<type name="Bundle" c:type="AsBundle*"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="855">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="bundle_kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="856">the bundle kind, e.g. %AS_BUNDLE_KIND_LIMBA.</doc>
<type name="BundleKind" c:type="AsBundleKind"/>
</parameter>
</parameters>
</method>
<method name="get_bundles"
c:identifier="as_component_get_bundles"
version="0.10">
<doc xml:space="preserve"
filename="src/as-component.c"
line="822">Get a list of all software bundles associated with this component.</doc>
<source-position filename="src/as-component.h" line="307"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="828">A list of #AsBundle.</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="Bundle"/>
</array>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="824">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_categories"
c:identifier="as_component_get_categories"
glib:get-property="categories">
<source-position filename="src/as-component.h" line="255"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1695">String array of categories</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="utf8"/>
</array>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1693">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_compulsory_for_desktops"
c:identifier="as_component_get_compulsory_for_desktops">
<source-position filename="src/as-component.h" line="251"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2208">A list of desktops where this component is compulsory</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="utf8"/>
</array>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2206">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_content_rating"
c:identifier="as_component_get_content_rating"
version="0.11.0">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3518">Gets a content ratings of a specific type that are defined for this component.</doc>
<source-position filename="src/as-component.h" line="336"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3525">a #AsContentRating or %NULL if not found</doc>
<type name="ContentRating" c:type="AsContentRating*"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3520">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3521">a ratings kind, e.g. "oars-1.0"</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="get_content_ratings"
c:identifier="as_component_get_content_ratings"
version="0.11.0">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3501">Gets all content ratings defined for this software.</doc>
<source-position filename="src/as-component.h" line="335"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3507">an array</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="ContentRating"/>
</array>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3503">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_context"
c:identifier="as_component_get_context"
version="0.11.2">
<doc xml:space="preserve"
filename="src/as-component.c"
line="4020">Get the #AsContext associated with this component.
This function may return %NULL if no context is set
(which will be the case if the component was not loaded from
a file or cache but constructed in memory).</doc>
<source-position filename="src/as-component.h" line="191"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="src/as-component.c"
line="4029">the associated #AsContext or %NULL</doc>
<type name="Context" c:type="AsContext*"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="4022">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_custom"
c:identifier="as_component_get_custom"
version="0.10.5">
<source-position filename="src/as-component.h" line="331"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3416">Hash table of custom user defined data fields.</doc>
<type name="GLib.HashTable" c:type="GHashTable*">
<type name="gpointer" c:type="gpointer"/>
<type name="gpointer" c:type="gpointer"/>
</type>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3414">An #AsComponent.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_custom_value"
c:identifier="as_component_get_custom_value"
version="0.10.5">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3427">Retrieve value for a custom data entry with the given key.</doc>
<source-position filename="src/as-component.h" line="332"/>
<return-value transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3429">An #AsComponent.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="key" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3430">Field name.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="get_data_id" c:identifier="as_component_get_data_id">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1185">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</doc>
<source-position filename="src/as-component.h" line="198"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1200">the unique session-specific identifier.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1187">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_date_eol"
c:identifier="as_component_get_date_eol"
version="0.15.2">
<doc xml:space="preserve"
filename="src/as-component.c"
line="965">Gets the end-of-life date for the entire component.</doc>
<source-position filename="src/as-component.h" line="204"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="971">The EOL date as string in ISO8601 format.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="967">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_description"
c:identifier="as_component_get_description"
glib:get-property="description">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1435">Get the localized long description of this component.</doc>
<source-position filename="src/as-component.h" line="231"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1441">the description.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1437">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_developer" c:identifier="as_component_get_developer">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1828">Get information about the component's developer or development team.
The returned object may be empty if no developer information was
available.</doc>
<source-position filename="src/as-component.h" line="248"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1836">the developer as #AsDeveloper.</doc>
<type name="Developer" c:type="AsDeveloper*"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1830">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_extends"
c:identifier="as_component_get_extends"
version="0.15.5">
<doc xml:space="preserve"
filename="src/as-component.c"
line="729">Returns a string list of IDs of components which
are extended by this addon.
See %as_component_get_extends() for the reverse.</doc>
<source-position filename="src/as-component.h" line="292"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="src/as-component.c"
line="738">A #GPtrArray or %NULL if not set.</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="utf8"/>
</array>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="731">an #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_icon_by_size"
c:identifier="as_component_get_icon_by_size">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1617">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.</doc>
<source-position filename="src/as-component.h" line="275"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1632">An icon matching the given width/height, or %NULL if not found.</doc>
<type name="Icon" c:type="AsIcon*"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1619">an #AsComponent instance</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1620">The icon width in pixels.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1621">the icon height in pixels.</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="get_icon_stock" c:identifier="as_component_get_icon_stock">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1653">Gets a stock icon for this component if one is associated with it.
Will return %NULL otherwise.</doc>
<source-position filename="src/as-component.h" line="276"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1660">An stock icon, or %NULL if none found.</doc>
<type name="Icon" c:type="AsIcon*"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1655">an #AsComponent instance</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_icons"
c:identifier="as_component_get_icons"
glib:get-property="icons">
<source-position filename="src/as-component.h" line="274"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1608">A #GPtrArray of all icons for this component.</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="Icon"/>
</array>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1606">an #AsComponent instance</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_id"
c:identifier="as_component_get_id"
glib:get-property="id">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1148">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()</doc>
<source-position filename="src/as-component.h" line="195"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1159">the unique AppStream identifier.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1150">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_keywords"
c:identifier="as_component_get_keywords"
glib:get-property="keywords">
<source-position filename="src/as-component.h" line="266"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1473">String array of keywords</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="utf8"/>
</array>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1471">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_keywords_table"
c:identifier="as_component_get_keywords_table">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1498">Retrieve the internal hash table mapping languages to
keword arrays.</doc>
<source-position filename="src/as-component.h" line="383"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1505">Hash table locale->keyword arrays</doc>
<type name="GLib.HashTable" c:type="GHashTable*">
<type name="gpointer" c:type="gpointer"/>
<type name="gpointer" c:type="gpointer"/>
</type>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1500">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_kind"
c:identifier="as_component_get_kind"
glib:get-property="kind">
<doc xml:space="preserve"
filename="src/as-component.c"
line="934">Returns the #AsComponentKind of this component.</doc>
<source-position filename="src/as-component.h" line="201"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="940">the kind of #this.</doc>
<type name="ComponentKind" c:type="AsComponentKind"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="936">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_language"
c:identifier="as_component_get_language"
version="0.7.0">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2511">Gets the translation coverage in percent for a specific locale</doc>
<source-position filename="src/as-component.h" line="299"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2518">a percentage value, -1 if locale was not found</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2513">an #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="locale"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2514">the BCP47 locale, or %NULL. e.g. "en-GB"</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="get_languages"
c:identifier="as_component_get_languages"
version="0.7.0">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2537">Get a list of all languages.</doc>
<source-position filename="src/as-component.h" line="298"/>
<return-value transfer-ownership="container">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2543">list of locales</doc>
<type name="GLib.List" c:type="GList*">
<type name="utf8"/>
</type>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2539">an #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_launchable"
c:identifier="as_component_get_launchable"
version="0.11.0">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3560">Gets a #AsLaunchable of a specific type that contains launchable entries for
this component.</doc>
<source-position filename="src/as-component.h" line="235"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3568">a #AsLaunchable or %NULL if not found</doc>
<type name="Launchable" c:type="AsLaunchable*"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3562">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3563">a launch kind, e.g. %AS_LAUNCHABLE_KIND_DESKTOP_ID</doc>
<type name="LaunchableKind" c:type="AsLaunchableKind"/>
</parameter>
</parameters>
</method>
<method name="get_launchables"
c:identifier="as_component_get_launchables"
version="0.11.0">
<source-position filename="src/as-component.h" line="234"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3590">an array</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="Launchable"/>
</array>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3588">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_merge_kind"
c:identifier="as_component_get_merge_kind"
version="0.9.8">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2382">Get the merge method which should apply to duplicate components
with this ID.</doc>
<source-position filename="src/as-component.h" line="318"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2389">the #AsMergeKind of this component.</doc>
<type name="MergeKind" c:type="AsMergeKind"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2384">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_metadata_license"
c:identifier="as_component_get_metadata_license">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1740">The license the metadata iself is subjected to.</doc>
<source-position filename="src/as-component.h" line="238"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1746">the license.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1742">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_name"
c:identifier="as_component_get_name"
glib:get-property="name">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1369">A human-readable name for this component.</doc>
<source-position filename="src/as-component.h" line="225"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1375">the name.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1371">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_name_table" c:identifier="as_component_get_name_table">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2586">Get the internal locale to component name
mapping table.</doc>
<source-position filename="src/as-component.h" line="381"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2593">locale->names map</doc>
<type name="GLib.HashTable" c:type="GHashTable*">
<type name="gpointer" c:type="gpointer"/>
<type name="gpointer" c:type="gpointer"/>
</type>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2588">an #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_name_variant_suffix"
c:identifier="as_component_get_name_variant_suffix"
version="0.12.10">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2039">Get variant suffix for the component name
(only to be displayed if two components have the same name).</doc>
<source-position filename="src/as-component.h" line="370"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2046">the variant suffix</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2041">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_origin" c:identifier="as_component_get_origin">
<source-position filename="src/as-component.h" line="208"/>
<return-value transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1231">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_pkgname" c:identifier="as_component_get_pkgname">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1060">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.</doc>
<source-position filename="src/as-component.h" line="217"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1073">String array of package names</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1062">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_pkgnames"
c:identifier="as_component_get_pkgnames"
glib:get-property="pkgnames">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1044">Get a list of package names which this component consists of.
This usually is just one package name.</doc>
<source-position filename="src/as-component.h" line="219"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1051">String array of package names</doc>
<array c:type="gchar**">
<type name="utf8"/>
</array>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1046">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_priority"
c:identifier="as_component_get_priority"
version="0.6.1">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2416">Returns the priority of this component.
This method is used internally.</doc>
<source-position filename="src/as-component.h" line="328"/>
<return-value transfer-ownership="none">
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2418">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_project_group"
c:identifier="as_component_get_project_group"
glib:get-property="project-group">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1799">Get the component's project group.</doc>
<source-position filename="src/as-component.h" line="245"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1805">the project group.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1801">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_project_license"
c:identifier="as_component_get_project_license"
glib:get-property="project-license">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1769">Get the license of the project this component belongs to.</doc>
<source-position filename="src/as-component.h" line="241"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1775">the license.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1771">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_provided" c:identifier="as_component_get_provided">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2278">Get a list of #AsProvided objects associated with this component.</doc>
<source-position filename="src/as-component.h" line="279"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2284">A list of #AsProvided objects.</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="Provided"/>
</array>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2280">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_provided_for_kind"
c:identifier="as_component_get_provided_for_kind">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2254">Get an #AsProvided object for the given interface type,
containing information about the public interfaces (mimetypes, firmware, DBus services, ...)
this component provides.</doc>
<source-position filename="src/as-component.h" line="281"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2263">#AsProvided containing the items this component provides, or %NULL.</doc>
<type name="Provided" c:type="AsProvided*"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2256">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2257">kind of the provided item, e.g. %AS_PROVIDED_KIND_MEDIATYPE</doc>
<type name="ProvidedKind" c:type="AsProvidedKind"/>
</parameter>
</parameters>
</method>
<method name="get_recommends"
c:identifier="as_component_get_recommends"
version="0.12.0">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3635">Get an array of items that are recommended by this component.</doc>
<source-position filename="src/as-component.h" line="340"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3641">an array</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="Relation"/>
</array>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3637">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_references"
c:identifier="as_component_get_references"
version="1.0.0">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2006">Get a list of external references and citation information for this component.</doc>
<source-position filename="src/as-component.h" line="367"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2012">An array of #AsReference.</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="Reference"/>
</array>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2008">an #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_releases_plain"
c:identifier="as_component_get_releases_plain">
<doc xml:space="preserve"
filename="src/as-component.c"
line="629">Get release information for this component,
without downloading or loading any data from external sources.</doc>
<source-position filename="src/as-component.h" line="288"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="636">Release information as #AsReleaseList</doc>
<type name="ReleaseList" c:type="AsReleaseList*"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="631">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_replaces" c:identifier="as_component_get_replaces">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3889">Get a list of component IDs of components that this software replaces entirely.</doc>
<source-position filename="src/as-component.h" line="352"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3895">an array of component-IDs</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="utf8"/>
</array>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3891">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_requires"
c:identifier="as_component_get_requires"
version="0.12.0">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3618">Get an array of items that are required by this component.</doc>
<source-position filename="src/as-component.h" line="339"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3624">an array</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="Relation"/>
</array>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3620">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_reviews"
c:identifier="as_component_get_reviews"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3468">Gets any reviews associated with the component.</doc>
<source-position filename="src/as-component.h" line="378"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3474">an array</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="Review"/>
</array>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3470">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_scope"
c:identifier="as_component_get_scope"
version="0.10.2">
<source-position filename="src/as-component.h" line="214"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2664">the #AsComponentScope of this component.</doc>
<type name="ComponentScope" c:type="AsComponentScope"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2662">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_screenshots_all"
c:identifier="as_component_get_screenshots_all">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2085">Get a list of all associated screenshots, for all environments.</doc>
<source-position filename="src/as-component.h" line="259"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2091">an array of #AsScreenshot instances</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="Screenshot"/>
</array>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2087">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_search_tokens"
c:identifier="as_component_get_search_tokens"
version="0.9.7">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3313">Returns all search tokens for this component.</doc>
<source-position filename="src/as-component.h" line="314"/>
<return-value transfer-ownership="container">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3319">The string search tokens</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="utf8"/>
</array>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3315">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_sort_score"
c:identifier="as_component_get_sort_score"
version="0.12.11">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2449">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.</doc>
<source-position filename="src/as-component.h" line="375"/>
<return-value transfer-ownership="none">
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2451">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_source_pkgname"
c:identifier="as_component_get_source_pkgname">
<source-position filename="src/as-component.h" line="222"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1127">the source package name.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1125">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_suggested" c:identifier="as_component_get_suggested">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2367">Get a list of associated suggestions.</doc>
<source-position filename="src/as-component.h" line="311"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2373">an array of #AsSuggested instances</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="Suggested"/>
</array>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2369">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_summary"
c:identifier="as_component_get_summary"
glib:get-property="summary">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1401">Get a short description of this component.</doc>
<source-position filename="src/as-component.h" line="228"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1407">the summary.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1403">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_summary_table"
c:identifier="as_component_get_summary_table">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2602">Get the internal locale to component summary
mapping table.</doc>
<source-position filename="src/as-component.h" line="382"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2609">locale->summary map</doc>
<type name="GLib.HashTable" c:type="GHashTable*">
<type name="gpointer" c:type="gpointer"/>
<type name="gpointer" c:type="gpointer"/>
</type>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2604">an #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_supports"
c:identifier="as_component_get_supports"
version="0.15.0">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3652">Get an array of items that are supported by this component,
e.g. to indicate support for a specific piece of hardware.</doc>
<source-position filename="src/as-component.h" line="341"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3659">an array</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="Relation"/>
</array>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3654">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_system_compatibility_score"
c:identifier="as_component_get_system_compatibility_score">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3834">Return a score between 0 and 100 determining how compatible the component
is with the system configuration provided as parameter.
0 means the componsnt will not work at all, while 100 is best compatibility.</doc>
<source-position filename="src/as-component.h" line="347"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3846">a compatibility score between 0 and 100</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3836">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="sysinfo" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3837">an #AsSystemInfo to use for system information.</doc>
<type name="SystemInfo" c:type="AsSystemInfo*"/>
</parameter>
<parameter name="is_template" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3838">if %TRUE, treat system info as neutral template, ignoring any peripheral devices or kernel relations.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
<parameter name="results"
direction="out"
caller-allocates="0"
transfer-ownership="container"
optional="1"
allow-none="1">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3839">Receive the resulting check results</doc>
<array name="GLib.PtrArray" c:type="GPtrArray**">
<type name="RelationCheckResult"/>
</array>
</parameter>
</parameters>
</method>
<method name="get_timestamp_eol"
c:identifier="as_component_get_timestamp_eol"
version="0.15.2">
<doc xml:space="preserve"
filename="src/as-component.c"
line="998">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.</doc>
<source-position filename="src/as-component.h" line="206"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1006">UNIX timestamp, or 0 for unset or invalid.</doc>
<type name="guint64" c:type="guint64"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1000">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_translations"
c:identifier="as_component_get_translations"
version="0.9.2">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2618">Get a #GPtrArray of #AsTranslation objects describing the
translation systems and translation-ids (e.g. Gettext domains) used
by this software component.
Only set for metainfo files.</doc>
<source-position filename="src/as-component.h" line="303"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2628">An array of #AsTranslation objects.</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="Translation"/>
</array>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2620">an #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_url"
c:identifier="as_component_get_url"
version="0.6.2">
<doc xml:space="preserve"
filename="src/as-component.c"
line="694">Gets a URL.</doc>
<source-position filename="src/as-component.h" line="284"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="src/as-component.c"
line="701">string, or %NULL if unset</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="696">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="url_kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="697">the URL kind, e.g. %AS_URL_KIND_HOMEPAGE.</doc>
<type name="UrlKind" c:type="AsUrlKind"/>
</parameter>
</parameters>
</method>
<method name="has_bundle" c:identifier="as_component_has_bundle">
<source-position filename="src/as-component.h" line="306"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="900">%TRUE if this component has a bundle associated.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="898">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="has_category" c:identifier="as_component_has_category">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1724">Check if component is in the specified category.</doc>
<source-position filename="src/as-component.h" line="257"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1731">%TRUE if the component is in the specified category.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1726">an #AsComponent object</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="category" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1727">the specified category to check</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="has_tag"
c:identifier="as_component_has_tag"
version="0.15.0">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1979">Test if the component is tagged with the selected
tag.</doc>
<source-position filename="src/as-component.h" line="365"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1988">%TRUE if tag exists.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1981">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="ns" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1982">The namespace the tag belongs to</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="tag" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1983">The tag name</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="insert_custom_value"
c:identifier="as_component_insert_custom_value"
version="0.10.5">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3445">Add a key and value pair to the custom data table.</doc>
<source-position filename="src/as-component.h" line="333"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3453">%TRUE if the key did not exist yet.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3447">An #AsComponent.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="key" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3448">Key name.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3449">A string value.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="is_compulsory_for_desktop"
c:identifier="as_component_is_compulsory_for_desktop">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2238">Check if this component is compulsory for the given desktop.</doc>
<source-position filename="src/as-component.h" line="253"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2245">%TRUE if compulsory, %FALSE otherwise.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2240">an #AsComponent object</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="desktop" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2241">the desktop-id to test for</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="is_floss"
c:identifier="as_component_is_floss"
version="0.15.5">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1866">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.</doc>
<source-position filename="src/as-component.h" line="243"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1875">%TRUE if this component is free software.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1868">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="is_ignored"
c:identifier="as_component_is_ignored"
version="0.10.2">
<source-position filename="src/as-component.h" line="323"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3401">Whether this component's metadata should be ignored.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3399">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="is_member_of_category"
c:identifier="as_component_is_member_of_category">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3360">Test if the component @cpt is a member of category @category.</doc>
<source-position filename="src/as-component.h" line="321"/>
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3362">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="category" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3363">The category to test.</doc>
<type name="Category" c:type="AsCategory*"/>
</parameter>
</parameters>
</method>
<method name="is_valid" c:identifier="as_component_is_valid">
<doc xml:space="preserve"
filename="src/as-component.c"
line="548">Check if the essential properties of this Component are
populated with useful data.</doc>
<source-position filename="src/as-component.h" line="325"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="555">TRUE if the component data was validated successfully.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="550">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="load_from_bytes"
c:identifier="as_component_load_from_bytes"
version="0.14.0"
throws="1">
<doc xml:space="preserve"
filename="src/as-component.c"
line="6465">Load metadata for this component from an XML string.
You normally do not want to use this method directly and instead use the more
convenient API of #AsMetadata to create and update components.
If this function returns %TRUE, a valid component is returned unless the selected
format was %AS_FORMAT_KIND_DESKTOP_ENTRY, in which case a component ID will have to
be set explicitly by the caller in order to make the component valid.</doc>
<source-position filename="src/as-component.h" line="385"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="6481">%TRUE on success.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="6467">an #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="context" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="6468">an #AsContext instance.</doc>
<type name="Context" c:type="AsContext*"/>
</parameter>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="6469">the format of the data to load, e.g. %AS_FORMAT_KIND_XML</doc>
<type name="FormatKind" c:type="AsFormatKind"/>
</parameter>
<parameter name="bytes" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="6470">the data to load.</doc>
<type name="GLib.Bytes" c:type="GBytes*"/>
</parameter>
</parameters>
</method>
<method name="load_releases"
c:identifier="as_component_load_releases"
throws="1">
<doc xml:space="preserve"
filename="src/as-component.c"
line="645">Get release information for this component, download it
if necessary.</doc>
<source-position filename="src/as-component.h" line="287"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="src/as-component.c"
line="652">Release information as #AsReleaseList, or %NULL if loading failed.</doc>
<type name="ReleaseList" c:type="AsReleaseList*"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="647">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="allow_net" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="remove_tag"
c:identifier="as_component_remove_tag"
version="0.15.0">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1950">Remove a tag from this component</doc>
<source-position filename="src/as-component.h" line="364"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1958">%TRUE if the tag was removed.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1952">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="ns" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1953">The namespace the tag belongs to</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="tag" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1954">The tag name</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="search_matches"
c:identifier="as_component_search_matches"
version="0.9.7">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3225">Searches component data for a specific keyword.</doc>
<source-position filename="src/as-component.h" line="315"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3232">a match scrore, where 0 is no match and 100 is the best match.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3227">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="term" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3228">the search term.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="search_matches_all"
c:identifier="as_component_search_matches_all"
version="0.9.8">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3270">Searches component data for all the specific keywords.</doc>
<source-position filename="src/as-component.h" line="316"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3277">a match score, where 0 is no match and larger numbers are better
matches.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3272">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="terms" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="3273">the search terms.</doc>
<type name="utf8" c:type="gchar**"/>
</parameter>
</parameters>
</method>
<method name="set_branch"
c:identifier="as_component_set_branch"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1272">Set the branch that the component instance was sourced from.</doc>
<source-position filename="src/as-component.h" line="212"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1274">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="branch" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1275">the branch, e.g. "master" or "3-16".</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_branding"
c:identifier="as_component_set_branding"
version="0.15.2">
<doc xml:space="preserve"
filename="src/as-component.c"
line="4000">Set branding for this component.</doc>
<source-position filename="src/as-component.h" line="360"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="4002">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="branding" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="4003">an #AsBranding instance.</doc>
<type name="Branding" c:type="AsBranding*"/>
</parameter>
</parameters>
</method>
<method name="set_compulsory_for_desktop"
c:identifier="as_component_set_compulsory_for_desktop">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2217">Mark this component to be compulsory for the specified desktop environment.</doc>
<source-position filename="src/as-component.h" line="252"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2219">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="desktop" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2220">The name of the desktop.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_context"
c:identifier="as_component_set_context"
version="0.11.2">
<doc xml:space="preserve"
filename="src/as-component.c"
line="4040">Sets the document context this component is associated
with.</doc>
<source-position filename="src/as-component.h" line="192"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="4042">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="context" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="4043">the #AsContext.</doc>
<type name="Context" c:type="AsContext*"/>
</parameter>
</parameters>
</method>
<method name="set_context_locale"
c:identifier="as_component_set_context_locale">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1316">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 #AsContext management.</doc>
<source-position filename="src/as-component.h" line="193"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1318">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="locale" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1319">the new locale.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_data_id" c:identifier="as_component_set_data_id">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1211">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.</doc>
<source-position filename="src/as-component.h" line="199"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1213">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1214">the unique session-specific identifier.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_date_eol"
c:identifier="as_component_set_date_eol"
version="0.15.2">
<doc xml:space="preserve"
filename="src/as-component.c"
line="982">Sets an end-of-life date for this component.</doc>
<source-position filename="src/as-component.h" line="205"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="984">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="date" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="985">the EOL date in ISO8601 format.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_description"
c:identifier="as_component_set_description"
glib:set-property="description">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1452">Set long description for this component.</doc>
<source-position filename="src/as-component.h" line="232"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1454">A valid #AsComponent</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1455">The long description</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="locale"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1456">The BCP47 locale for this value, or %NULL to use the current active one.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_developer" c:identifier="as_component_set_developer">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1847">Set the the component's developer.</doc>
<source-position filename="src/as-component.h" line="249"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1849">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="developer" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1850">the new #AsDeveloper</doc>
<type name="Developer" c:type="AsDeveloper*"/>
</parameter>
</parameters>
</method>
<method name="set_id"
c:identifier="as_component_set_id"
glib:set-property="id">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1168">Set the AppStream identifier for this component.</doc>
<source-position filename="src/as-component.h" line="196"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1170">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1171">the unique identifier.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_keywords"
c:identifier="as_component_set_keywords"
glib:set-property="keywords">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1514">Set keywords for this component, replacing all existing ones for the selected locale.</doc>
<source-position filename="src/as-component.h" line="267"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1516">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="new_keywords" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1517">Array of keywords</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="utf8"/>
</array>
</parameter>
<parameter name="locale"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1518">BCP47 locale of the values, or %NULL to use current locale.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="deep_copy" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1519">Set to %TRUE if the keywords array should be copied, %FALSE to set by reference.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_kind"
c:identifier="as_component_set_kind"
glib:set-property="kind">
<doc xml:space="preserve"
filename="src/as-component.c"
line="949">Sets the #AsComponentKind of this component.</doc>
<source-position filename="src/as-component.h" line="202"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="951">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="952">the #AsComponentKind.</doc>
<type name="ComponentKind" c:type="AsComponentKind"/>
</parameter>
</parameters>
</method>
<method name="set_merge_kind"
c:identifier="as_component_set_merge_kind"
version="0.9.8">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2400">Sets the #AsMergeKind for this component.</doc>
<source-position filename="src/as-component.h" line="319"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2402">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2403">the #AsMergeKind.</doc>
<type name="MergeKind" c:type="AsMergeKind"/>
</parameter>
</parameters>
</method>
<method name="set_metadata_license"
c:identifier="as_component_set_metadata_license">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1755">Set the license this metadata is licensed under.</doc>
<source-position filename="src/as-component.h" line="239"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1757">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1758">the metadata license.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_name"
c:identifier="as_component_set_name"
glib:set-property="name">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1384">Set a human-readable name for this component.</doc>
<source-position filename="src/as-component.h" line="226"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1386">A valid #AsComponent</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1387">The name</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="locale"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1388">The BCP47 locale for this value, or %NULL to use the current active one.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_name_variant_suffix"
c:identifier="as_component_set_name_variant_suffix"
version="0.12.10">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2061">Set a variant suffix for the component name
(only to be displayed if components have the same name).</doc>
<source-position filename="src/as-component.h" line="371"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2063">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2064">the developer or developer team name</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="locale"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2065">the BCP47 locale, or %NULL. e.g. "en-GB"</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_origin" c:identifier="as_component_set_origin">
<source-position filename="src/as-component.h" line="209"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1244">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="origin" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1245">the origin.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_pkgname"
c:identifier="as_component_set_pkgname"
version="0.14.5">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1104">Set the package name that provides this component.</doc>
<source-position filename="src/as-component.h" line="218"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1106">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="pkgname" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1107">the package name</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_pkgnames"
c:identifier="as_component_set_pkgnames"
glib:set-property="pkgnames">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1084">Set a list of package names this component consists of.
(This should usually be just one package name)</doc>
<source-position filename="src/as-component.h" line="220"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1086">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="packages" transfer-ownership="none">
<array c:type="gchar**">
<type name="utf8" c:type="gchar*"/>
</array>
</parameter>
</parameters>
</method>
<method name="set_priority"
c:identifier="as_component_set_priority"
version="0.6.1">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2432">Sets the priority of this component.
This method is used internally.</doc>
<source-position filename="src/as-component.h" line="329"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2434">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="priority" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2435">the given priority</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="set_project_group"
c:identifier="as_component_set_project_group"
glib:set-property="project-group">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1814">Set the component's project group.</doc>
<source-position filename="src/as-component.h" line="246"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1816">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1817">the project group.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_project_license"
c:identifier="as_component_set_project_license"
glib:set-property="project-license">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1784">Set the project license.</doc>
<source-position filename="src/as-component.h" line="242"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1786">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1787">the project license.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_releases" c:identifier="as_component_set_releases">
<doc xml:space="preserve"
filename="src/as-component.c"
line="664">Set a new set of releases for this component.</doc>
<source-position filename="src/as-component.h" line="289"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="666">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="releases" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="667">the #AsReleaseList to use.</doc>
<type name="ReleaseList" c:type="AsReleaseList*"/>
</parameter>
</parameters>
</method>
<method name="set_scope" c:identifier="as_component_set_scope">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2675">Sets the #AsComponentScope of this component.</doc>
<source-position filename="src/as-component.h" line="215"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2677">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="scope" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2678">the #AsComponentKind.</doc>
<type name="ComponentScope" c:type="AsComponentScope"/>
</parameter>
</parameters>
</method>
<method name="set_sort_score"
c:identifier="as_component_set_sort_score"
version="0.9.8">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2475">Sets the sorting score of this component.</doc>
<source-position filename="src/as-component.h" line="376"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2477">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="score" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2478">the given sorting score</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="set_source_pkgname"
c:identifier="as_component_set_source_pkgname">
<source-position filename="src/as-component.h" line="223"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1138">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="spkgname" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1139">the source package name.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_summary"
c:identifier="as_component_set_summary"
glib:set-property="summary">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1418">Set a short description for this component.</doc>
<source-position filename="src/as-component.h" line="229"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1420">A valid #AsComponent</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1421">The summary</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="locale"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="src/as-component.c"
line="1422">The BCP47 locale for this value, or %NULL to use the current active one.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="sort_screenshots"
c:identifier="as_component_sort_screenshots">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2145">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.</doc>
<source-position filename="src/as-component.h" line="261"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2147">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="environment"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2148">a GUI environment string, e.g. "plasma" or "gnome"</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="style"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2149">and environment style string, e.g. "light" or "dark"</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="prioritize_style" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="2150">if %TRUE, order screenshots of the given style earlier than ones of the given environment.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="to_string" c:identifier="as_component_to_string">
<doc xml:space="preserve"
filename="src/as-component.c"
line="582">Returns a string identifying this component.
(useful for debugging)</doc>
<source-position filename="src/as-component.h" line="326"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-component.c"
line="589">A descriptive string</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="584">a #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
</parameters>
</method>
<method name="to_xml_data"
c:identifier="as_component_to_xml_data"
version="0.12.10"
throws="1">
<doc xml:space="preserve"
filename="src/as-component.c"
line="6554">Serialize this component into an XML string.
You normally do not want to use this method directly and instead use the more
convenient API of #AsMetadata to serialize components.</doc>
<source-position filename="src/as-component.h" line="390"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-component.c"
line="6564">%TRUE on success.</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<instance-parameter name="cpt" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="6556">an #AsComponent instance.</doc>
<type name="Component" c:type="AsComponent*"/>
</instance-parameter>
<parameter name="context" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="6557">an #AsContext instance.</doc>
<type name="Context" c:type="AsContext*"/>
</parameter>
</parameters>
</method>
<property name="categories"
transfer-ownership="none"
getter="get_categories">
<doc xml:space="preserve"
filename="src/as-component.c"
line="6817">string array of categories</doc>
<array name="GLib.PtrArray">
<type name="gpointer" c:type="gpointer"/>
</array>
</property>
<property name="description"
writable="1"
transfer-ownership="none"
setter="set_description"
getter="get_description"
default-value="NULL">
<doc xml:space="preserve"
filename="src/as-component.c"
line="6762">the description</doc>
<type name="utf8" c:type="gchar*"/>
</property>
<property name="icons" transfer-ownership="none" getter="get_icons">
<doc xml:space="preserve"
filename="src/as-component.c"
line="6790">hash map of icon urls and sizes</doc>
<type name="GLib.List" c:type="gpointer">
<type name="Icon"/>
</type>
</property>
<property name="id"
writable="1"
transfer-ownership="none"
setter="set_id"
getter="get_id"
default-value="NULL">
<doc xml:space="preserve"
filename="src/as-component.c"
line="6720">the unique identifier</doc>
<type name="utf8" c:type="gchar*"/>
</property>
<property name="keywords"
writable="1"
transfer-ownership="none"
setter="set_keywords"
getter="get_keywords">
<doc xml:space="preserve"
filename="src/as-component.c"
line="6776">string array of keywords</doc>
<array>
<type name="utf8"/>
</array>
</property>
<property name="kind"
writable="1"
transfer-ownership="none"
setter="set_kind"
getter="get_kind"
default-value="AS_COMPONENT_KIND_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-component.c"
line="6691">the #AsComponentKind of this component</doc>
<type name="ComponentKind"/>
</property>
<property name="name"
writable="1"
transfer-ownership="none"
setter="set_name"
getter="get_name"
default-value="NULL">
<doc xml:space="preserve"
filename="src/as-component.c"
line="6734">the name</doc>
<type name="utf8" c:type="gchar*"/>
</property>
<property name="pkgnames"
writable="1"
transfer-ownership="none"
setter="set_pkgnames"
getter="get_pkgnames">
<doc xml:space="preserve"
filename="src/as-component.c"
line="6706">string array of packages name</doc>
<array>
<type name="utf8"/>
</array>
</property>
<property name="project-group"
writable="1"
transfer-ownership="none"
setter="set_project_group"
getter="get_project_group"
default-value="NULL">
<doc xml:space="preserve"
filename="src/as-component.c"
line="6845">the project group</doc>
<type name="utf8" c:type="gchar*"/>
</property>
<property name="project-license"
writable="1"
transfer-ownership="none"
setter="set_project_license"
getter="get_project_license"
default-value="NULL">
<doc xml:space="preserve"
filename="src/as-component.c"
line="6831">the project license</doc>
<type name="utf8" c:type="gchar*"/>
</property>
<property name="screenshots" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="6860">An array of #AsScreenshot instances</doc>
<array name="GLib.PtrArray">
<type name="Screenshot"/>
</array>
</property>
<property name="summary"
writable="1"
transfer-ownership="none"
setter="set_summary"
getter="get_summary"
default-value="NULL">
<doc xml:space="preserve"
filename="src/as-component.c"
line="6748">the summary</doc>
<type name="utf8" c:type="gchar*"/>
</property>
<property name="urls" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="6803">the urls associated with this component</doc>
<type name="GLib.HashTable">
<type name="UrlKind"/>
<type name="utf8"/>
</type>
</property>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<class name="ComponentBox"
c:symbol-prefix="component_box"
c:type="AsComponentBox"
parent="GObject.Object"
glib:type-name="AsComponentBox"
glib:get-type="as_component_box_get_type"
glib:type-struct="ComponentBoxClass">
<source-position filename="src/as-component-box.h" line="51"/>
<constructor name="new"
c:identifier="as_component_box_new"
version="1.0">
<doc xml:space="preserve"
filename="src/as-component-box.c"
line="150">Creates a new #AsComponentBox.</doc>
<source-position filename="src/as-component-box.h" line="71"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-component-box.c"
line="155">an #AsComponentBox</doc>
<type name="ComponentBox" c:type="AsComponentBox*"/>
</return-value>
<parameters>
<parameter name="flags" transfer-ownership="none">
<type name="ComponentBoxFlags" c:type="AsComponentBoxFlags"/>
</parameter>
</parameters>
</constructor>
<constructor name="new_simple"
c:identifier="as_component_box_new_simple">
<doc xml:space="preserve"
filename="src/as-component-box.c"
line="167">Creates a new #AsComponentBox with the simplest parameters,
so it is basically an array storage without overhead.
Only the most basic checks on inserted components will be performed,
and it is assumed that the inserted components have been checked
already prior to insertion.</doc>
<source-position filename="src/as-component-box.h" line="72"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-component-box.c"
line="177">an #AsComponentBox</doc>
<type name="ComponentBox" c:type="AsComponentBox*"/>
</return-value>
</constructor>
<method name="add" c:identifier="as_component_box_add" throws="1">
<doc xml:space="preserve"
filename="src/as-component-box.c"
line="284">Add a component to the box. Returns an error if we could not add it
(most likely due to component box constraints).</doc>
<source-position filename="src/as-component-box.h" line="85"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component-box.c"
line="291">%TRUE on success.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="cbox" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component-box.c"
line="286">An instance of #AsComponentBox.</doc>
<type name="ComponentBox" c:type="AsComponentBox*"/>
</instance-parameter>
<parameter name="cpt" transfer-ownership="none">
<type name="Component" c:type="AsComponent*"/>
</parameter>
</parameters>
</method>
<method name="as_array" c:identifier="as_component_box_as_array">
<doc xml:space="preserve"
filename="src/as-component-box.c"
line="209">Get the contents of this component box as #GPtrArray.</doc>
<source-position filename="src/as-component-box.h" line="78"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component-box.c"
line="215">an array of #AsComponent instances.</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="Component"/>
</array>
</return-value>
<parameters>
<instance-parameter name="cbox" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component-box.c"
line="211">An instance of #AsComponentBox.</doc>
<type name="ComponentBox" c:type="AsComponentBox*"/>
</instance-parameter>
</parameters>
</method>
<method name="clear" c:identifier="as_component_box_clear">
<doc xml:space="preserve"
filename="src/as-component-box.c"
line="317">Remove all contents of this component box.</doc>
<source-position filename="src/as-component-box.h" line="86"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cbox" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component-box.c"
line="319">An instance of #AsComponentBox.</doc>
<type name="ComponentBox" c:type="AsComponentBox*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_flags"
c:identifier="as_component_box_get_flags"
glib:get-property="flags">
<doc xml:space="preserve"
filename="src/as-component-box.c"
line="223">Get the flags this component box was constructed with.</doc>
<source-position filename="src/as-component-box.h" line="79"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component-box.c"
line="229">The #AsComponentBoxFlags that are in effect.</doc>
<type name="ComponentBoxFlags" c:type="AsComponentBoxFlags"/>
</return-value>
<parameters>
<instance-parameter name="cbox" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component-box.c"
line="225">An instance of #AsComponentBox.</doc>
<type name="ComponentBox" c:type="AsComponentBox*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_size" c:identifier="as_component_box_get_size">
<doc xml:space="preserve"
filename="src/as-component-box.c"
line="238">Get the amount of components in this box.</doc>
<source-position filename="src/as-component-box.h" line="81"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component-box.c"
line="244">Amount of components.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="cbox" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component-box.c"
line="240">An instance of #AsComponentBox.</doc>
<type name="ComponentBox" c:type="AsComponentBox*"/>
</instance-parameter>
</parameters>
</method>
<method name="index_safe" c:identifier="as_component_box_index_safe">
<doc xml:space="preserve"
filename="src/as-component-box.c"
line="266">Retrieve a component at the respective index from the internal
component array.</doc>
<source-position filename="src/as-component-box.h" line="82"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component-box.c"
line="274">An #AsComponent or %NULL</doc>
<type name="Component" c:type="AsComponent*"/>
</return-value>
<parameters>
<instance-parameter name="cbox" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component-box.c"
line="268">An instance of #AsComponentBox.</doc>
<type name="ComponentBox" c:type="AsComponentBox*"/>
</instance-parameter>
<parameter name="index" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component-box.c"
line="269">The component index.</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="is_empty" c:identifier="as_component_box_is_empty">
<doc xml:space="preserve"
filename="src/as-component-box.c"
line="252">Check if there are any components present.</doc>
<source-position filename="src/as-component-box.h" line="83"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component-box.c"
line="258">%TRUE if this component box is empty.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="cbox" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component-box.c"
line="254">An instance of #AsComponentBox.</doc>
<type name="ComponentBox" c:type="AsComponentBox*"/>
</instance-parameter>
</parameters>
</method>
<method name="remove_at" c:identifier="as_component_box_remove_at">
<doc xml:space="preserve"
filename="src/as-component-box.c"
line="333">Remove a component at the specified index.
Please ensure that the index is not larger than
%as_component_box_get_size() - 1</doc>
<source-position filename="src/as-component-box.h" line="87"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cbox" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component-box.c"
line="335">An instance of #AsComponentBox.</doc>
<type name="ComponentBox" c:type="AsComponentBox*"/>
</instance-parameter>
<parameter name="index" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component-box.c"
line="336">the index of the component to remove.</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="sort" c:identifier="as_component_box_sort">
<doc xml:space="preserve"
filename="src/as-component-box.c"
line="388">Sort components to bring them into a deterministic order.</doc>
<source-position filename="src/as-component-box.h" line="89"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cbox" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component-box.c"
line="390">An instance of #AsComponentBox.</doc>
<type name="ComponentBox" c:type="AsComponentBox*"/>
</instance-parameter>
</parameters>
</method>
<method name="sort_by_score"
c:identifier="as_component_box_sort_by_score">
<doc xml:space="preserve"
filename="src/as-component-box.c"
line="400">Sort components by their (search) match score.</doc>
<source-position filename="src/as-component-box.h" line="90"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cbox" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component-box.c"
line="402">An instance of #AsComponentBox.</doc>
<type name="ComponentBox" c:type="AsComponentBox*"/>
</instance-parameter>
</parameters>
</method>
<property name="flags"
writable="1"
construct-only="1"
transfer-ownership="none"
getter="get_flags"
default-value="0">
<type name="guint" c:type="guint"/>
</property>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
<field name="cpts" readable="0" private="1">
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</class>
<record name="ComponentBoxClass"
c:type="AsComponentBoxClass"
glib:is-gtype-struct-for="ComponentBox">
<source-position filename="src/as-component-box.h" line="51"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_as_reserved1" introspectable="0">
<callback name="_as_reserved1">
<source-position filename="src/as-component-box.h" line="45"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved2" introspectable="0">
<callback name="_as_reserved2">
<source-position filename="src/as-component-box.h" line="46"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved3" introspectable="0">
<callback name="_as_reserved3">
<source-position filename="src/as-component-box.h" line="47"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved4" introspectable="0">
<callback name="_as_reserved4">
<source-position filename="src/as-component-box.h" line="48"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved5" introspectable="0">
<callback name="_as_reserved5">
<source-position filename="src/as-component-box.h" line="49"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved6" introspectable="0">
<callback name="_as_reserved6">
<source-position filename="src/as-component-box.h" line="50"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
</record>
<bitfield name="ComponentBoxFlags"
glib:type-name="AsComponentBoxFlags"
glib:get-type="as_component_box_flags_get_type"
c:type="AsComponentBoxFlags">
<doc xml:space="preserve"
filename="src/as-component-box.h"
line="59">Flags controlling the component box behavior.</doc>
<member name="none"
value="0"
c:identifier="AS_COMPONENT_BOX_FLAG_NONE"
glib:nick="none"
glib:name="AS_COMPONENT_BOX_FLAG_NONE">
<doc xml:space="preserve"
filename="src/as-component-box.h"
line="61">No flags.</doc>
</member>
<member name="no_checks"
value="1"
c:identifier="AS_COMPONENT_BOX_FLAG_NO_CHECKS"
glib:nick="no-checks"
glib:name="AS_COMPONENT_BOX_FLAG_NO_CHECKS">
<doc xml:space="preserve"
filename="src/as-component-box.h"
line="62">Only perform the most basic verification.</doc>
</member>
</bitfield>
<record name="ComponentClass"
c:type="AsComponentClass"
glib:is-gtype-struct-for="Component">
<source-position filename="src/as-component.h" line="66"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_as_reserved1" introspectable="0">
<callback name="_as_reserved1">
<source-position filename="src/as-component.h" line="60"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved2" introspectable="0">
<callback name="_as_reserved2">
<source-position filename="src/as-component.h" line="61"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved3" introspectable="0">
<callback name="_as_reserved3">
<source-position filename="src/as-component.h" line="62"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved4" introspectable="0">
<callback name="_as_reserved4">
<source-position filename="src/as-component.h" line="63"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved5" introspectable="0">
<callback name="_as_reserved5">
<source-position filename="src/as-component.h" line="64"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved6" introspectable="0">
<callback name="_as_reserved6">
<source-position filename="src/as-component.h" line="65"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
</record>
<enumeration name="ComponentKind"
glib:type-name="AsComponentKind"
glib:get-type="as_component_kind_get_type"
c:type="AsComponentKind">
<doc xml:space="preserve"
filename="src/as-component.h"
line="68">The type of an #AsComponent.</doc>
<member name="unknown"
value="0"
c:identifier="AS_COMPONENT_KIND_UNKNOWN"
glib:nick="unknown"
glib:name="AS_COMPONENT_KIND_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-component.h"
line="70">Type invalid or not known</doc>
</member>
<member name="generic"
value="1"
c:identifier="AS_COMPONENT_KIND_GENERIC"
glib:nick="generic"
glib:name="AS_COMPONENT_KIND_GENERIC">
<doc xml:space="preserve"
filename="src/as-component.h"
line="71">A generic (= without specialized type) component</doc>
</member>
<member name="desktop_app"
value="2"
c:identifier="AS_COMPONENT_KIND_DESKTOP_APP"
glib:nick="desktop-app"
glib:name="AS_COMPONENT_KIND_DESKTOP_APP">
<doc xml:space="preserve"
filename="src/as-component.h"
line="72">An application with a .desktop-file</doc>
</member>
<member name="console_app"
value="3"
c:identifier="AS_COMPONENT_KIND_CONSOLE_APP"
glib:nick="console-app"
glib:name="AS_COMPONENT_KIND_CONSOLE_APP">
<doc xml:space="preserve"
filename="src/as-component.h"
line="73">A console application</doc>
</member>
<member name="web_app"
value="4"
c:identifier="AS_COMPONENT_KIND_WEB_APP"
glib:nick="web-app"
glib:name="AS_COMPONENT_KIND_WEB_APP">
<doc xml:space="preserve"
filename="src/as-component.h"
line="74">A web application</doc>
</member>
<member name="service"
value="5"
c:identifier="AS_COMPONENT_KIND_SERVICE"
glib:nick="service"
glib:name="AS_COMPONENT_KIND_SERVICE">
<doc xml:space="preserve"
filename="src/as-component.h"
line="75">A system service launched by the init system</doc>
</member>
<member name="addon"
value="6"
c:identifier="AS_COMPONENT_KIND_ADDON"
glib:nick="addon"
glib:name="AS_COMPONENT_KIND_ADDON">
<doc xml:space="preserve"
filename="src/as-component.h"
line="76">An extension of existing software, which does not run standalone</doc>
</member>
<member name="runtime"
value="7"
c:identifier="AS_COMPONENT_KIND_RUNTIME"
glib:nick="runtime"
glib:name="AS_COMPONENT_KIND_RUNTIME">
<doc xml:space="preserve"
filename="src/as-component.h"
line="77">An application runtime platform</doc>
</member>
<member name="font"
value="8"
c:identifier="AS_COMPONENT_KIND_FONT"
glib:nick="font"
glib:name="AS_COMPONENT_KIND_FONT">
<doc xml:space="preserve"
filename="src/as-component.h"
line="78">A font</doc>
</member>
<member name="codec"
value="9"
c:identifier="AS_COMPONENT_KIND_CODEC"
glib:nick="codec"
glib:name="AS_COMPONENT_KIND_CODEC">
<doc xml:space="preserve"
filename="src/as-component.h"
line="79">A multimedia codec</doc>
</member>
<member name="input_method"
value="10"
c:identifier="AS_COMPONENT_KIND_INPUT_METHOD"
glib:nick="input-method"
glib:name="AS_COMPONENT_KIND_INPUT_METHOD">
<doc xml:space="preserve"
filename="src/as-component.h"
line="80">An input-method provider</doc>
</member>
<member name="operating_system"
value="11"
c:identifier="AS_COMPONENT_KIND_OPERATING_SYSTEM"
glib:nick="operating-system"
glib:name="AS_COMPONENT_KIND_OPERATING_SYSTEM">
<doc xml:space="preserve"
filename="src/as-component.h"
line="81">A computer operating system</doc>
</member>
<member name="firmware"
value="12"
c:identifier="AS_COMPONENT_KIND_FIRMWARE"
glib:nick="firmware"
glib:name="AS_COMPONENT_KIND_FIRMWARE">
<doc xml:space="preserve"
filename="src/as-component.h"
line="82">Firmware</doc>
</member>
<member name="driver"
value="13"
c:identifier="AS_COMPONENT_KIND_DRIVER"
glib:nick="driver"
glib:name="AS_COMPONENT_KIND_DRIVER">
<doc xml:space="preserve"
filename="src/as-component.h"
line="83">A driver</doc>
</member>
<member name="localization"
value="14"
c:identifier="AS_COMPONENT_KIND_LOCALIZATION"
glib:nick="localization"
glib:name="AS_COMPONENT_KIND_LOCALIZATION">
<doc xml:space="preserve"
filename="src/as-component.h"
line="84">Software localization (usually l10n resources)</doc>
</member>
<member name="repository"
value="15"
c:identifier="AS_COMPONENT_KIND_REPOSITORY"
glib:nick="repository"
glib:name="AS_COMPONENT_KIND_REPOSITORY">
<doc xml:space="preserve"
filename="src/as-component.h"
line="85">A remote software or data source</doc>
</member>
<member name="icon_theme"
value="16"
c:identifier="AS_COMPONENT_KIND_ICON_THEME"
glib:nick="icon-theme"
glib:name="AS_COMPONENT_KIND_ICON_THEME">
<doc xml:space="preserve"
filename="src/as-component.h"
line="86">An icon theme following the XDG specification</doc>
</member>
<function name="from_string"
c:identifier="as_component_kind_from_string">
<doc xml:space="preserve"
filename="src/as-component.c"
line="200">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-component.h" line="113"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="206">a #AsComponentKind or %AS_COMPONENT_KIND_UNKNOWN for unknown</doc>
<type name="ComponentKind" c:type="AsComponentKind"/>
</return-value>
<parameters>
<parameter name="kind_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="202">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="to_string" c:identifier="as_component_kind_to_string">
<doc xml:space="preserve"
filename="src/as-component.c"
line="154">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-component.h" line="112"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="160">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="156">the #AsComponentKind.</doc>
<type name="ComponentKind" c:type="AsComponentKind"/>
</parameter>
</parameters>
</function>
</enumeration>
<enumeration name="ComponentScope"
glib:type-name="AsComponentScope"
glib:get-type="as_component_scope_get_type"
c:type="AsComponentScope">
<doc xml:space="preserve"
filename="src/as-component.h"
line="137">Scope of the #AsComponent (system-wide or user-scope)</doc>
<member name="unknown"
value="0"
c:identifier="AS_COMPONENT_SCOPE_UNKNOWN"
glib:nick="unknown"
glib:name="AS_COMPONENT_SCOPE_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-component.h"
line="139">Unknown scope</doc>
</member>
<member name="system"
value="1"
c:identifier="AS_COMPONENT_SCOPE_SYSTEM"
glib:nick="system"
glib:name="AS_COMPONENT_SCOPE_SYSTEM">
<doc xml:space="preserve"
filename="src/as-component.h"
line="140">System scope</doc>
</member>
<member name="user"
value="2"
c:identifier="AS_COMPONENT_SCOPE_USER"
glib:nick="user"
glib:name="AS_COMPONENT_SCOPE_USER">
<doc xml:space="preserve"
filename="src/as-component.h"
line="141">User scope</doc>
</member>
<function name="from_string"
c:identifier="as_component_scope_from_string">
<doc xml:space="preserve"
filename="src/as-component.c"
line="315">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-component.h" line="154"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="321">a #AsComponentScope or %AS_COMPONENT_SCOPE_UNKNOWN for unknown</doc>
<type name="ComponentScope" c:type="AsComponentScope"/>
</return-value>
<parameters>
<parameter name="scope_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="317">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="to_string" c:identifier="as_component_scope_to_string">
<doc xml:space="preserve"
filename="src/as-component.c"
line="297">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-component.h" line="153"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="303">string version of @scope</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="scope" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="299">the #AsComponentScope.</doc>
<type name="ComponentScope" c:type="AsComponentScope"/>
</parameter>
</parameters>
</function>
</enumeration>
<class name="ContentRating"
c:symbol-prefix="content_rating"
c:type="AsContentRating"
parent="GObject.Object"
glib:type-name="AsContentRating"
glib:get-type="as_content_rating_get_type"
glib:type-struct="ContentRatingClass">
<source-position filename="src/as-content-rating.h" line="46"/>
<constructor name="new"
c:identifier="as_content_rating_new"
version="0.11.0">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="1576">Creates a new #AsContentRating.</doc>
<source-position filename="src/as-content-rating.h" line="132"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="1581">a #AsContentRating</doc>
<type name="ContentRating" c:type="AsContentRating*"/>
</return-value>
</constructor>
<function name="attribute_from_csm_age"
c:identifier="as_content_rating_attribute_from_csm_age"
version="0.12.12">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="1297">Gets the highest #AsContentRatingValue which is allowed to be seen by the
given Common Sense Media @age for the given subsection @id.
For example, if the CSM age mappings for `violence-bloodshed` are:
* age ≥ 0 for %AS_CONTENT_RATING_VALUE_NONE
* age ≥ 9 for %AS_CONTENT_RATING_VALUE_MILD
* age ≥ 11 for %AS_CONTENT_RATING_VALUE_MODERATE
* age ≥ 18 for %AS_CONTENT_RATING_VALUE_INTENSE
then calling this function with `violence-bloodshed` and @age set to 17 would
return %AS_CONTENT_RATING_VALUE_MODERATE. Calling it with age 18 would
return %AS_CONTENT_RATING_VALUE_INTENSE.</doc>
<source-position filename="src/as-content-rating.h" line="128"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="1314">the #AsContentRatingValue, or %AS_CONTENT_RATING_VALUE_UNKNOWN if
unknown</doc>
<type name="ContentRatingValue" c:type="AsContentRatingValue"/>
</return-value>
<parameters>
<parameter name="id" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="1299">the subsection ID e.g. `violence-cartoon`</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="age" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="1300">the CSM age</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</function>
<function name="attribute_get_description"
c:identifier="as_content_rating_attribute_get_description"
version="0.12.12">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="1147">Get a human-readable description of what content would be expected to
require the content rating attribute given by @id and @value.</doc>
<source-position filename="src/as-content-rating.h" line="129"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="1155">a human-readable description of @id and @value</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="id" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="1149">the subsection ID e.g. `violence-cartoon`</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="1150">the #AsContentRatingValue, e.g. %AS_CONTENT_RATING_VALUE_INTENSE</doc>
<type name="ContentRatingValue" c:type="AsContentRatingValue"/>
</parameter>
</parameters>
</function>
<function name="attribute_to_csm_age"
c:identifier="as_content_rating_attribute_to_csm_age"
version="0.12.10">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="1257">Gets the Common Sense Media approved age for a specific rating level.</doc>
<source-position filename="src/as-content-rating.h" line="115"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="1264">The age in years, or 0 for no details.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<parameter name="id" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="1259">the subsection ID e.g. `violence-cartoon`</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="1260">the #AsContentRatingValue, e.g. %AS_CONTENT_RATING_VALUE_INTENSE</doc>
<type name="ContentRatingValue" c:type="AsContentRatingValue"/>
</parameter>
</parameters>
</function>
<function name="get_all_rating_ids"
c:identifier="as_content_rating_get_all_rating_ids"
version="0.12.10">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="1339">Returns a list of all the valid OARS content rating attribute IDs as could
be passed to as_content_rating_add_attribute() or
as_content_rating_attribute_to_csm_age().</doc>
<source-position filename="src/as-content-rating.h" line="117"/>
<return-value transfer-ownership="container">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="1346">a %NULL-terminated
array of IDs, to be freed with g_free() (the element values are owned by
libappstream and must not be freed)</doc>
<array c:type="const gchar**">
<type name="utf8"/>
</array>
</return-value>
</function>
<method name="add_attribute"
c:identifier="as_content_rating_add_attribute"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="493">Adds an attribute value to the content rating.</doc>
<source-position filename="src/as-content-rating.h" line="146"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="content_rating" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="495">a #AsContentRating instance.</doc>
<type name="ContentRating" c:type="AsContentRating*"/>
</instance-parameter>
<parameter name="id" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="496">a content rating ID, e.g. `money-gambling`.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="497">a #AsContentRatingValue, e.g. %AS_CONTENT_RATING_VALUE_MODERATE.</doc>
<type name="ContentRatingValue" c:type="AsContentRatingValue"/>
</parameter>
</parameters>
</method>
<method name="get_kind"
c:identifier="as_content_rating_get_kind"
version="0.11.0">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="1404">Gets the content_rating kind.</doc>
<source-position filename="src/as-content-rating.h" line="134"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="1410">a string, e.g. "oars-1.0", or NULL</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="content_rating" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="1406">a #AsContentRating instance.</doc>
<type name="ContentRating" c:type="AsContentRating*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_minimum_age"
c:identifier="as_content_rating_get_minimum_age"
version="0.11.0">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="1363">Gets the lowest Common Sense Media approved age for the content_rating block.
NOTE: these numbers are based on the data and descriptions available from
https://www.commonsensemedia.org/about-us/our-mission/about-our-ratings and
you may disagree with them.
You're free to disagree with these, and of course you should use your own
brain to work our if your child is able to cope with the concepts enumerated
here. Some 13 year olds may be fine with the concept of mutilation of body
parts; others may get nightmares.</doc>
<source-position filename="src/as-content-rating.h" line="137"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="1377">The age in years, 0 for no rating, or G_MAXUINT for no details.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="content_rating" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="1365">a #AsContentRating</doc>
<type name="ContentRating" c:type="AsContentRating*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_rating_ids"
c:identifier="as_content_rating_get_rating_ids"
version="0.12.10">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="98">Gets the set of ratings IDs which are present in this @content_rating. An
example of a ratings ID is `violence-bloodshed`.
The IDs are returned in lexicographical order.</doc>
<source-position filename="src/as-content-rating.h" line="144"/>
<return-value transfer-ownership="container">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="107">%NULL-terminated
array of ratings IDs; each ratings ID is owned by the #AsContentRating and
must not be freed, but the container must be freed with g_free()</doc>
<array c:type="const gchar**">
<type name="utf8"/>
</array>
</return-value>
<parameters>
<instance-parameter name="content_rating" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="100">a #AsContentRating</doc>
<type name="ContentRating" c:type="AsContentRating*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_value"
c:identifier="as_content_rating_get_value"
version="0.11.0">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="160">Gets the value of a content rating key.</doc>
<source-position filename="src/as-content-rating.h" line="139"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="167">the #AsContentRatingValue, or %AS_CONTENT_RATING_VALUE_UNKNOWN</doc>
<type name="ContentRatingValue" c:type="AsContentRatingValue"/>
</return-value>
<parameters>
<instance-parameter name="content_rating" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="162">a #AsContentRating</doc>
<type name="ContentRating" c:type="AsContentRating*"/>
</instance-parameter>
<parameter name="id" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="163">A ratings ID, e.g. `violence-bloodshed`.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_kind"
c:identifier="as_content_rating_set_kind"
version="0.11.0">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="1422">Sets the content rating kind.</doc>
<source-position filename="src/as-content-rating.h" line="135"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="content_rating" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="1424">a #AsContentRating instance.</doc>
<type name="ContentRating" c:type="AsContentRating*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="1425">the rating kind, e.g. "oars-1.0"</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_value"
c:identifier="as_content_rating_set_value"
version="0.11.0">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="133">Sets the value of a content rating key.</doc>
<source-position filename="src/as-content-rating.h" line="140"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="content_rating" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="135">a #AsContentRating</doc>
<type name="ContentRating" c:type="AsContentRating*"/>
</instance-parameter>
<parameter name="id" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="136">A ratings ID, e.g. `violence-bloodshed`.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="137">A #AsContentRatingValue, e.g. %AS_CONTENT_RATING_VALUE_INTENSE</doc>
<type name="ContentRatingValue" c:type="AsContentRatingValue"/>
</parameter>
</parameters>
</method>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<record name="ContentRatingClass"
c:type="AsContentRatingClass"
glib:is-gtype-struct-for="ContentRating">
<source-position filename="src/as-content-rating.h" line="46"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_as_reserved1" introspectable="0">
<callback name="_as_reserved1">
<source-position filename="src/as-content-rating.h" line="40"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved2" introspectable="0">
<callback name="_as_reserved2">
<source-position filename="src/as-content-rating.h" line="41"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved3" introspectable="0">
<callback name="_as_reserved3">
<source-position filename="src/as-content-rating.h" line="42"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved4" introspectable="0">
<callback name="_as_reserved4">
<source-position filename="src/as-content-rating.h" line="43"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved5" introspectable="0">
<callback name="_as_reserved5">
<source-position filename="src/as-content-rating.h" line="44"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved6" introspectable="0">
<callback name="_as_reserved6">
<source-position filename="src/as-content-rating.h" line="45"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
</record>
<enumeration name="ContentRatingSystem"
version="0.12.12"
glib:type-name="AsContentRatingSystem"
glib:get-type="as_content_rating_system_get_type"
c:type="AsContentRatingSystem">
<doc xml:space="preserve"
filename="src/as-content-rating.h"
line="48">A content rating system for a particular territory.</doc>
<member name="unknown"
value="0"
c:identifier="AS_CONTENT_RATING_SYSTEM_UNKNOWN"
glib:nick="unknown"
glib:name="AS_CONTENT_RATING_SYSTEM_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-content-rating.h"
line="50">Unknown ratings system</doc>
</member>
<member name="incaa"
value="1"
c:identifier="AS_CONTENT_RATING_SYSTEM_INCAA"
glib:nick="incaa"
glib:name="AS_CONTENT_RATING_SYSTEM_INCAA">
<doc xml:space="preserve"
filename="src/as-content-rating.h"
line="51">INCAA</doc>
</member>
<member name="acb"
value="2"
c:identifier="AS_CONTENT_RATING_SYSTEM_ACB"
glib:nick="acb"
glib:name="AS_CONTENT_RATING_SYSTEM_ACB">
<doc xml:space="preserve"
filename="src/as-content-rating.h"
line="52">ACB</doc>
</member>
<member name="djctq"
value="3"
c:identifier="AS_CONTENT_RATING_SYSTEM_DJCTQ"
glib:nick="djctq"
glib:name="AS_CONTENT_RATING_SYSTEM_DJCTQ">
<doc xml:space="preserve"
filename="src/as-content-rating.h"
line="53">DJCTQ</doc>
</member>
<member name="gsrr"
value="4"
c:identifier="AS_CONTENT_RATING_SYSTEM_GSRR"
glib:nick="gsrr"
glib:name="AS_CONTENT_RATING_SYSTEM_GSRR">
<doc xml:space="preserve"
filename="src/as-content-rating.h"
line="54">GSRR</doc>
</member>
<member name="pegi"
value="5"
c:identifier="AS_CONTENT_RATING_SYSTEM_PEGI"
glib:nick="pegi"
glib:name="AS_CONTENT_RATING_SYSTEM_PEGI">
<doc xml:space="preserve"
filename="src/as-content-rating.h"
line="55">PEGI</doc>
</member>
<member name="kavi"
value="6"
c:identifier="AS_CONTENT_RATING_SYSTEM_KAVI"
glib:nick="kavi"
glib:name="AS_CONTENT_RATING_SYSTEM_KAVI">
<doc xml:space="preserve"
filename="src/as-content-rating.h"
line="56">KAVI</doc>
</member>
<member name="usk"
value="7"
c:identifier="AS_CONTENT_RATING_SYSTEM_USK"
glib:nick="usk"
glib:name="AS_CONTENT_RATING_SYSTEM_USK">
<doc xml:space="preserve"
filename="src/as-content-rating.h"
line="57">USK</doc>
</member>
<member name="esra"
value="8"
c:identifier="AS_CONTENT_RATING_SYSTEM_ESRA"
glib:nick="esra"
glib:name="AS_CONTENT_RATING_SYSTEM_ESRA">
<doc xml:space="preserve"
filename="src/as-content-rating.h"
line="58">ESRA</doc>
</member>
<member name="cero"
value="9"
c:identifier="AS_CONTENT_RATING_SYSTEM_CERO"
glib:nick="cero"
glib:name="AS_CONTENT_RATING_SYSTEM_CERO">
<doc xml:space="preserve"
filename="src/as-content-rating.h"
line="59">CERO</doc>
</member>
<member name="oflcnz"
value="10"
c:identifier="AS_CONTENT_RATING_SYSTEM_OFLCNZ"
glib:nick="oflcnz"
glib:name="AS_CONTENT_RATING_SYSTEM_OFLCNZ">
<doc xml:space="preserve"
filename="src/as-content-rating.h"
line="60">OFLCNZ</doc>
</member>
<member name="russia"
value="11"
c:identifier="AS_CONTENT_RATING_SYSTEM_RUSSIA"
glib:nick="russia"
glib:name="AS_CONTENT_RATING_SYSTEM_RUSSIA">
<doc xml:space="preserve"
filename="src/as-content-rating.h"
line="61">Russia</doc>
</member>
<member name="mda"
value="12"
c:identifier="AS_CONTENT_RATING_SYSTEM_MDA"
glib:nick="mda"
glib:name="AS_CONTENT_RATING_SYSTEM_MDA">
<doc xml:space="preserve"
filename="src/as-content-rating.h"
line="62">MDA</doc>
</member>
<member name="grac"
value="13"
c:identifier="AS_CONTENT_RATING_SYSTEM_GRAC"
glib:nick="grac"
glib:name="AS_CONTENT_RATING_SYSTEM_GRAC">
<doc xml:space="preserve"
filename="src/as-content-rating.h"
line="63">GRAC</doc>
</member>
<member name="esrb"
value="14"
c:identifier="AS_CONTENT_RATING_SYSTEM_ESRB"
glib:nick="esrb"
glib:name="AS_CONTENT_RATING_SYSTEM_ESRB">
<doc xml:space="preserve"
filename="src/as-content-rating.h"
line="64">ESRB</doc>
</member>
<member name="iarc"
value="15"
c:identifier="AS_CONTENT_RATING_SYSTEM_IARC"
glib:nick="iarc"
glib:name="AS_CONTENT_RATING_SYSTEM_IARC">
<doc xml:space="preserve"
filename="src/as-content-rating.h"
line="65">IARC</doc>
</member>
<function name="format_age"
c:identifier="as_content_rating_system_format_age"
version="0.12.12">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="287">Format @age as a human-readable string in the given rating @system. This is
the way to present system-specific strings in a UI.</doc>
<source-position filename="src/as-content-rating.h" line="120"/>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="295">a newly allocated formatted version of
@age, or %NULL if the given @system has no representation for @age</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<parameter name="system" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="289">an #AsContentRatingSystem</doc>
<type name="ContentRatingSystem" c:type="AsContentRatingSystem"/>
</parameter>
<parameter name="age" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="290">a CSM age to format</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</function>
<function name="from_locale"
c:identifier="as_content_rating_system_from_locale"
version="0.12.12">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="683">Determine the most appropriate #AsContentRatingSystem for the given @locale.
Content rating systems are selected by territory. If no content rating system
seems suitable, %AS_CONTENT_RATING_SYSTEM_IARC is returned.</doc>
<source-position filename="src/as-content-rating.h" line="122"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="691">the most relevant #AsContentRatingSystem</doc>
<type name="ContentRatingSystem" c:type="AsContentRatingSystem"/>
</return-value>
<parameters>
<parameter name="locale" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="685">a locale, in the format described in `man 3 setlocale`</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="get_csm_ages"
c:identifier="as_content_rating_system_get_csm_ages"
version="0.12.12">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="580">Get the CSM ages corresponding to the entries returned by
as_content_rating_system_get_formatted_ages() for this @system.</doc>
<source-position filename="src/as-content-rating.h" line="125"/>
<return-value transfer-ownership="container">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="589">an array of CSM ages</doc>
<array length="1" zero-terminated="0" c:type="const guint*">
<type name="guint" c:type="guint"/>
</array>
</return-value>
<parameters>
<parameter name="system" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="582">an #AsContentRatingSystem</doc>
<type name="ContentRatingSystem" c:type="AsContentRatingSystem"/>
</parameter>
<parameter name="length_out"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="583">return location for the length of the
returned array</doc>
<type name="gsize" c:type="gsize*"/>
</parameter>
</parameters>
</function>
<function name="get_formatted_ages"
c:identifier="as_content_rating_system_get_formatted_ages"
version="0.12.12">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="520">Get an array of all the possible return values of
as_content_rating_system_format_age() for the given @system. The array is
sorted with youngest CSM age first.</doc>
<source-position filename="src/as-content-rating.h" line="124"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="528">%NULL-terminated array of human-readable age strings</doc>
<array c:type="gchar**">
<type name="utf8"/>
</array>
</return-value>
<parameters>
<parameter name="system" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="522">an #AsContentRatingSystem</doc>
<type name="ContentRatingSystem" c:type="AsContentRatingSystem"/>
</parameter>
</parameters>
</function>
<function name="to_string"
c:identifier="as_content_rating_system_to_string"
version="0.12.12">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="257">Get a human-readable string to identify @system. %NULL will be returned for
%AS_CONTENT_RATING_SYSTEM_UNKNOWN.</doc>
<source-position filename="src/as-content-rating.h" line="119"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="264">a human-readable string for @system, or %NULL if unknown</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="system" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="259">an #AsContentRatingSystem</doc>
<type name="ContentRatingSystem" c:type="AsContentRatingSystem"/>
</parameter>
</parameters>
</function>
</enumeration>
<enumeration name="ContentRatingValue"
glib:type-name="AsContentRatingValue"
glib:get-type="as_content_rating_value_get_type"
c:type="AsContentRatingValue">
<doc xml:space="preserve"
filename="src/as-content-rating.h"
line="92">The specified level of an content_rating rating ID.</doc>
<member name="unknown"
value="0"
c:identifier="AS_CONTENT_RATING_VALUE_UNKNOWN"
glib:nick="unknown"
glib:name="AS_CONTENT_RATING_VALUE_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-content-rating.h"
line="94">Unknown value</doc>
</member>
<member name="none"
value="1"
c:identifier="AS_CONTENT_RATING_VALUE_NONE"
glib:nick="none"
glib:name="AS_CONTENT_RATING_VALUE_NONE">
<doc xml:space="preserve"
filename="src/as-content-rating.h"
line="95">None</doc>
</member>
<member name="mild"
value="2"
c:identifier="AS_CONTENT_RATING_VALUE_MILD"
glib:nick="mild"
glib:name="AS_CONTENT_RATING_VALUE_MILD">
<doc xml:space="preserve"
filename="src/as-content-rating.h"
line="96">A small amount</doc>
</member>
<member name="moderate"
value="3"
c:identifier="AS_CONTENT_RATING_VALUE_MODERATE"
glib:nick="moderate"
glib:name="AS_CONTENT_RATING_VALUE_MODERATE">
<doc xml:space="preserve"
filename="src/as-content-rating.h"
line="97">A moderate amount</doc>
</member>
<member name="intense"
value="4"
c:identifier="AS_CONTENT_RATING_VALUE_INTENSE"
glib:nick="intense"
glib:name="AS_CONTENT_RATING_VALUE_INTENSE">
<doc xml:space="preserve"
filename="src/as-content-rating.h"
line="98">An intense amount</doc>
</member>
<function name="from_string"
c:identifier="as_content_rating_value_from_string"
version="0.11.0">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="221">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-content-rating.h" line="113"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="227">a #AsContentRatingValue or %AS_CONTENT_RATING_VALUE_UNKNOWN for unknown</doc>
<type name="ContentRatingValue" c:type="AsContentRatingValue"/>
</return-value>
<parameters>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="223">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="to_string"
c:identifier="as_content_rating_value_to_string"
version="0.11.0">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="197">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-content-rating.h" line="112"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="203">string version of @value</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="199">the #AsContentRatingValue.</doc>
<type name="ContentRatingValue" c:type="AsContentRatingValue"/>
</parameter>
</parameters>
</function>
</enumeration>
<class name="Context"
c:symbol-prefix="context"
c:type="AsContext"
parent="GObject.Object"
glib:type-name="AsContext"
glib:get-type="as_context_get_type"
glib:type-struct="ContextClass">
<source-position filename="src/as-context.h" line="44"/>
<constructor name="new" c:identifier="as_context_new">
<doc xml:space="preserve"
filename="src/as-context.c"
line="676">Creates a new #AsContext.</doc>
<source-position filename="src/as-context.h" line="120"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-context.c"
line="681">an #AsContext</doc>
<type name="Context" c:type="AsContext*"/>
</return-value>
</constructor>
<method name="get_filename" c:identifier="as_context_get_filename">
<source-position filename="src/as-context.h" line="143"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="412">The name of the file the data originates from.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="ctx" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="410">a #AsContext instance.</doc>
<type name="Context" c:type="AsContext*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_format_version"
c:identifier="as_context_get_format_version">
<source-position filename="src/as-context.h" line="122"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="186">The AppStream format version.</doc>
<type name="FormatVersion" c:type="AsFormatVersion"/>
</return-value>
<parameters>
<instance-parameter name="ctx" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="184">a #AsContext instance.</doc>
<type name="Context" c:type="AsContext*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_locale" c:identifier="as_context_get_locale">
<source-position filename="src/as-context.h" line="134"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="294">The active locale in BCP47 format.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="ctx" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="292">a #AsContext instance.</doc>
<type name="Context" c:type="AsContext*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_locale_use_all"
c:identifier="as_context_get_locale_use_all">
<source-position filename="src/as-context.h" line="141"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="332">%TRUE if all locale should be parsed.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="ctx" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="330">a #AsContext instance.</doc>
<type name="Context" c:type="AsContext*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_media_baseurl"
c:identifier="as_context_get_media_baseurl">
<source-position filename="src/as-context.h" line="138"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="358">The media base URL.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="ctx" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="356">a #AsContext instance.</doc>
<type name="Context" c:type="AsContext*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_origin" c:identifier="as_context_get_origin">
<source-position filename="src/as-context.h" line="131"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="267">The data origin.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="ctx" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="265">a #AsContext instance.</doc>
<type name="Context" c:type="AsContext*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_priority" c:identifier="as_context_get_priority">
<source-position filename="src/as-context.h" line="128"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="240">The data priority.</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="ctx" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="238">a #AsContext instance.</doc>
<type name="Context" c:type="AsContext*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_style" c:identifier="as_context_get_style">
<source-position filename="src/as-context.h" line="125"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="213">The document style.</doc>
<type name="FormatStyle" c:type="AsFormatStyle"/>
</return-value>
<parameters>
<instance-parameter name="ctx" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="211">a #AsContext instance.</doc>
<type name="Context" c:type="AsContext*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_value_flags" c:identifier="as_context_get_value_flags">
<source-position filename="src/as-context.h" line="146"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="452">The #AsValueFlags that are set on @cpt.</doc>
<type name="ValueFlags" c:type="AsValueFlags"/>
</return-value>
<parameters>
<instance-parameter name="ctx" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="450">a #AsContext instance.</doc>
<type name="Context" c:type="AsContext*"/>
</instance-parameter>
</parameters>
</method>
<method name="has_media_baseurl"
c:identifier="as_context_has_media_baseurl">
<source-position filename="src/as-context.h" line="137"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="345">%TRUE if a media base URL is set.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="ctx" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="343">a #AsContext instance.</doc>
<type name="Context" c:type="AsContext*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_filename" c:identifier="as_context_set_filename">
<doc xml:space="preserve"
filename="src/as-context.c"
line="421">Sets the file name we are loading data from.</doc>
<source-position filename="src/as-context.h" line="144"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="ctx" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="423">a #AsContext instance.</doc>
<type name="Context" c:type="AsContext*"/>
</instance-parameter>
<parameter name="fname" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="424">the new file name.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_format_version"
c:identifier="as_context_set_format_version">
<doc xml:space="preserve"
filename="src/as-context.c"
line="195">Sets the AppStream format version.</doc>
<source-position filename="src/as-context.h" line="123"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="ctx" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="197">a #AsContext instance.</doc>
<type name="Context" c:type="AsContext*"/>
</instance-parameter>
<parameter name="ver" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="198">the new format version.</doc>
<type name="FormatVersion" c:type="AsFormatVersion"/>
</parameter>
</parameters>
</method>
<method name="set_locale" c:identifier="as_context_set_locale">
<doc xml:space="preserve"
filename="src/as-context.c"
line="303">Sets the active locale.
If the magic value "ALL" is used, the current system locale will be used
for data reading, but when writing data all locale will be written.</doc>
<source-position filename="src/as-context.h" line="135"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="ctx" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="305">a #AsContext instance.</doc>
<type name="Context" c:type="AsContext*"/>
</instance-parameter>
<parameter name="locale"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="src/as-context.c"
line="306">a POSIX or BCP47 locale, or %NULL. e.g. "en_GB"</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_media_baseurl"
c:identifier="as_context_set_media_baseurl">
<doc xml:space="preserve"
filename="src/as-context.c"
line="367">Sets the media base URL.</doc>
<source-position filename="src/as-context.h" line="139"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="ctx" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="369">a #AsContext instance.</doc>
<type name="Context" c:type="AsContext*"/>
</instance-parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="370">the new value.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_origin" c:identifier="as_context_set_origin">
<doc xml:space="preserve"
filename="src/as-context.c"
line="276">Sets the data origin.</doc>
<source-position filename="src/as-context.h" line="132"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="ctx" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="278">a #AsContext instance.</doc>
<type name="Context" c:type="AsContext*"/>
</instance-parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="279">the new value.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_priority" c:identifier="as_context_set_priority">
<doc xml:space="preserve"
filename="src/as-context.c"
line="249">Sets the data priority.</doc>
<source-position filename="src/as-context.h" line="129"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="ctx" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="251">a #AsContext instance.</doc>
<type name="Context" c:type="AsContext*"/>
</instance-parameter>
<parameter name="priority" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="252">the new priority.</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="set_style" c:identifier="as_context_set_style">
<doc xml:space="preserve"
filename="src/as-context.c"
line="222">Sets the AppStream document style.</doc>
<source-position filename="src/as-context.h" line="126"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="ctx" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="224">a #AsContext instance.</doc>
<type name="Context" c:type="AsContext*"/>
</instance-parameter>
<parameter name="style" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="225">the new document style.</doc>
<type name="FormatStyle" c:type="AsFormatStyle"/>
</parameter>
</parameters>
</method>
<method name="set_value_flags" c:identifier="as_context_set_value_flags">
<source-position filename="src/as-context.h" line="147"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="ctx" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="437">a #AsContext instance.</doc>
<type name="Context" c:type="AsContext*"/>
</instance-parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="438">#AsValueFlags to set on @cpt.</doc>
<type name="ValueFlags" c:type="AsValueFlags"/>
</parameter>
</parameters>
</method>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<record name="ContextClass"
c:type="AsContextClass"
glib:is-gtype-struct-for="Context">
<source-position filename="src/as-context.h" line="44"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_as_reserved1" introspectable="0">
<callback name="_as_reserved1">
<source-position filename="src/as-context.h" line="38"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved2" introspectable="0">
<callback name="_as_reserved2">
<source-position filename="src/as-context.h" line="39"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved3" introspectable="0">
<callback name="_as_reserved3">
<source-position filename="src/as-context.h" line="40"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved4" introspectable="0">
<callback name="_as_reserved4">
<source-position filename="src/as-context.h" line="41"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved5" introspectable="0">
<callback name="_as_reserved5">
<source-position filename="src/as-context.h" line="42"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved6" introspectable="0">
<callback name="_as_reserved6">
<source-position filename="src/as-context.h" line="43"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
</record>
<enumeration name="ControlKind"
glib:type-name="AsControlKind"
glib:get-type="as_control_kind_get_type"
c:type="AsControlKind">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="123">Kind of an input method for users to control software</doc>
<member name="unknown"
value="0"
c:identifier="AS_CONTROL_KIND_UNKNOWN"
glib:nick="unknown"
glib:name="AS_CONTROL_KIND_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="125">Unknown kind</doc>
</member>
<member name="pointing"
value="1"
c:identifier="AS_CONTROL_KIND_POINTING"
glib:nick="pointing"
glib:name="AS_CONTROL_KIND_POINTING">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="126">Mouse/cursors/other precision pointing device</doc>
</member>
<member name="keyboard"
value="2"
c:identifier="AS_CONTROL_KIND_KEYBOARD"
glib:nick="keyboard"
glib:name="AS_CONTROL_KIND_KEYBOARD">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="127">Keyboard input</doc>
</member>
<member name="console"
value="3"
c:identifier="AS_CONTROL_KIND_CONSOLE"
glib:nick="console"
glib:name="AS_CONTROL_KIND_CONSOLE">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="128">Console / command-line interface</doc>
</member>
<member name="touch"
value="4"
c:identifier="AS_CONTROL_KIND_TOUCH"
glib:nick="touch"
glib:name="AS_CONTROL_KIND_TOUCH">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="129">Touch input</doc>
</member>
<member name="gamepad"
value="5"
c:identifier="AS_CONTROL_KIND_GAMEPAD"
glib:nick="gamepad"
glib:name="AS_CONTROL_KIND_GAMEPAD">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="130">Gamepad input (any game controller with wheels/buttons/joysticks)</doc>
</member>
<member name="voice"
value="6"
c:identifier="AS_CONTROL_KIND_VOICE"
glib:nick="voice"
glib:name="AS_CONTROL_KIND_VOICE">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="131">Control via voice recognition/activation</doc>
</member>
<member name="vision"
value="7"
c:identifier="AS_CONTROL_KIND_VISION"
glib:nick="vision"
glib:name="AS_CONTROL_KIND_VISION">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="132">Computer vision / visual object and sign detection</doc>
</member>
<member name="tv_remote"
value="8"
c:identifier="AS_CONTROL_KIND_TV_REMOTE"
glib:nick="tv-remote"
glib:name="AS_CONTROL_KIND_TV_REMOTE">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="133">Input via a television remote</doc>
</member>
<member name="tablet"
value="9"
c:identifier="AS_CONTROL_KIND_TABLET"
glib:nick="tablet"
glib:name="AS_CONTROL_KIND_TABLET">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="134">Graphics tablet input</doc>
</member>
<function name="from_string"
c:identifier="as_control_kind_from_string"
version="0.12.11">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="328">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-relation.h" line="221"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="334">a #AsControlKind or %AS_CONTROL_KIND_UNKNOWN for unknown</doc>
<type name="ControlKind" c:type="AsControlKind"/>
</return-value>
<parameters>
<parameter name="kind_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="330">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="to_string"
c:identifier="as_control_kind_to_string"
version="0.12.11">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="294">Converts the enumerated value to a text representation.</doc>
<source-position filename="src/as-relation.h" line="220"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="300">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="296">the #AsControlKind.</doc>
<type name="ControlKind" c:type="AsControlKind"/>
</parameter>
</parameters>
</function>
</enumeration>
<bitfield name="DataIdMatchFlags"
glib:type-name="AsDataIdMatchFlags"
glib:get-type="as_data_id_match_flags_get_type"
c:type="AsDataIdMatchFlags">
<doc xml:space="preserve"
filename="src/as-utils.h"
line="47">The flags used when matching unique IDs.</doc>
<member name="none"
value="0"
c:identifier="AS_DATA_ID_MATCH_FLAG_NONE"
glib:nick="none"
glib:name="AS_DATA_ID_MATCH_FLAG_NONE">
<doc xml:space="preserve"
filename="src/as-utils.h"
line="49">No flags set</doc>
</member>
<member name="scope"
value="1"
c:identifier="AS_DATA_ID_MATCH_FLAG_SCOPE"
glib:nick="scope"
glib:name="AS_DATA_ID_MATCH_FLAG_SCOPE">
<doc xml:space="preserve"
filename="src/as-utils.h"
line="50">Scope, e.g. a #AsComponentScope</doc>
</member>
<member name="bundle_kind"
value="2"
c:identifier="AS_DATA_ID_MATCH_FLAG_BUNDLE_KIND"
glib:nick="bundle-kind"
glib:name="AS_DATA_ID_MATCH_FLAG_BUNDLE_KIND">
<doc xml:space="preserve"
filename="src/as-utils.h"
line="51">Bundle kind, e.g. a #AsBundleKind</doc>
</member>
<member name="origin"
value="4"
c:identifier="AS_DATA_ID_MATCH_FLAG_ORIGIN"
glib:nick="origin"
glib:name="AS_DATA_ID_MATCH_FLAG_ORIGIN">
<doc xml:space="preserve"
filename="src/as-utils.h"
line="52">Origin</doc>
</member>
<member name="id"
value="8"
c:identifier="AS_DATA_ID_MATCH_FLAG_ID"
glib:nick="id"
glib:name="AS_DATA_ID_MATCH_FLAG_ID">
<doc xml:space="preserve"
filename="src/as-utils.h"
line="53">Component AppStream ID</doc>
</member>
<member name="branch"
value="16"
c:identifier="AS_DATA_ID_MATCH_FLAG_BRANCH"
glib:nick="branch"
glib:name="AS_DATA_ID_MATCH_FLAG_BRANCH">
<doc xml:space="preserve"
filename="src/as-utils.h"
line="54">Branch</doc>
</member>
</bitfield>
<class name="Developer"
c:symbol-prefix="developer"
c:type="AsDeveloper"
parent="GObject.Object"
glib:type-name="AsDeveloper"
glib:get-type="as_developer_get_type"
glib:type-struct="DeveloperClass">
<source-position filename="src/as-developer.h" line="43"/>
<constructor name="new" c:identifier="as_developer_new">
<doc xml:space="preserve"
filename="src/as-developer.c"
line="89">Creates a new #AsDeveloper.</doc>
<source-position filename="src/as-developer.h" line="45"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-developer.c"
line="94">a #AsDeveloper</doc>
<type name="Developer" c:type="AsDeveloper*"/>
</return-value>
</constructor>
<method name="get_id" c:identifier="as_developer_get_id">
<doc xml:space="preserve"
filename="src/as-developer.c"
line="153">Gets a unique ID for this particular developer, e.g. "gnome" or "mozilla.org"</doc>
<source-position filename="src/as-developer.h" line="47"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-developer.c"
line="159">the unique developer ID, or %NULL if none was set.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="devp" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-developer.c"
line="155">an #AsDeveloper instance.</doc>
<type name="Developer" c:type="AsDeveloper*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_name" c:identifier="as_developer_get_name">
<doc xml:space="preserve"
filename="src/as-developer.c"
line="185">Get a localized developer, or development team name.</doc>
<source-position filename="src/as-developer.h" line="50"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-developer.c"
line="191">the developer name.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="devp" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-developer.c"
line="187">an #AsDeveloper instance.</doc>
<type name="Developer" c:type="AsDeveloper*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_id" c:identifier="as_developer_set_id">
<doc xml:space="preserve"
filename="src/as-developer.c"
line="168">Sets the unique ID of this developer.</doc>
<source-position filename="src/as-developer.h" line="48"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="devp" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-developer.c"
line="170">an #AsDeveloper instance.</doc>
<type name="Developer" c:type="AsDeveloper*"/>
</instance-parameter>
<parameter name="id" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-developer.c"
line="171">a developer ID, e.g. "mozilla.org"</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_name" c:identifier="as_developer_set_name">
<doc xml:space="preserve"
filename="src/as-developer.c"
line="200">Set the the developer or development team name.</doc>
<source-position filename="src/as-developer.h" line="51"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="devp" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-developer.c"
line="202">an #AsDeveloper instance.</doc>
<type name="Developer" c:type="AsDeveloper*"/>
</instance-parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-developer.c"
line="203">the developer or developer team name</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="locale"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="src/as-developer.c"
line="204">the BCP47 locale, or %NULL. e.g. "en-GB"</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<record name="DeveloperClass"
c:type="AsDeveloperClass"
glib:is-gtype-struct-for="Developer">
<source-position filename="src/as-developer.h" line="43"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_as_reserved1" introspectable="0">
<callback name="_as_reserved1">
<source-position filename="src/as-developer.h" line="37"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved2" introspectable="0">
<callback name="_as_reserved2">
<source-position filename="src/as-developer.h" line="38"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved3" introspectable="0">
<callback name="_as_reserved3">
<source-position filename="src/as-developer.h" line="39"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved4" introspectable="0">
<callback name="_as_reserved4">
<source-position filename="src/as-developer.h" line="40"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved5" introspectable="0">
<callback name="_as_reserved5">
<source-position filename="src/as-developer.h" line="41"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved6" introspectable="0">
<callback name="_as_reserved6">
<source-position filename="src/as-developer.h" line="42"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
</record>
<enumeration name="DisplaySideKind"
glib:type-name="AsDisplaySideKind"
glib:get-type="as_display_side_kind_get_type"
c:type="AsDisplaySideKind">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="153">Side a display_length requirement is for.</doc>
<member name="unknown"
value="0"
c:identifier="AS_DISPLAY_SIDE_KIND_UNKNOWN"
glib:nick="unknown"
glib:name="AS_DISPLAY_SIDE_KIND_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="155">Unknown</doc>
</member>
<member name="shortest"
value="1"
c:identifier="AS_DISPLAY_SIDE_KIND_SHORTEST"
glib:nick="shortest"
glib:name="AS_DISPLAY_SIDE_KIND_SHORTEST">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="156">Shortest side of the display rectangle.</doc>
</member>
<member name="longest"
value="2"
c:identifier="AS_DISPLAY_SIDE_KIND_LONGEST"
glib:nick="longest"
glib:name="AS_DISPLAY_SIDE_KIND_LONGEST">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="157">Longest side of the display rectangle.</doc>
</member>
<function name="from_string"
c:identifier="as_display_side_kind_from_string"
version="0.12.12">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="382">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-relation.h" line="224"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="388">a #AsDisplaySideKind or %AS_DISPLAY_SIDE_KIND_UNKNOWN for unknown</doc>
<type name="DisplaySideKind" c:type="AsDisplaySideKind"/>
</return-value>
<parameters>
<parameter name="kind_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="384">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="to_string"
c:identifier="as_display_side_kind_to_string"
version="0.12.12">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="362">Converts the enumerated value to a text representation.</doc>
<source-position filename="src/as-relation.h" line="223"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="368">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="364">the #AsDisplaySideKind.</doc>
<type name="DisplaySideKind" c:type="AsDisplaySideKind"/>
</parameter>
</parameters>
</function>
</enumeration>
<enumeration name="FormatKind"
glib:type-name="AsFormatKind"
glib:get-type="as_format_kind_get_type"
c:type="AsFormatKind">
<doc xml:space="preserve"
filename="src/as-context.h"
line="84">Format of the AppStream metadata.</doc>
<member name="unknown"
value="0"
c:identifier="AS_FORMAT_KIND_UNKNOWN"
glib:nick="unknown"
glib:name="AS_FORMAT_KIND_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-context.h"
line="86">Unknown metadata format.</doc>
</member>
<member name="xml"
value="1"
c:identifier="AS_FORMAT_KIND_XML"
glib:nick="xml"
glib:name="AS_FORMAT_KIND_XML">
<doc xml:space="preserve"
filename="src/as-context.h"
line="87">AppStream XML metadata.</doc>
</member>
<member name="yaml"
value="2"
c:identifier="AS_FORMAT_KIND_YAML"
glib:nick="yaml"
glib:name="AS_FORMAT_KIND_YAML">
<doc xml:space="preserve"
filename="src/as-context.h"
line="88">AppStream YAML (DEP-11) metadata.</doc>
</member>
<member name="desktop_entry"
value="3"
c:identifier="AS_FORMAT_KIND_DESKTOP_ENTRY"
glib:nick="desktop-entry"
glib:name="AS_FORMAT_KIND_DESKTOP_ENTRY">
<doc xml:space="preserve"
filename="src/as-context.h"
line="89">XDG Desktop Entry data.</doc>
</member>
<function name="from_string"
c:identifier="as_format_kind_from_string"
version="0.10.0">
<doc xml:space="preserve"
filename="src/as-context.c"
line="122">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-context.h" line="103"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="128">a #AsFormatKind or %AS_FORMAT_KIND_UNKNOWN for unknown</doc>
<type name="FormatKind" c:type="AsFormatKind"/>
</return-value>
<parameters>
<parameter name="kind_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="124">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="to_string"
c:identifier="as_format_kind_to_string"
version="0.10.0">
<doc xml:space="preserve"
filename="src/as-context.c"
line="102">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-context.h" line="102"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="108">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="104">the #AsFormatKind.</doc>
<type name="FormatKind" c:type="AsFormatKind"/>
</parameter>
</parameters>
</function>
</enumeration>
<enumeration name="FormatStyle"
glib:type-name="AsFormatStyle"
glib:get-type="as_format_style_get_type"
c:type="AsFormatStyle">
<doc xml:space="preserve"
filename="src/as-context.h"
line="65">There are a few differences between AppStream's metainfo files (shipped by upstream projects)
and the catalog metadata (shipped by distributors).
The data source kind indicates which style we should process.
Usually you do not want to set this explicitly.</doc>
<member name="unknown"
value="0"
c:identifier="AS_FORMAT_STYLE_UNKNOWN"
glib:nick="unknown"
glib:name="AS_FORMAT_STYLE_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-context.h"
line="67">The format style is unknown.</doc>
</member>
<member name="metainfo"
value="1"
c:identifier="AS_FORMAT_STYLE_METAINFO"
glib:nick="metainfo"
glib:name="AS_FORMAT_STYLE_METAINFO">
<doc xml:space="preserve"
filename="src/as-context.h"
line="68">Parse AppStream upstream metadata (metainfo files)</doc>
</member>
<member name="catalog"
value="2"
c:identifier="AS_FORMAT_STYLE_CATALOG"
glib:nick="catalog"
glib:name="AS_FORMAT_STYLE_CATALOG">
<doc xml:space="preserve"
filename="src/as-context.h"
line="69">Parse AppStream metadata catalog (shipped by software distributors)</doc>
</member>
</enumeration>
<enumeration name="FormatVersion"
glib:type-name="AsFormatVersion"
glib:get-type="as_format_version_get_type"
c:type="AsFormatVersion">
<doc xml:space="preserve"
filename="src/as-context.h"
line="46">Format version / API level of the AppStream metadata.</doc>
<member name="unknown"
value="0"
c:identifier="AS_FORMAT_VERSION_UNKNOWN"
glib:nick="unknown"
glib:name="AS_FORMAT_VERSION_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-context.h"
line="48">Unknown format version</doc>
</member>
<member name="v1_0"
value="1"
c:identifier="AS_FORMAT_VERSION_V1_0"
glib:nick="v1-0"
glib:name="AS_FORMAT_VERSION_V1_0">
<doc xml:space="preserve"
filename="src/as-context.h"
line="49">1.0</doc>
</member>
<function name="from_string"
c:identifier="as_format_version_from_string"
version="0.10.0">
<doc xml:space="preserve"
filename="src/as-context.c"
line="83">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-context.h" line="63"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="89">a #AsFormatVersion. For unknown, the highest version
number is assumed.</doc>
<type name="FormatVersion" c:type="AsFormatVersion"/>
</return-value>
<parameters>
<parameter name="version_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="85">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="to_string"
c:identifier="as_format_version_to_string"
version="0.10.0">
<doc xml:space="preserve"
filename="src/as-context.c"
line="65">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-context.h" line="62"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="71">string version of @version</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="version" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="67">the #AsFormatKind.</doc>
<type name="FormatVersion" c:type="AsFormatVersion"/>
</parameter>
</parameters>
</function>
</enumeration>
<class name="Icon"
c:symbol-prefix="icon"
c:type="AsIcon"
parent="GObject.Object"
glib:type-name="AsIcon"
glib:get-type="as_icon_get_type"
glib:type-struct="IconClass">
<source-position filename="src/as-icon.h" line="44"/>
<constructor name="new" c:identifier="as_icon_new">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="463">Creates a new #AsIcon.</doc>
<source-position filename="src/as-icon.h" line="69"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="468">a #AsIcon</doc>
<type name="Icon" c:type="AsIcon*"/>
</return-value>
</constructor>
<method name="get_filename" c:identifier="as_icon_get_filename">
<source-position filename="src/as-icon.h" line="80"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="228">The absolute path for the icon on disk.
This is only set for icons of kind %AS_ICON_KIND_LOCAL or
%AS_ICON_KIND_CACHED.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="icon" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="226">a #AsIcon instance.</doc>
<type name="Icon" c:type="AsIcon*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_height" c:identifier="as_icon_get_height">
<source-position filename="src/as-icon.h" line="86"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="289">The icon height in pixels, or 0 if unknown.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="icon" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="287">a #AsIcon instance.</doc>
<type name="Icon" c:type="AsIcon*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_kind" c:identifier="as_icon_get_kind">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="125">Gets the icon kind.</doc>
<source-position filename="src/as-icon.h" line="71"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="131">the #AsIconKind</doc>
<type name="IconKind" c:type="AsIconKind"/>
</return-value>
<parameters>
<instance-parameter name="icon" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="127">a #AsIcon instance.</doc>
<type name="Icon" c:type="AsIcon*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_name" c:identifier="as_icon_get_name">
<source-position filename="src/as-icon.h" line="74"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="158">the stock name of the icon. In case the icon is not of kind
"stock", the basename of the icon filename or URL is returned.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="icon" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="156">a #AsIcon instance.</doc>
<type name="Icon" c:type="AsIcon*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_scale"
c:identifier="as_icon_get_scale"
version="0.11.0">
<source-position filename="src/as-icon.h" line="89"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="316">The icon scaling factor.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="icon" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="314">a #AsIcon instance.</doc>
<type name="Icon" c:type="AsIcon*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_url" c:identifier="as_icon_get_url">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="190">Gets the icon URL, pointing at a remote location. HTTPS and FTP urls are allowed.
This property is only set for icons of type %AS_ICON_KIND_REMOTE</doc>
<source-position filename="src/as-icon.h" line="77"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="197">the URL</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="icon" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="192">a #AsIcon instance.</doc>
<type name="Icon" c:type="AsIcon*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_width" c:identifier="as_icon_get_width">
<source-position filename="src/as-icon.h" line="83"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="262">The icon width in pixels, or 0 if unknown.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="icon" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="260">a #AsIcon instance.</doc>
<type name="Icon" c:type="AsIcon*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_filename" c:identifier="as_icon_set_filename">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="239">Sets the icon absolute filename.</doc>
<source-position filename="src/as-icon.h" line="81"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="icon" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="241">a #AsIcon instance.</doc>
<type name="Icon" c:type="AsIcon*"/>
</instance-parameter>
<parameter name="filename" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="242">the new icon URL.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_height" c:identifier="as_icon_set_height">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="298">Sets the icon height.</doc>
<source-position filename="src/as-icon.h" line="87"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="icon" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="300">a #AsIcon instance.</doc>
<type name="Icon" c:type="AsIcon*"/>
</instance-parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="301">the height in pixels.</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="set_kind" c:identifier="as_icon_set_kind">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="140">Sets the icon kind.</doc>
<source-position filename="src/as-icon.h" line="72"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="icon" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="142">a #AsIcon instance.</doc>
<type name="Icon" c:type="AsIcon*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="143">the #AsIconKind, e.g. %AS_ICON_KIND_CACHED.</doc>
<type name="IconKind" c:type="AsIconKind"/>
</parameter>
</parameters>
</method>
<method name="set_name" c:identifier="as_icon_set_name">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="176">Sets the stock name or basename to use for the icon.</doc>
<source-position filename="src/as-icon.h" line="75"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="icon" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="178">a #AsIcon instance.</doc>
<type name="Icon" c:type="AsIcon*"/>
</instance-parameter>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="179">the icon stock name, e.g. "gwenview"</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_scale"
c:identifier="as_icon_set_scale"
version="0.11.0">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="327">Sets the icon scaling factor used for HiDPI displays.</doc>
<source-position filename="src/as-icon.h" line="90"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="icon" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="329">a #AsIcon instance.</doc>
<type name="Icon" c:type="AsIcon*"/>
</instance-parameter>
<parameter name="scale" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="330">the icon scaling factor.</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="set_url" c:identifier="as_icon_set_url">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="210">Sets the icon URL.</doc>
<source-position filename="src/as-icon.h" line="78"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="icon" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="212">a #AsIcon instance.</doc>
<type name="Icon" c:type="AsIcon*"/>
</instance-parameter>
<parameter name="url" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="213">the new icon URL.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_width" c:identifier="as_icon_set_width">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="271">Sets the icon width.</doc>
<source-position filename="src/as-icon.h" line="84"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="icon" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="273">a #AsIcon instance.</doc>
<type name="Icon" c:type="AsIcon*"/>
</instance-parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="274">the width in pixels.</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<record name="IconClass"
c:type="AsIconClass"
glib:is-gtype-struct-for="Icon">
<source-position filename="src/as-icon.h" line="44"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_as_reserved1" introspectable="0">
<callback name="_as_reserved1">
<source-position filename="src/as-icon.h" line="38"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved2" introspectable="0">
<callback name="_as_reserved2">
<source-position filename="src/as-icon.h" line="39"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved3" introspectable="0">
<callback name="_as_reserved3">
<source-position filename="src/as-icon.h" line="40"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved4" introspectable="0">
<callback name="_as_reserved4">
<source-position filename="src/as-icon.h" line="41"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved5" introspectable="0">
<callback name="_as_reserved5">
<source-position filename="src/as-icon.h" line="42"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved6" introspectable="0">
<callback name="_as_reserved6">
<source-position filename="src/as-icon.h" line="43"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
</record>
<enumeration name="IconKind"
glib:type-name="AsIconKind"
glib:get-type="as_icon_kind_get_type"
c:type="AsIconKind">
<doc xml:space="preserve"
filename="src/as-icon.h"
line="46">The icon type.</doc>
<member name="unknown"
value="0"
c:identifier="AS_ICON_KIND_UNKNOWN"
glib:nick="unknown"
glib:name="AS_ICON_KIND_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-icon.h"
line="48">Unknown icon kind</doc>
</member>
<member name="stock"
value="1"
c:identifier="AS_ICON_KIND_STOCK"
glib:nick="stock"
glib:name="AS_ICON_KIND_STOCK">
<doc xml:space="preserve"
filename="src/as-icon.h"
line="49">Stock icon name</doc>
</member>
<member name="cached"
value="2"
c:identifier="AS_ICON_KIND_CACHED"
glib:nick="cached"
glib:name="AS_ICON_KIND_CACHED">
<doc xml:space="preserve"
filename="src/as-icon.h"
line="50">Icon in the internal caches</doc>
</member>
<member name="local"
value="3"
c:identifier="AS_ICON_KIND_LOCAL"
glib:nick="local"
glib:name="AS_ICON_KIND_LOCAL">
<doc xml:space="preserve"
filename="src/as-icon.h"
line="51">Local icon name</doc>
</member>
<member name="remote"
value="4"
c:identifier="AS_ICON_KIND_REMOTE"
glib:nick="remote"
glib:name="AS_ICON_KIND_REMOTE">
<doc xml:space="preserve"
filename="src/as-icon.h"
line="52">Remote icon URL</doc>
</member>
<function name="from_string" c:identifier="as_icon_kind_from_string">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="67">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-icon.h" line="66"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="73">a #AsIconKind or %AS_ICON_KIND_UNKNOWN for unknown</doc>
<type name="IconKind" c:type="AsIconKind"/>
</return-value>
<parameters>
<parameter name="kind_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="69">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="to_string" c:identifier="as_icon_kind_to_string">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="45">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-icon.h" line="67"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="51">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="47">the %AsIconKind.</doc>
<type name="IconKind" c:type="AsIconKind"/>
</parameter>
</parameters>
</function>
</enumeration>
<class name="Image"
c:symbol-prefix="image"
c:type="AsImage"
parent="GObject.Object"
glib:type-name="AsImage"
glib:get-type="as_image_get_type"
glib:type-struct="ImageClass">
<source-position filename="src/as-image.h" line="44"/>
<constructor name="new" c:identifier="as_image_new">
<doc xml:space="preserve"
filename="src/as-image.c"
line="537">Creates a new #AsImage.</doc>
<source-position filename="src/as-image.h" line="65"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-image.c"
line="542">a #AsImage</doc>
<type name="Image" c:type="AsImage*"/>
</return-value>
</constructor>
<method name="get_height" c:identifier="as_image_get_height">
<doc xml:space="preserve"
filename="src/as-image.c"
line="210">Gets the image height.</doc>
<source-position filename="src/as-image.h" line="76"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-image.c"
line="216">height in pixels</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="image" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-image.c"
line="212">an #AsImage instance.</doc>
<type name="Image" c:type="AsImage*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_kind" c:identifier="as_image_get_kind">
<doc xml:space="preserve"
filename="src/as-image.c"
line="132">Gets the image kind.</doc>
<source-position filename="src/as-image.h" line="67"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-image.c"
line="138">the #AsImageKind</doc>
<type name="ImageKind" c:type="AsImageKind"/>
</return-value>
<parameters>
<instance-parameter name="image" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-image.c"
line="134">an #AsImage instance.</doc>
<type name="Image" c:type="AsImage*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_locale"
c:identifier="as_image_get_locale"
version="0.9.5">
<doc xml:space="preserve"
filename="src/as-image.c"
line="273">Get locale for this image.</doc>
<source-position filename="src/as-image.h" line="82"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-image.c"
line="279">Locale string</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="image" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-image.c"
line="275">an #AsImage instance.</doc>
<type name="Image" c:type="AsImage*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_scale" c:identifier="as_image_get_scale">
<doc xml:space="preserve"
filename="src/as-image.c"
line="241">Gets the image integer scale factor.</doc>
<source-position filename="src/as-image.h" line="79"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-image.c"
line="247">the scale factor.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="image" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-image.c"
line="243">an #AsImage instance.</doc>
<type name="Image" c:type="AsImage*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_url" c:identifier="as_image_get_url">
<doc xml:space="preserve"
filename="src/as-image.c"
line="148">Gets the full qualified URL for the image, usually pointing at some mirror.</doc>
<source-position filename="src/as-image.h" line="70"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-image.c"
line="154">URL</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="image" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-image.c"
line="150">an #AsImage instance.</doc>
<type name="Image" c:type="AsImage*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_width" c:identifier="as_image_get_width">
<doc xml:space="preserve"
filename="src/as-image.c"
line="179">Gets the image width.</doc>
<source-position filename="src/as-image.h" line="73"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-image.c"
line="185">width in pixels</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="image" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-image.c"
line="181">an #AsImage instance.</doc>
<type name="Image" c:type="AsImage*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_height" c:identifier="as_image_set_height">
<doc xml:space="preserve"
filename="src/as-image.c"
line="226">Sets the image height.</doc>
<source-position filename="src/as-image.h" line="77"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="image" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-image.c"
line="228">an #AsImage instance.</doc>
<type name="Image" c:type="AsImage*"/>
</instance-parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-image.c"
line="229">the height in pixels.</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="set_kind" c:identifier="as_image_set_kind">
<doc xml:space="preserve"
filename="src/as-image.c"
line="117">Sets the image kind.</doc>
<source-position filename="src/as-image.h" line="68"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="image" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-image.c"
line="119">an #AsImage instance.</doc>
<type name="Image" c:type="AsImage*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-image.c"
line="120">the #AsImageKind, e.g. %AS_IMAGE_KIND_THUMBNAIL.</doc>
<type name="ImageKind" c:type="AsImageKind"/>
</parameter>
</parameters>
</method>
<method name="set_locale"
c:identifier="as_image_set_locale"
version="0.9.5">
<doc xml:space="preserve"
filename="src/as-image.c"
line="290">Sets the locale for this image.</doc>
<source-position filename="src/as-image.h" line="83"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="image" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-image.c"
line="292">an #AsImage instance.</doc>
<type name="Image" c:type="AsImage*"/>
</instance-parameter>
<parameter name="locale" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-image.c"
line="293">the BCP47 locale string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_scale" c:identifier="as_image_set_scale">
<doc xml:space="preserve"
filename="src/as-image.c"
line="257">Sets the image scale factor.</doc>
<source-position filename="src/as-image.h" line="80"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="image" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-image.c"
line="259">an #AsImage instance.</doc>
<type name="Image" c:type="AsImage*"/>
</instance-parameter>
<parameter name="scale" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-image.c"
line="260">the integer scale factor, e.g. 2</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="set_url" c:identifier="as_image_set_url">
<doc xml:space="preserve"
filename="src/as-image.c"
line="164">Sets the fully-qualified mirror URL to use for the image.</doc>
<source-position filename="src/as-image.h" line="71"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="image" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-image.c"
line="166">an #AsImage instance.</doc>
<type name="Image" c:type="AsImage*"/>
</instance-parameter>
<parameter name="url" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-image.c"
line="167">the URL.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_width" c:identifier="as_image_set_width">
<doc xml:space="preserve"
filename="src/as-image.c"
line="195">Sets the image width.</doc>
<source-position filename="src/as-image.h" line="74"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="image" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-image.c"
line="197">an #AsImage instance.</doc>
<type name="Image" c:type="AsImage*"/>
</instance-parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-image.c"
line="198">the width in pixels.</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<record name="ImageClass"
c:type="AsImageClass"
glib:is-gtype-struct-for="Image">
<source-position filename="src/as-image.h" line="44"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_as_reserved1" introspectable="0">
<callback name="_as_reserved1">
<source-position filename="src/as-image.h" line="38"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved2" introspectable="0">
<callback name="_as_reserved2">
<source-position filename="src/as-image.h" line="39"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved3" introspectable="0">
<callback name="_as_reserved3">
<source-position filename="src/as-image.h" line="40"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved4" introspectable="0">
<callback name="_as_reserved4">
<source-position filename="src/as-image.h" line="41"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved5" introspectable="0">
<callback name="_as_reserved5">
<source-position filename="src/as-image.h" line="42"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved6" introspectable="0">
<callback name="_as_reserved6">
<source-position filename="src/as-image.h" line="43"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
</record>
<enumeration name="ImageKind"
glib:type-name="AsImageKind"
glib:get-type="as_image_kind_get_type"
c:type="AsImageKind">
<doc xml:space="preserve"
filename="src/as-image.h"
line="46">The image type.</doc>
<member name="unknown"
value="0"
c:identifier="AS_IMAGE_KIND_UNKNOWN"
glib:nick="unknown"
glib:name="AS_IMAGE_KIND_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-image.h"
line="48">Type invalid or not known</doc>
</member>
<member name="source"
value="1"
c:identifier="AS_IMAGE_KIND_SOURCE"
glib:nick="source"
glib:name="AS_IMAGE_KIND_SOURCE">
<doc xml:space="preserve"
filename="src/as-image.h"
line="49">The source image at full resolution</doc>
</member>
<member name="thumbnail"
value="2"
c:identifier="AS_IMAGE_KIND_THUMBNAIL"
glib:nick="thumbnail"
glib:name="AS_IMAGE_KIND_THUMBNAIL">
<doc xml:space="preserve"
filename="src/as-image.h"
line="50">A thumbnail at reduced resolution</doc>
</member>
<function name="from_string" c:identifier="as_image_kind_from_string">
<doc xml:space="preserve"
filename="src/as-image.c"
line="79">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-image.h" line="62"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-image.c"
line="85">a #AsImageKind, or %AS_IMAGE_KIND_UNKNOWN for unknown.</doc>
<type name="ImageKind" c:type="AsImageKind"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-image.c"
line="81">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="to_string" c:identifier="as_image_kind_to_string">
<doc xml:space="preserve"
filename="src/as-image.c"
line="98">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-image.h" line="63"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-image.c"
line="104">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-image.c"
line="100">the #AsImageKind.</doc>
<type name="ImageKind" c:type="AsImageKind"/>
</parameter>
</parameters>
</function>
</enumeration>
<enumeration name="InternetKind"
version="0.15.5"
glib:type-name="AsInternetKind"
glib:get-type="as_internet_kind_get_type"
c:type="AsInternetKind">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="169">Different internet connectivity requirements or recommendations for an
application.</doc>
<member name="unknown"
value="0"
c:identifier="AS_INTERNET_KIND_UNKNOWN"
glib:nick="unknown"
glib:name="AS_INTERNET_KIND_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="171">Unknown</doc>
</member>
<member name="always"
value="1"
c:identifier="AS_INTERNET_KIND_ALWAYS"
glib:nick="always"
glib:name="AS_INTERNET_KIND_ALWAYS">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="172">Always requires/recommends internet</doc>
</member>
<member name="offline_only"
value="2"
c:identifier="AS_INTERNET_KIND_OFFLINE_ONLY"
glib:nick="offline-only"
glib:name="AS_INTERNET_KIND_OFFLINE_ONLY">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="173">Application is offline-only</doc>
</member>
<member name="first_run"
value="3"
c:identifier="AS_INTERNET_KIND_FIRST_RUN"
glib:nick="first-run"
glib:name="AS_INTERNET_KIND_FIRST_RUN">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="174">Requires/Recommends internet on first run only</doc>
</member>
<function name="from_string"
c:identifier="as_internet_kind_from_string"
version="0.15.5">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="404">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-relation.h" line="227"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="410">a #AsInternetKind or %AS_INTERNET_KIND_UNKNOWN for unknown</doc>
<type name="InternetKind" c:type="AsInternetKind"/>
</return-value>
<parameters>
<parameter name="kind_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="406">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="to_string"
c:identifier="as_internet_kind_to_string"
version="0.15.5">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="426">Converts the enumerated value to a text representation.</doc>
<source-position filename="src/as-relation.h" line="226"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="432">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="428">the #AsInternetKind.</doc>
<type name="InternetKind" c:type="AsInternetKind"/>
</parameter>
</parameters>
</function>
</enumeration>
<class name="Issue"
c:symbol-prefix="issue"
c:type="AsIssue"
parent="GObject.Object"
glib:type-name="AsIssue"
glib:get-type="as_issue_get_type"
glib:type-struct="IssueClass">
<source-position filename="src/as-issue.h" line="44"/>
<constructor name="new" c:identifier="as_issue_new">
<doc xml:space="preserve"
filename="src/as-issue.c"
line="335">Creates a new #AsIssue.</doc>
<source-position filename="src/as-issue.h" line="65"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-issue.c"
line="340">an #AsIssue</doc>
<type name="Issue" c:type="AsIssue*"/>
</return-value>
</constructor>
<method name="get_id" c:identifier="as_issue_get_id">
<doc xml:space="preserve"
filename="src/as-issue.c"
line="137">Gets the issue ID (usually a bug number or CVE ID)</doc>
<source-position filename="src/as-issue.h" line="70"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-issue.c"
line="143">the ID.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="issue" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-issue.c"
line="139">a #AsIssue instance.</doc>
<type name="Issue" c:type="AsIssue*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_kind" c:identifier="as_issue_get_kind">
<doc xml:space="preserve"
filename="src/as-issue.c"
line="108">Gets the issue type.</doc>
<source-position filename="src/as-issue.h" line="67"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-issue.c"
line="114">the #AsIssueKind</doc>
<type name="IssueKind" c:type="AsIssueKind"/>
</return-value>
<parameters>
<instance-parameter name="issue" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-issue.c"
line="110">a #AsIssue instance.</doc>
<type name="Issue" c:type="AsIssue*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_url" c:identifier="as_issue_get_url">
<doc xml:space="preserve"
filename="src/as-issue.c"
line="167">Gets the URL associacted with this issue, usually
referencing a bug report or issue description.</doc>
<source-position filename="src/as-issue.h" line="73"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-issue.c"
line="174">the URL.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="issue" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-issue.c"
line="169">a #AsIssue instance.</doc>
<type name="Issue" c:type="AsIssue*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_id" c:identifier="as_issue_set_id">
<doc xml:space="preserve"
filename="src/as-issue.c"
line="152">Sets the issue ID.</doc>
<source-position filename="src/as-issue.h" line="71"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="issue" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-issue.c"
line="154">a #AsIssue instance.</doc>
<type name="Issue" c:type="AsIssue*"/>
</instance-parameter>
<parameter name="id" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-issue.c"
line="155">the new ID.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_kind" c:identifier="as_issue_set_kind">
<doc xml:space="preserve"
filename="src/as-issue.c"
line="123">Sets the issue type.</doc>
<source-position filename="src/as-issue.h" line="68"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="issue" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-issue.c"
line="125">a #AsIssue instance.</doc>
<type name="Issue" c:type="AsIssue*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-issue.c"
line="126">the #AsIssueKind, e.g. %AS_ISSUE_KIND_SHA256.</doc>
<type name="IssueKind" c:type="AsIssueKind"/>
</parameter>
</parameters>
</method>
<method name="set_url" c:identifier="as_issue_set_url">
<doc xml:space="preserve"
filename="src/as-issue.c"
line="189">Sets an URL describing this issue.</doc>
<source-position filename="src/as-issue.h" line="74"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="issue" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-issue.c"
line="191">a #AsIssue instance.</doc>
<type name="Issue" c:type="AsIssue*"/>
</instance-parameter>
<parameter name="url" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-issue.c"
line="192">the new URL.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<record name="IssueClass"
c:type="AsIssueClass"
glib:is-gtype-struct-for="Issue">
<source-position filename="src/as-issue.h" line="44"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_as_reserved1" introspectable="0">
<callback name="_as_reserved1">
<source-position filename="src/as-issue.h" line="38"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved2" introspectable="0">
<callback name="_as_reserved2">
<source-position filename="src/as-issue.h" line="39"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved3" introspectable="0">
<callback name="_as_reserved3">
<source-position filename="src/as-issue.h" line="40"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved4" introspectable="0">
<callback name="_as_reserved4">
<source-position filename="src/as-issue.h" line="41"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved5" introspectable="0">
<callback name="_as_reserved5">
<source-position filename="src/as-issue.h" line="42"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved6" introspectable="0">
<callback name="_as_reserved6">
<source-position filename="src/as-issue.h" line="43"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
</record>
<enumeration name="IssueKind"
glib:type-name="AsIssueKind"
glib:get-type="as_issue_kind_get_type"
c:type="AsIssueKind">
<doc xml:space="preserve"
filename="src/as-issue.h"
line="46">Checksums supported by #AsRelease</doc>
<member name="unknown"
value="0"
c:identifier="AS_ISSUE_KIND_UNKNOWN"
glib:nick="unknown"
glib:name="AS_ISSUE_KIND_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-issue.h"
line="48">Unknown issue type</doc>
</member>
<member name="generic"
value="1"
c:identifier="AS_ISSUE_KIND_GENERIC"
glib:nick="generic"
glib:name="AS_ISSUE_KIND_GENERIC">
<doc xml:space="preserve"
filename="src/as-issue.h"
line="49">Generic issue type</doc>
</member>
<member name="cve"
value="2"
c:identifier="AS_ISSUE_KIND_CVE"
glib:nick="cve"
glib:name="AS_ISSUE_KIND_CVE">
<doc xml:space="preserve"
filename="src/as-issue.h"
line="50">Common Vulnerabilities and Exposures issue</doc>
</member>
<function name="from_string" c:identifier="as_issue_kind_from_string">
<doc xml:space="preserve"
filename="src/as-issue.c"
line="62">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-issue.h" line="63"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-issue.c"
line="68">a #AsIssueKind or %AS_ISSUE_KIND_UNKNOWN for unknown</doc>
<type name="IssueKind" c:type="AsIssueKind"/>
</return-value>
<parameters>
<parameter name="kind_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-issue.c"
line="64">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="to_string" c:identifier="as_issue_kind_to_string">
<doc xml:space="preserve"
filename="src/as-issue.c"
line="44">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-issue.h" line="62"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-issue.c"
line="50">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-issue.c"
line="46">the %AsIssueKind.</doc>
<type name="IssueKind" c:type="AsIssueKind"/>
</parameter>
</parameters>
</function>
</enumeration>
<enumeration name="IssueSeverity"
glib:type-name="AsIssueSeverity"
glib:get-type="as_issue_severity_get_type"
c:type="AsIssueSeverity">
<doc xml:space="preserve"
filename="src/as-validator-issue.h"
line="46">The severity of an issue found by #AsValidator</doc>
<member name="unknown"
value="0"
c:identifier="AS_ISSUE_SEVERITY_UNKNOWN"
glib:nick="unknown"
glib:name="AS_ISSUE_SEVERITY_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-validator-issue.h"
line="48">The severity is unknown.</doc>
</member>
<member name="pedantic"
value="1"
c:identifier="AS_ISSUE_SEVERITY_PEDANTIC"
glib:nick="pedantic"
glib:name="AS_ISSUE_SEVERITY_PEDANTIC">
<doc xml:space="preserve"
filename="src/as-validator-issue.h"
line="49">Pedantic information about ways to improve the data, but could also be ignored.</doc>
</member>
<member name="info"
value="2"
c:identifier="AS_ISSUE_SEVERITY_INFO"
glib:nick="info"
glib:name="AS_ISSUE_SEVERITY_INFO">
<doc xml:space="preserve"
filename="src/as-validator-issue.h"
line="50">Non-essential information on how to improve metadata, no immediate action needed.</doc>
</member>
<member name="warning"
value="3"
c:identifier="AS_ISSUE_SEVERITY_WARNING"
glib:nick="warning"
glib:name="AS_ISSUE_SEVERITY_WARNING">
<doc xml:space="preserve"
filename="src/as-validator-issue.h"
line="51">Something metadata issue which should be fixed as soon as possible.</doc>
</member>
<member name="error"
value="4"
c:identifier="AS_ISSUE_SEVERITY_ERROR"
glib:nick="error"
glib:name="AS_ISSUE_SEVERITY_ERROR">
<doc xml:space="preserve"
filename="src/as-validator-issue.h"
line="52">There is a serious, fatal error in your metadata</doc>
</member>
<function name="from_string"
c:identifier="as_issue_severity_from_string">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="51">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-validator-issue.h" line="66"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="57">a #AsIssueSeverity, or %AS_ISSUE_SEVERITY_UNKNOWN for unknown.</doc>
<type name="IssueSeverity" c:type="AsIssueSeverity"/>
</return-value>
<parameters>
<parameter name="str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="53">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="to_string" c:identifier="as_issue_severity_to_string">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="74">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-validator-issue.h" line="67"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="80">string version of @severity</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="severity" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="76">the #AsIssueSeverity.</doc>
<type name="IssueSeverity" c:type="AsIssueSeverity"/>
</parameter>
</parameters>
</function>
</enumeration>
<class name="Launchable"
c:symbol-prefix="launchable"
c:type="AsLaunchable"
parent="GObject.Object"
glib:type-name="AsLaunchable"
glib:get-type="as_launchable_get_type"
glib:type-struct="LaunchableClass">
<source-position filename="src/as-launchable.h" line="44"/>
<constructor name="new"
c:identifier="as_launchable_new"
version="0.11.0">
<doc xml:space="preserve"
filename="src/as-launchable.c"
line="265">Creates a new #AsLaunchable.</doc>
<source-position filename="src/as-launchable.h" line="69"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-launchable.c"
line="270">a #AsLaunchable</doc>
<type name="Launchable" c:type="AsLaunchable*"/>
</return-value>
</constructor>
<method name="add_entry"
c:identifier="as_launchable_add_entry"
version="0.11.0">
<doc xml:space="preserve"
filename="src/as-launchable.c"
line="183">Add a new launchable entry.</doc>
<source-position filename="src/as-launchable.h" line="75"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="launch" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-launchable.c"
line="185">a #AsLaunchable instance.</doc>
<type name="Launchable" c:type="AsLaunchable*"/>
</instance-parameter>
<parameter name="entry" transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="get_entries"
c:identifier="as_launchable_get_entries"
version="0.11.0">
<doc xml:space="preserve"
filename="src/as-launchable.c"
line="166">Get an array of launchable entries.</doc>
<source-position filename="src/as-launchable.h" line="74"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-launchable.c"
line="172">An string list of launch entries.</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="utf8"/>
</array>
</return-value>
<parameters>
<instance-parameter name="launch" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-launchable.c"
line="168">a #AsLaunchable instance.</doc>
<type name="Launchable" c:type="AsLaunchable*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_kind"
c:identifier="as_launchable_get_kind"
version="0.11.0">
<doc xml:space="preserve"
filename="src/as-launchable.c"
line="131">The launch system for the entries this #AsLaunchable
object stores.</doc>
<source-position filename="src/as-launchable.h" line="71"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-launchable.c"
line="138">an enum of type #AsLaunchableKind</doc>
<type name="LaunchableKind" c:type="AsLaunchableKind"/>
</return-value>
<parameters>
<instance-parameter name="launch" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-launchable.c"
line="133">a #AsLaunchable instance.</doc>
<type name="Launchable" c:type="AsLaunchable*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_kind"
c:identifier="as_launchable_set_kind"
version="0.11.0">
<doc xml:space="preserve"
filename="src/as-launchable.c"
line="149">Set the launch system for the entries this #AsLaunchable
object stores.</doc>
<source-position filename="src/as-launchable.h" line="72"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="launch" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-launchable.c"
line="151">a #AsLaunchable instance.</doc>
<type name="Launchable" c:type="AsLaunchable*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-launchable.c"
line="152">the new #AsLaunchableKind</doc>
<type name="LaunchableKind" c:type="AsLaunchableKind"/>
</parameter>
</parameters>
</method>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<record name="LaunchableClass"
c:type="AsLaunchableClass"
glib:is-gtype-struct-for="Launchable">
<source-position filename="src/as-launchable.h" line="44"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_as_reserved1" introspectable="0">
<callback name="_as_reserved1">
<source-position filename="src/as-launchable.h" line="38"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved2" introspectable="0">
<callback name="_as_reserved2">
<source-position filename="src/as-launchable.h" line="39"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved3" introspectable="0">
<callback name="_as_reserved3">
<source-position filename="src/as-launchable.h" line="40"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved4" introspectable="0">
<callback name="_as_reserved4">
<source-position filename="src/as-launchable.h" line="41"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved5" introspectable="0">
<callback name="_as_reserved5">
<source-position filename="src/as-launchable.h" line="42"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved6" introspectable="0">
<callback name="_as_reserved6">
<source-position filename="src/as-launchable.h" line="43"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
</record>
<enumeration name="LaunchableKind"
glib:type-name="AsLaunchableKind"
glib:get-type="as_launchable_kind_get_type"
c:type="AsLaunchableKind">
<doc xml:space="preserve"
filename="src/as-launchable.h"
line="46">Type of launch system the entries belong to.</doc>
<member name="unknown"
value="0"
c:identifier="AS_LAUNCHABLE_KIND_UNKNOWN"
glib:nick="unknown"
glib:name="AS_LAUNCHABLE_KIND_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-launchable.h"
line="48">Unknown kind</doc>
</member>
<member name="desktop_id"
value="1"
c:identifier="AS_LAUNCHABLE_KIND_DESKTOP_ID"
glib:nick="desktop-id"
glib:name="AS_LAUNCHABLE_KIND_DESKTOP_ID">
<doc xml:space="preserve"
filename="src/as-launchable.h"
line="49">Launch by desktop-id</doc>
</member>
<member name="service"
value="2"
c:identifier="AS_LAUNCHABLE_KIND_SERVICE"
glib:nick="service"
glib:name="AS_LAUNCHABLE_KIND_SERVICE">
<doc xml:space="preserve"
filename="src/as-launchable.h"
line="50">A systemd/SysV-init service name</doc>
</member>
<member name="cockpit_manifest"
value="3"
c:identifier="AS_LAUNCHABLE_KIND_COCKPIT_MANIFEST"
glib:nick="cockpit-manifest"
glib:name="AS_LAUNCHABLE_KIND_COCKPIT_MANIFEST">
<doc xml:space="preserve"
filename="src/as-launchable.h"
line="51">A Cockpit manifest / package name</doc>
</member>
<member name="url"
value="4"
c:identifier="AS_LAUNCHABLE_KIND_URL"
glib:nick="url"
glib:name="AS_LAUNCHABLE_KIND_URL">
<doc xml:space="preserve"
filename="src/as-launchable.h"
line="52">A web HTTPS URL to launch a web application from</doc>
</member>
<function name="from_string"
c:identifier="as_launchable_kind_from_string"
version="0.11.0">
<doc xml:space="preserve"
filename="src/as-launchable.c"
line="71">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-launchable.h" line="67"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-launchable.c"
line="77">a #AsLaunchableKind or %AS_LAUNCHABLE_KIND_UNKNOWN for unknown</doc>
<type name="LaunchableKind" c:type="AsLaunchableKind"/>
</return-value>
<parameters>
<parameter name="kind_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-launchable.c"
line="73">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="to_string"
c:identifier="as_launchable_kind_to_string"
version="0.11.0">
<doc xml:space="preserve"
filename="src/as-launchable.c"
line="47">Converts the enumerated value to a text representation.</doc>
<source-position filename="src/as-launchable.h" line="66"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-launchable.c"
line="53">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-launchable.c"
line="49">the #AsLaunchableKind.</doc>
<type name="LaunchableKind" c:type="AsLaunchableKind"/>
</parameter>
</parameters>
</function>
</enumeration>
<constant name="MAJOR_VERSION" value="1" c:type="AS_MAJOR_VERSION">
<source-position filename="src/as-version.h" line="34"/>
<type name="gint" c:type="gint"/>
</constant>
<constant name="MICRO_VERSION" value="4" c:type="AS_MICRO_VERSION">
<source-position filename="src/as-version.h" line="36"/>
<type name="gint" c:type="gint"/>
</constant>
<constant name="MINOR_VERSION" value="0" c:type="AS_MINOR_VERSION">
<source-position filename="src/as-version.h" line="35"/>
<type name="gint" c:type="gint"/>
</constant>
<enumeration name="MarkupKind"
glib:type-name="AsMarkupKind"
glib:get-type="as_markup_kind_get_type"
c:type="AsMarkupKind">
<doc xml:space="preserve"
filename="src/as-utils.h"
line="89">Text markup types.</doc>
<member name="unknown"
value="0"
c:identifier="AS_MARKUP_KIND_UNKNOWN"
glib:nick="unknown"
glib:name="AS_MARKUP_KIND_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-utils.h"
line="91">Unknown markup.</doc>
</member>
<member name="xml"
value="1"
c:identifier="AS_MARKUP_KIND_XML"
glib:nick="xml"
glib:name="AS_MARKUP_KIND_XML">
<doc xml:space="preserve"
filename="src/as-utils.h"
line="92">XML markup.</doc>
</member>
<member name="text"
value="2"
c:identifier="AS_MARKUP_KIND_TEXT"
glib:nick="text"
glib:name="AS_MARKUP_KIND_TEXT">
<doc xml:space="preserve"
filename="src/as-utils.h"
line="93">Simple text with unicode symbols.</doc>
</member>
<member name="markdown"
value="3"
c:identifier="AS_MARKUP_KIND_MARKDOWN"
glib:nick="markdown"
glib:name="AS_MARKUP_KIND_MARKDOWN">
<doc xml:space="preserve"
filename="src/as-utils.h"
line="94">Markdown</doc>
</member>
</enumeration>
<enumeration name="MergeKind"
glib:type-name="AsMergeKind"
glib:get-type="as_merge_kind_get_type"
c:type="AsMergeKind">
<doc xml:space="preserve"
filename="src/as-component.h"
line="115">Defines how #AsComponent data should be merged if the component is
set for merge.</doc>
<member name="none"
value="0"
c:identifier="AS_MERGE_KIND_NONE"
glib:nick="none"
glib:name="AS_MERGE_KIND_NONE">
<doc xml:space="preserve"
filename="src/as-component.h"
line="117">No merge is happening.</doc>
</member>
<member name="replace"
value="1"
c:identifier="AS_MERGE_KIND_REPLACE"
glib:nick="replace"
glib:name="AS_MERGE_KIND_REPLACE">
<doc xml:space="preserve"
filename="src/as-component.h"
line="118">Merge replacing data of target.</doc>
</member>
<member name="append"
value="2"
c:identifier="AS_MERGE_KIND_APPEND"
glib:nick="append"
glib:name="AS_MERGE_KIND_APPEND">
<doc xml:space="preserve"
filename="src/as-component.h"
line="119">Merge appending data to target.</doc>
</member>
<member name="remove_component"
value="3"
c:identifier="AS_MERGE_KIND_REMOVE_COMPONENT"
glib:nick="remove-component"
glib:name="AS_MERGE_KIND_REMOVE_COMPONENT">
<doc xml:space="preserve"
filename="src/as-component.h"
line="120">Remove the entire component if it matches.</doc>
</member>
<function name="from_string" c:identifier="as_merge_kind_from_string">
<doc xml:space="preserve"
filename="src/as-component.c"
line="276">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-component.h" line="135"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="282">a #AsMergeKind or %AS_MERGE_KIND_NONE for unknown</doc>
<type name="MergeKind" c:type="AsMergeKind"/>
</return-value>
<parameters>
<parameter name="kind_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="278">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="to_string" c:identifier="as_merge_kind_to_string">
<doc xml:space="preserve"
filename="src/as-component.c"
line="253">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-component.h" line="134"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="259">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="255">the #AsMergeKind.</doc>
<type name="MergeKind" c:type="AsMergeKind"/>
</parameter>
</parameters>
</function>
</enumeration>
<class name="Metadata"
c:symbol-prefix="metadata"
c:type="AsMetadata"
parent="GObject.Object"
glib:type-name="AsMetadata"
glib:get-type="as_metadata_get_type"
glib:type-struct="MetadataClass">
<source-position filename="src/as-metadata.h" line="49"/>
<constructor name="new" c:identifier="as_metadata_new">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1772">Creates a new #AsMetadata.</doc>
<source-position filename="src/as-metadata.h" line="87"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1777">a #AsMetadata</doc>
<type name="Metadata" c:type="AsMetadata*"/>
</return-value>
</constructor>
<function name="file_guess_style"
c:identifier="as_metadata_file_guess_style"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="73">Guesses the AppStream metadata style (metainfo or catalog) based on
the filename.</doc>
<source-position filename="src/as-metadata.h" line="85"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="80">An #AsFormatStyle, e.g. %AS_FORMAT_STYLE_METAINFO.</doc>
<type name="FormatStyle" c:type="AsFormatStyle"/>
</return-value>
<parameters>
<parameter name="filename" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="75">a file name</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<method name="add_component" c:identifier="as_metadata_add_component">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1434">Add an #AsComponent to the list of components.
This can be used to add multiple components in order to
produce a distro-XML AppStream metadata file.</doc>
<source-position filename="src/as-metadata.h" line="127"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="metad" transfer-ownership="none">
<type name="Metadata" c:type="AsMetadata*"/>
</instance-parameter>
<parameter name="cpt" transfer-ownership="none">
<type name="Component" c:type="AsComponent*"/>
</parameter>
</parameters>
</method>
<method name="clear_components"
c:identifier="as_metadata_clear_components">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="177">Remove all previously parsed or manually added components.</doc>
<source-position filename="src/as-metadata.h" line="126"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="metad" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="179">an instance of #AsMetadata.</doc>
<type name="Metadata" c:type="AsMetadata*"/>
</instance-parameter>
</parameters>
</method>
<method name="clear_releases" c:identifier="as_metadata_clear_releases">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="963">Remove all previously parsed releases entries.</doc>
<source-position filename="src/as-metadata.h" line="135"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="metad" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="965">a #AsMetadata instance.</doc>
<type name="Metadata" c:type="AsMetadata*"/>
</instance-parameter>
</parameters>
</method>
<method name="component_to_metainfo"
c:identifier="as_metadata_component_to_metainfo"
throws="1">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1130">Convert an #AsComponent to metainfo data.
This will always be XML, YAML is no valid format for metainfo files.
The amount of localization included in the metadata depends on how the #AsComponent
was initially loaded and whether it contains data for all locale.
The first #AsComponent added to the internal list will be transformed.
In case no component is present, %NULL is returned.</doc>
<source-position filename="src/as-metadata.h" line="111"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1145">A string containing the XML metadata. Free with g_free()</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<instance-parameter name="metad" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1132">An instance of #AsMetadata.</doc>
<type name="Metadata" c:type="AsMetadata*"/>
</instance-parameter>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1133">The format to use (XML or YAML)</doc>
<type name="FormatKind" c:type="AsFormatKind"/>
</parameter>
</parameters>
</method>
<method name="components_to_catalog"
c:identifier="as_metadata_components_to_catalog"
throws="1">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1380">Serialize all #AsComponent instances into AppStream
catalog metadata.
%NULL is returned if there is nothing to serialize.</doc>
<source-position filename="src/as-metadata.h" line="117"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1390">A string containing the YAML or XML data. Free with g_free()</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<instance-parameter name="metad" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1382">An instance of #AsMetadata.</doc>
<type name="Metadata" c:type="AsMetadata*"/>
</instance-parameter>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1383">The format to serialize the data to (XML or YAML).</doc>
<type name="FormatKind" c:type="AsFormatKind"/>
</parameter>
</parameters>
</method>
<method name="get_architecture"
c:identifier="as_metadata_get_architecture">
<source-position filename="src/as-metadata.h" line="158"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1592">The architecture of AppStream distro metadata</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="metad" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1590">an #AsMetadata instance.</doc>
<type name="Metadata" c:type="AsMetadata*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_component" c:identifier="as_metadata_get_component">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1448">Gets the #AsComponent which has been parsed from the XML.
If the AppStream XML contained multiple components, return the last
component that has been parsed.</doc>
<source-position filename="src/as-metadata.h" line="123"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1456">An #AsComponent or %NULL</doc>
<type name="Component" c:type="AsComponent*"/>
</return-value>
<parameters>
<instance-parameter name="metad" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1450">a #AsMetadata instance.</doc>
<type name="Metadata" c:type="AsMetadata*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_components" c:identifier="as_metadata_get_components">
<source-position filename="src/as-metadata.h" line="124"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1472">an #AsComponentBox of all parsed components</doc>
<type name="ComponentBox" c:type="AsComponentBox*"/>
</return-value>
<parameters>
<instance-parameter name="metad" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1470">a #AsMetadata instance.</doc>
<type name="Metadata" c:type="AsMetadata*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_format_style"
c:identifier="as_metadata_get_format_style">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1694">Get the metadata parsing mode.</doc>
<source-position filename="src/as-metadata.h" line="140"/>
<return-value transfer-ownership="none">
<type name="FormatStyle" c:type="AsFormatStyle"/>
</return-value>
<parameters>
<instance-parameter name="metad" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1696">a #AsMetadata instance.</doc>
<type name="Metadata" c:type="AsMetadata*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_format_version"
c:identifier="as_metadata_get_format_version">
<source-position filename="src/as-metadata.h" line="137"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1605">The AppStream metadata format version.</doc>
<type name="FormatVersion" c:type="AsFormatVersion"/>
</return-value>
<parameters>
<instance-parameter name="metad" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1603">an #AsMetadata instance.</doc>
<type name="Metadata" c:type="AsMetadata*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_locale" c:identifier="as_metadata_get_locale">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1500">Gets the current active locale for parsing metadata,
or "ALL" if all locales are read.</doc>
<source-position filename="src/as-metadata.h" line="144"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1507">Locale used for metadata parsing.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="metad" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1502">a #AsMetadata instance.</doc>
<type name="Metadata" c:type="AsMetadata*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_media_baseurl"
c:identifier="as_metadata_get_media_baseurl">
<source-position filename="src/as-metadata.h" line="155"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1564">The media URL prefix.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="metad" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1562">an #AsMetadata instance.</doc>
<type name="Metadata" c:type="AsMetadata*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_origin" c:identifier="as_metadata_get_origin">
<source-position filename="src/as-metadata.h" line="146"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1535">The origin of AppStream distro metadata</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="metad" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1533">an #AsMetadata instance.</doc>
<type name="Metadata" c:type="AsMetadata*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_parse_flags"
c:identifier="as_metadata_get_parse_flags">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1721">Get the metadata parse flags.</doc>
<source-position filename="src/as-metadata.h" line="161"/>
<return-value transfer-ownership="none">
<type name="ParseFlags" c:type="AsParseFlags"/>
</return-value>
<parameters>
<instance-parameter name="metad" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1723">a #AsMetadata instance.</doc>
<type name="Metadata" c:type="AsMetadata*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_release_list"
c:identifier="as_metadata_get_release_list">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="932">Gets the recently parsed #AsReleaseList entry.</doc>
<source-position filename="src/as-metadata.h" line="133"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="938">An #AsReleaseList or %NULL</doc>
<type name="ReleaseList" c:type="AsReleaseList*"/>
</return-value>
<parameters>
<instance-parameter name="metad" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="934">a #AsMetadata instance.</doc>
<type name="Metadata" c:type="AsMetadata*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_release_lists"
c:identifier="as_metadata_get_release_lists">
<source-position filename="src/as-metadata.h" line="134"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="954">A #GPtrArray of all parsed release metadata.</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="ReleaseList"/>
</array>
</return-value>
<parameters>
<instance-parameter name="metad" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="952">a #AsMetadata instance.</doc>
<type name="Metadata" c:type="AsMetadata*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_update_existing"
c:identifier="as_metadata_get_update_existing">
<source-position filename="src/as-metadata.h" line="149"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1650">Whether existing components should be updates with the parsed data,
instead of creating new ones.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="metad" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1648">an #AsMetadata instance.</doc>
<type name="Metadata" c:type="AsMetadata*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_write_header"
c:identifier="as_metadata_get_write_header">
<source-position filename="src/as-metadata.h" line="152"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1685">Whether we will write a header/root node in catalog metadata.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="metad" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1683">an #AsMetadata instance.</doc>
<type name="Metadata" c:type="AsMetadata*"/>
</instance-parameter>
</parameters>
</method>
<method name="parse_bytes"
c:identifier="as_metadata_parse_bytes"
version="0.14.0"
throws="1">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="600">Parses any AppStream metadata into one or more #AsComponent instances.</doc>
<source-position filename="src/as-metadata.h" line="100"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="609">%TRUE on success.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="metad" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="602">An instance of #AsMetadata.</doc>
<type name="Metadata" c:type="AsMetadata*"/>
</instance-parameter>
<parameter name="bytes" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="603">Metadata describing one or more software components.</doc>
<type name="GLib.Bytes" c:type="GBytes*"/>
</parameter>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="604">The format of the data (XML or YAML).</doc>
<type name="FormatKind" c:type="AsFormatKind"/>
</parameter>
</parameters>
</method>
<method name="parse_data"
c:identifier="as_metadata_parse_data"
throws="1">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="578">Parses any AppStream metadata into one or more #AsComponent instances.</doc>
<source-position filename="src/as-metadata.h" line="95"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="588">%TRUE on success.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="metad" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="580">An instance of #AsMetadata.</doc>
<type name="Metadata" c:type="AsMetadata*"/>
</instance-parameter>
<parameter name="data" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="581">Metadata describing one or more software components as string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="data_len" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="582">Length of @data, or -1 if length is unknown and @data is NULL-terminated.</doc>
<type name="gssize" c:type="gssize"/>
</parameter>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="583">The format of the data (XML or YAML).</doc>
<type name="FormatKind" c:type="AsFormatKind"/>
</parameter>
</parameters>
</method>
<method name="parse_desktop_data"
c:identifier="as_metadata_parse_desktop_data"
throws="1">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="621">Parses XDG Desktop Entry metadata and adds it to the list of parsed entities.
Please note that not every desktop-entry file will result in a valid component
being generated, even if parsing succeeds without error (The desktiop-entry file
may be valid but not generate a component on purpose).</doc>
<source-position filename="src/as-metadata.h" line="105"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="635">%TRUE if the file was parsed without error.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="metad" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="623">An instance of #AsMetadata.</doc>
<type name="Metadata" c:type="AsMetadata*"/>
</instance-parameter>
<parameter name="cid" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="624">The component-id the new #AsComponent should have.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="data" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="625">Metadata describing one or more software components.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="data_len" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="626">The data length, or -1 if unknown and null-terminated.</doc>
<type name="gssize" c:type="gssize"/>
</parameter>
</parameters>
</method>
<method name="parse_file"
c:identifier="as_metadata_parse_file"
throws="1">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="686">Parses an AppStream upstream metadata file.
If @file does not exist, %G_IO_ERROR_NOT_FOUND will be returned. Other
#GIOErrors and #AsMetadataErrors may be returned as appropriate.</doc>
<source-position filename="src/as-metadata.h" line="90"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="698">%TRUE if the file was parsed without error.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="metad" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="688">A valid #AsMetadata instance</doc>
<type name="Metadata" c:type="AsMetadata*"/>
</instance-parameter>
<parameter name="file" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="689">#GFile for the upstream metadata</doc>
<type name="Gio.File" c:type="GFile*"/>
</parameter>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="690">The format the data is in, or %AS_FORMAT_KIND_UNKNOWN if not known.</doc>
<type name="FormatKind" c:type="AsFormatKind"/>
</parameter>
</parameters>
</method>
<method name="parse_releases_bytes"
c:identifier="as_metadata_parse_releases_bytes"
version="0.16.0"
throws="1">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="806">Parses any AppStream release metadata into #AsRelease objects.
You can retrieve the last parsed #AsReleaseList using %as_metadata_get_release_list.</doc>
<source-position filename="src/as-metadata.h" line="129"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="815">%TRUE on success.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="metad" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="808">An instance of #AsMetadata.</doc>
<type name="Metadata" c:type="AsMetadata*"/>
</instance-parameter>
<parameter name="bytes" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="809">Metadata describing release notes.</doc>
<type name="GLib.Bytes" c:type="GBytes*"/>
</parameter>
</parameters>
</method>
<method name="parse_releases_file"
c:identifier="as_metadata_parse_releases_file"
version="0.16.0"
throws="1">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="857">Parses any AppStream release metadata into #AsRelease objects
using the provided file.
You can retrieve the last parsed #AsReleaseList using %as_metadata_get_release_list.</doc>
<source-position filename="src/as-metadata.h" line="130"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="867">%TRUE on success.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="metad" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="859">A valid #AsMetadata instance</doc>
<type name="Metadata" c:type="AsMetadata*"/>
</instance-parameter>
<parameter name="file" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="860">#GFile for the release metadata</doc>
<type name="Gio.File" c:type="GFile*"/>
</parameter>
</parameters>
</method>
<method name="releases_to_data"
c:identifier="as_metadata_releases_to_data"
version="0.16.0"
throws="1">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="902">Convert a releases of an #AsReleaseList entity into a release metadata XML representation.</doc>
<source-position filename="src/as-metadata.h" line="131"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="910">The XML representation or %NULL on error.</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<instance-parameter name="metad" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="904">A valid #AsMetadata instance</doc>
<type name="Metadata" c:type="AsMetadata*"/>
</instance-parameter>
<parameter name="releases" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="905">the #AsReleaseList to convert.</doc>
<type name="ReleaseList" c:type="AsReleaseList*"/>
</parameter>
</parameters>
</method>
<method name="save_catalog"
c:identifier="as_metadata_save_catalog"
throws="1">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1102">Serialize all #AsComponent instances to XML or YAML metadata and save
the data to a file.
An existing file at the same location will be overridden.</doc>
<source-position filename="src/as-metadata.h" line="118"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1111">%TRUE if the file was written without error.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="metad" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1104">An instance of #AsMetadata.</doc>
<type name="Metadata" c:type="AsMetadata*"/>
</instance-parameter>
<parameter name="fname" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1105">The filename for the new metadata file.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="format" transfer-ownership="none">
<type name="FormatKind" c:type="AsFormatKind"/>
</parameter>
</parameters>
</method>
<method name="save_metainfo"
c:identifier="as_metadata_save_metainfo"
throws="1">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1075">Serialize #AsComponent instance to XML and save it to file.
An existing file at the same location will be overridden.</doc>
<source-position filename="src/as-metadata.h" line="112"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1083">%TRUE if the file was written without error.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="metad" transfer-ownership="none">
<type name="Metadata" c:type="AsMetadata*"/>
</instance-parameter>
<parameter name="fname" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1077">The filename for the new metadata file.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1078">The format to save this file in. Only XML is supported at time.</doc>
<type name="FormatKind" c:type="AsFormatKind"/>
</parameter>
</parameters>
</method>
<method name="set_architecture"
c:identifier="as_metadata_set_architecture">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1573">Set the architecture the components in this metadata belong to.</doc>
<source-position filename="src/as-metadata.h" line="159"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="metad" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1575">an #AsMetadata instance.</doc>
<type name="Metadata" c:type="AsMetadata*"/>
</instance-parameter>
<parameter name="arch" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1576">an architecture string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_format_style"
c:identifier="as_metadata_set_format_style">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1707">Sets the current metadata parsing mode.</doc>
<source-position filename="src/as-metadata.h" line="141"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="metad" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1709">a #AsMetadata instance.</doc>
<type name="Metadata" c:type="AsMetadata*"/>
</instance-parameter>
<parameter name="mode" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1710">the #AsFormatStyle.</doc>
<type name="FormatStyle" c:type="AsFormatStyle"/>
</parameter>
</parameters>
</method>
<method name="set_format_version"
c:identifier="as_metadata_set_format_version">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1614">Set the current AppStream format version that we should generate data for
or be able to read.</doc>
<source-position filename="src/as-metadata.h" line="138"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="metad" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1616">a #AsMetadata instance.</doc>
<type name="Metadata" c:type="AsMetadata*"/>
</instance-parameter>
<parameter name="version" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1617">the AppStream metadata format version as #AsFormatVersion.</doc>
<type name="FormatVersion" c:type="AsFormatVersion"/>
</parameter>
</parameters>
</method>
<method name="set_locale" c:identifier="as_metadata_set_locale">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1481">Sets the locale which should be read when processing metadata.
All other locales are ignored, which increases parsing speed and
reduces memory usage.
If you set the locale to "ALL", all locales will be read.</doc>
<source-position filename="src/as-metadata.h" line="143"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="metad" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1483">a #AsMetadata instance.</doc>
<type name="Metadata" c:type="AsMetadata*"/>
</instance-parameter>
<parameter name="locale" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1484">the BCP47 locale.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_media_baseurl"
c:identifier="as_metadata_set_media_baseurl">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1544">Set the base URL for all media links referenced in the metadata,
or %NULL if every component has absolute URLs.</doc>
<source-position filename="src/as-metadata.h" line="156"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="metad" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1546">an #AsMetadata instance.</doc>
<type name="Metadata" c:type="AsMetadata*"/>
</instance-parameter>
<parameter name="url" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1547">the base URL.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_origin" c:identifier="as_metadata_set_origin">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1516">Set the origin of AppStream distro metadata</doc>
<source-position filename="src/as-metadata.h" line="147"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="metad" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1518">an #AsMetadata instance.</doc>
<type name="Metadata" c:type="AsMetadata*"/>
</instance-parameter>
<parameter name="origin" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1519">the origin of AppStream distro metadata.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_parse_flags"
c:identifier="as_metadata_set_parse_flags">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1734">Sets the current metadata parse flags.</doc>
<source-position filename="src/as-metadata.h" line="162"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="metad" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1736">a #AsMetadata instance.</doc>
<type name="Metadata" c:type="AsMetadata*"/>
</instance-parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1737">the #AsParseFlags.</doc>
<type name="ParseFlags" c:type="AsParseFlags"/>
</parameter>
</parameters>
</method>
<method name="set_update_existing"
c:identifier="as_metadata_set_update_existing">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1629">If set to %TRUE, the parser will not create new components but
instead update existing components in the pool with new metadata.
NOTE: Right now, this feature is only implemented for metainfo XML parsing!</doc>
<source-position filename="src/as-metadata.h" line="150"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="metad" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1631">an #AsMetadata instance.</doc>
<type name="Metadata" c:type="AsMetadata*"/>
</instance-parameter>
<parameter name="update" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1632">A boolean value.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_write_header"
c:identifier="as_metadata_set_write_header">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1660">If set to %TRUE, tehe metadata writer will omit writing a DEP-11
header document when in YAML mode, and will not write a root components node
when writing XML data.
Please keep in mind that this will create an invalid DEP-11 YAML AppStream
catalog metadata file, and an invalid XML file.
This parameter should only be changed e.g. by the appstream-generator tool.
NOTE: Right now, this feature is only implemented for YAML!</doc>
<source-position filename="src/as-metadata.h" line="153"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="metad" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1662">an #AsMetadata instance.</doc>
<type name="Metadata" c:type="AsMetadata*"/>
</instance-parameter>
<parameter name="wheader" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1663">A boolean value.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<record name="MetadataClass"
c:type="AsMetadataClass"
glib:is-gtype-struct-for="Metadata">
<source-position filename="src/as-metadata.h" line="49"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_as_reserved1" introspectable="0">
<callback name="_as_reserved1">
<source-position filename="src/as-metadata.h" line="43"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved2" introspectable="0">
<callback name="_as_reserved2">
<source-position filename="src/as-metadata.h" line="44"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved3" introspectable="0">
<callback name="_as_reserved3">
<source-position filename="src/as-metadata.h" line="45"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved4" introspectable="0">
<callback name="_as_reserved4">
<source-position filename="src/as-metadata.h" line="46"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved5" introspectable="0">
<callback name="_as_reserved5">
<source-position filename="src/as-metadata.h" line="47"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved6" introspectable="0">
<callback name="_as_reserved6">
<source-position filename="src/as-metadata.h" line="48"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
</record>
<enumeration name="MetadataError"
glib:type-name="AsMetadataError"
glib:get-type="as_metadata_error_get_type"
c:type="AsMetadataError"
glib:error-domain="AsMetadataError">
<doc xml:space="preserve"
filename="src/as-metadata.h"
line="63">A metadata processing error.</doc>
<member name="failed"
value="0"
c:identifier="AS_METADATA_ERROR_FAILED"
glib:nick="failed"
glib:name="AS_METADATA_ERROR_FAILED">
<doc xml:space="preserve"
filename="src/as-metadata.h"
line="65">Generic failure.</doc>
</member>
<member name="parse"
value="1"
c:identifier="AS_METADATA_ERROR_PARSE"
glib:nick="parse"
glib:name="AS_METADATA_ERROR_PARSE">
<doc xml:space="preserve"
filename="src/as-metadata.h"
line="66">Unable to parse the metadata file.</doc>
</member>
<member name="format_unexpected"
value="2"
c:identifier="AS_METADATA_ERROR_FORMAT_UNEXPECTED"
glib:nick="format-unexpected"
glib:name="AS_METADATA_ERROR_FORMAT_UNEXPECTED">
<doc xml:space="preserve"
filename="src/as-metadata.h"
line="67">Expected catalog metadata but got metainfo metadata, or vice versa.</doc>
</member>
<member name="no_component"
value="3"
c:identifier="AS_METADATA_ERROR_NO_COMPONENT"
glib:nick="no-component"
glib:name="AS_METADATA_ERROR_NO_COMPONENT">
<doc xml:space="preserve"
filename="src/as-metadata.h"
line="68">We expected a component in the pool, but couldn't find one.</doc>
</member>
<member name="value_missing"
value="4"
c:identifier="AS_METADATA_ERROR_VALUE_MISSING"
glib:nick="value-missing"
glib:name="AS_METADATA_ERROR_VALUE_MISSING">
<doc xml:space="preserve"
filename="src/as-metadata.h"
line="69">A essential value is missing in the source document.</doc>
</member>
<function name="quark" c:identifier="as_metadata_error_quark">
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1761">An error quark.</doc>
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
</enumeration>
<enumeration name="MetadataLocation"
glib:type-name="AsMetadataLocation"
glib:get-type="as_metadata_location_get_type"
c:type="AsMetadataLocation">
<doc xml:space="preserve"
filename="src/as-utils.h"
line="69">The flags used when installing and removing metadata files.</doc>
<member name="unknown"
value="0"
c:identifier="AS_METADATA_LOCATION_UNKNOWN"
glib:nick="unknown"
glib:name="AS_METADATA_LOCATION_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-utils.h"
line="71">An unknown/invalid location.</doc>
</member>
<member name="shared"
value="1"
c:identifier="AS_METADATA_LOCATION_SHARED"
glib:nick="shared"
glib:name="AS_METADATA_LOCATION_SHARED">
<doc xml:space="preserve"
filename="src/as-utils.h"
line="72">Installed by the vendor, shared</doc>
</member>
<member name="state"
value="2"
c:identifier="AS_METADATA_LOCATION_STATE"
glib:nick="state"
glib:name="AS_METADATA_LOCATION_STATE">
<doc xml:space="preserve"
filename="src/as-utils.h"
line="73">Installed as metadata into /var/lib, shared</doc>
</member>
<member name="cache"
value="3"
c:identifier="AS_METADATA_LOCATION_CACHE"
glib:nick="cache"
glib:name="AS_METADATA_LOCATION_CACHE">
<doc xml:space="preserve"
filename="src/as-utils.h"
line="74">Installed as metadata into /var/cache, shared</doc>
</member>
<member name="user"
value="4"
c:identifier="AS_METADATA_LOCATION_USER"
glib:nick="user"
glib:name="AS_METADATA_LOCATION_USER">
<doc xml:space="preserve"
filename="src/as-utils.h"
line="75">Installed for the current user</doc>
</member>
</enumeration>
<bitfield name="ParseFlags"
glib:type-name="AsParseFlags"
glib:get-type="as_parse_flags_get_type"
c:type="AsParseFlags">
<doc xml:space="preserve"
filename="src/as-metadata.h"
line="51">Influence certain aspects of how AppStream metadata is parsed.</doc>
<member name="none"
value="0"
c:identifier="AS_PARSE_FLAG_NONE"
glib:nick="none"
glib:name="AS_PARSE_FLAG_NONE">
<doc xml:space="preserve"
filename="src/as-metadata.h"
line="53">No flags.</doc>
</member>
<member name="ignore_mediabaseurl"
value="1"
c:identifier="AS_PARSE_FLAG_IGNORE_MEDIABASEURL"
glib:nick="ignore-mediabaseurl"
glib:name="AS_PARSE_FLAG_IGNORE_MEDIABASEURL">
<doc xml:space="preserve"
filename="src/as-metadata.h"
line="54">Do not process the media_baseurl document property.</doc>
</member>
</bitfield>
<class name="Pool"
c:symbol-prefix="pool"
c:type="AsPool"
parent="GObject.Object"
glib:type-name="AsPool"
glib:get-type="as_pool_get_type"
glib:type-struct="PoolClass">
<source-position filename="src/as-pool.h" line="49"/>
<constructor name="new" c:identifier="as_pool_new">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2674">Creates a new #AsPool.</doc>
<source-position filename="src/as-pool.h" line="118"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2679">a #AsPool</doc>
<type name="Pool" c:type="AsPool*"/>
</return-value>
</constructor>
<virtual-method name="changed">
<source-position filename="src/as-pool.h" line="41"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="pool" transfer-ownership="none">
<type name="Pool" c:type="AsPool*"/>
</instance-parameter>
</parameters>
</virtual-method>
<method name="add_components"
c:identifier="as_pool_add_components"
version="0.15.0"
throws="1">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="967">Register a set of components with the pool temporarily.
Data from components added like this will not be cached.</doc>
<source-position filename="src/as-pool.h" line="132"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="976">%TRUE if the new components were successfully added to the pool.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="pool" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="969">An instance of #AsPool</doc>
<type name="Pool" c:type="AsPool*"/>
</instance-parameter>
<parameter name="cbox" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="970">Components to add to the pool.</doc>
<type name="ComponentBox" c:type="AsComponentBox*"/>
</parameter>
</parameters>
</method>
<method name="add_extra_data_location"
c:identifier="as_pool_add_extra_data_location">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2338">Add an additional non-standard location to the metadata pool where metadata will be read from.
If @directory contains a "xml", "xmls", "yaml" or "icons" subdirectory (or all of them),
those paths will be added to the search paths instead.</doc>
<source-position filename="src/as-pool.h" line="153"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="pool" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2340">An instance of #AsPool.</doc>
<type name="Pool" c:type="AsPool*"/>
</instance-parameter>
<parameter name="directory" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2341">An existing filesystem location.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="format_style" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2342">The expected format style of the metadata, e.g. %AS_FORMAT_STYLE_CATALOG</doc>
<type name="FormatStyle" c:type="AsFormatStyle"/>
</parameter>
</parameters>
</method>
<method name="add_flags"
c:identifier="as_pool_add_flags"
version="0.15.0">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2546">Convenience function to add one or multiple #AsPoolFlags to
the flag set of this data pool.</doc>
<source-position filename="src/as-pool.h" line="159"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="pool" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2548">An instance of #AsPool.</doc>
<type name="Pool" c:type="AsPool*"/>
</instance-parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2549">The #AsPoolFlags to add.</doc>
<type name="PoolFlags" c:type="AsPoolFlags"/>
</parameter>
</parameters>
</method>
<method name="build_search_tokens"
c:identifier="as_pool_build_search_tokens">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2110">Splits up a string into an array of tokens that are suitable for searching.
This includes stripping whitespaces, casefolding the terms and removing greylist words.
This function is usually called automatically when needed, you will only need to
run it explicitly when you need to check which search tokens the pool will actually
use internally for a given phrase.</doc>
<source-position filename="src/as-pool.h" line="150"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2122">(array zero-terminated=1): Valid tokens to search for, or %NULL for error</doc>
<array c:type="gchar**">
<type name="utf8"/>
</array>
</return-value>
<parameters>
<instance-parameter name="pool" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2112">An instance of #AsPool.</doc>
<type name="Pool" c:type="AsPool*"/>
</instance-parameter>
<parameter name="search" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2113">the (user-provided) search phrase.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="clear" c:identifier="as_pool_clear">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="989">Remove all metadata from the pool, data will be reloaded
once %as_pool_load is called again.</doc>
<source-position filename="src/as-pool.h" line="131"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="pool" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="991">An #AsPool.</doc>
<type name="Pool" c:type="AsPool*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_components" c:identifier="as_pool_get_components">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1837">Get a list of found components.</doc>
<source-position filename="src/as-pool.h" line="134"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1843">an #AsComponentBox.</doc>
<type name="ComponentBox" c:type="AsComponentBox*"/>
</return-value>
<parameters>
<instance-parameter name="pool" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1839">An instance of #AsPool.</doc>
<type name="Pool" c:type="AsPool*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_components_by_bundle_id"
c:identifier="as_pool_get_components_by_bundle_id"
version="0.16.0">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2049">Find components that are provided by a bundle with a specific ID by its prefix.
For example, given a AS_BUNDLE_KIND_FLATPAK and a bundle_id "org.kde.dolphin/",
it will list all the components that bundle dolphin. If the bundle_id is
"org.kde.dolphin/x86_64" it will give those with also the architecture.</doc>
<source-position filename="src/as-pool.h" line="145"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2061">an #AsComponentBox.</doc>
<type name="ComponentBox" c:type="AsComponentBox*"/>
</return-value>
<parameters>
<instance-parameter name="pool" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2051">An instance of #AsPool.</doc>
<type name="Pool" c:type="AsPool*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2052">The kind of the bundle we are looking for</doc>
<type name="BundleKind" c:type="AsBundleKind"/>
</parameter>
<parameter name="bundle_id" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2053">The bundle ID to match, as specified in #AsBundle</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="match_prefix" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2054">%TRUE to match the ID by prefix, %FALSE to perform an absolute match.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="get_components_by_categories"
c:identifier="as_pool_get_components_by_categories">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1950">Return a list of components which are in all of the categories.</doc>
<source-position filename="src/as-pool.h" line="140"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1957">an #AsComponentBox of found components.</doc>
<type name="ComponentBox" c:type="AsComponentBox*"/>
</return-value>
<parameters>
<instance-parameter name="pool" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1952">An instance of #AsDatabase.</doc>
<type name="Pool" c:type="AsPool*"/>
</instance-parameter>
<parameter name="categories" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1953">An array of XDG categories to include.</doc>
<array c:type="gchar**">
<type name="utf8" c:type="gchar*"/>
</array>
</parameter>
</parameters>
</method>
<method name="get_components_by_extends"
c:identifier="as_pool_get_components_by_extends"
version="0.15.0">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2017">Find components extending the component with the given ID. They can then be registered to the
#AsComponent they extend via %as_component_add_addon.
If the %AS_POOL_FLAG_RESOLVE_ADDONS pool flag is set, addons are automatically resolved and
this explicit function is not needed, but overall query time will be increased (so only use
this flag if you will be resolving addon information later anyway).</doc>
<source-position filename="src/as-pool.h" line="144"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2028">an #AsComponentBox.</doc>
<type name="ComponentBox" c:type="AsComponentBox*"/>
</return-value>
<parameters>
<instance-parameter name="pool" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2019">An instance of #AsPool.</doc>
<type name="Pool" c:type="AsPool*"/>
</instance-parameter>
<parameter name="extended_id" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2020">The ID of the component to search extensions for.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="get_components_by_id"
c:identifier="as_pool_get_components_by_id">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1866">Get a specific component by its ID.
This function may contain multiple results if we have
data describing this component from multiple scopes/origin types.</doc>
<source-position filename="src/as-pool.h" line="135"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1875">an #AsComponentBox.</doc>
<type name="ComponentBox" c:type="AsComponentBox*"/>
</return-value>
<parameters>
<instance-parameter name="pool" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1868">An instance of #AsPool.</doc>
<type name="Pool" c:type="AsPool*"/>
</instance-parameter>
<parameter name="cid" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1869">The AppStream-ID to look for.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="get_components_by_kind"
c:identifier="as_pool_get_components_by_kind">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1923">Return a list of all components in the pool which are of a certain kind.</doc>
<source-position filename="src/as-pool.h" line="139"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1930">an #AsComponentBox of found components.</doc>
<type name="ComponentBox" c:type="AsComponentBox*"/>
</return-value>
<parameters>
<instance-parameter name="pool" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1925">An instance of #AsDatabase.</doc>
<type name="Pool" c:type="AsPool*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1926">An #AsComponentKind.</doc>
<type name="ComponentKind" c:type="AsComponentKind"/>
</parameter>
</parameters>
</method>
<method name="get_components_by_launchable"
c:identifier="as_pool_get_components_by_launchable"
version="0.11.4">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1986">Find components in the AppStream data pool which provide a specific launchable.
See #AsLaunchable for details on launchables, or refer to the AppStream specification.</doc>
<source-position filename="src/as-pool.h" line="141"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1995">an #AsComponentBox of found components.</doc>
<type name="ComponentBox" c:type="AsComponentBox*"/>
</return-value>
<parameters>
<instance-parameter name="pool" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1988">An instance of #AsPool.</doc>
<type name="Pool" c:type="AsPool*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1989">An #AsLaunchableKind</doc>
<type name="LaunchableKind" c:type="AsLaunchableKind"/>
</parameter>
<parameter name="id" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1990">The ID of the launchable.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="get_components_by_provided_item"
c:identifier="as_pool_get_components_by_provided_item">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1895">Find components in the AppStream data pool which provide a certain item.</doc>
<source-position filename="src/as-pool.h" line="136"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1903">an #AsComponentBox of found components.</doc>
<type name="ComponentBox" c:type="AsComponentBox*"/>
</return-value>
<parameters>
<instance-parameter name="pool" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1897">An instance of #AsPool.</doc>
<type name="Pool" c:type="AsPool*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1898">An #AsProvidesKind</doc>
<type name="ProvidedKind" c:type="AsProvidedKind"/>
</parameter>
<parameter name="item" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1899">The value of the provided item.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="get_flags" c:identifier="as_pool_get_flags">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2514">Get the #AsPoolFlags for this data pool.</doc>
<source-position filename="src/as-pool.h" line="157"/>
<return-value transfer-ownership="none">
<type name="PoolFlags" c:type="AsPoolFlags"/>
</return-value>
<parameters>
<instance-parameter name="pool" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2516">An instance of #AsPool.</doc>
<type name="Pool" c:type="AsPool*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_locale" c:identifier="as_pool_get_locale">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2322">Gets the currently used locale.</doc>
<source-position filename="src/as-pool.h" line="120"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2328">Locale used for metadata parsing.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="pool" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2324">An instance of #AsPool.</doc>
<type name="Pool" c:type="AsPool*"/>
</instance-parameter>
</parameters>
</method>
<method name="is_empty" c:identifier="as_pool_is_empty">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1006">Check if this pool contains any data.</doc>
<source-position filename="src/as-pool.h" line="130"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1012">%TRUE if the pool is empty.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="pool" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1008">An instance of #AsPool.</doc>
<type name="Pool" c:type="AsPool*"/>
</instance-parameter>
</parameters>
</method>
<method name="load"
c:identifier="as_pool_load"
throws="1"
glib:async-func="load_async">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1665">Builds an index of all found components in the watched locations.
The function will try to get as much data into the pool as possible, so even if
the update completes with %FALSE, it might still have added components to the pool.
The function will load from all possible data sources, preferring caches if they
are up to date.</doc>
<source-position filename="src/as-pool.h" line="123"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1678">%TRUE if update completed without error.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="pool" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1667">An instance of #AsPool.</doc>
<type name="Pool" c:type="AsPool*"/>
</instance-parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1668">a #GCancellable.</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
</parameters>
</method>
<method name="load_async"
c:identifier="as_pool_load_async"
version="0.12.10"
glib:finish-func="load_finish"
glib:sync-func="load">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1711">Asynchronously loads data from all registered locations.
Equivalent to as_pool_load() (but asynchronous)</doc>
<source-position filename="src/as-pool.h" line="124"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="pool" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1713">An instance of #AsPool.</doc>
<type name="Pool" c:type="AsPool*"/>
</instance-parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1714">a #GCancellable.</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
nullable="1"
allow-none="1"
scope="async"
closure="2">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1715">A #GAsyncReadyCallback</doc>
<type name="Gio.AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
</parameter>
<parameter name="user_data"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1716">Data to pass to @callback</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</method>
<method name="load_finish"
c:identifier="as_pool_load_finish"
version="0.12.10"
throws="1">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1733">Retrieve the result of as_pool_load_async().</doc>
<source-position filename="src/as-pool.h" line="128"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1741">%TRUE for success</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="pool" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1735">An instance of #AsPool.</doc>
<type name="Pool" c:type="AsPool*"/>
</instance-parameter>
<parameter name="result" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="1736">A #GAsyncResult</doc>
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
</parameter>
</parameters>
</method>
<method name="remove_flags"
c:identifier="as_pool_remove_flags"
version="0.15.0">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2567">Convenience function to remove one or multiple #AsPoolFlags from
the flag set of this data pool.</doc>
<source-position filename="src/as-pool.h" line="160"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="pool" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2569">An instance of #AsPool.</doc>
<type name="Pool" c:type="AsPool*"/>
</instance-parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2570">The #AsPoolFlags to remove.</doc>
<type name="PoolFlags" c:type="AsPoolFlags"/>
</parameter>
</parameters>
</method>
<method name="reset_extra_data_locations"
c:identifier="as_pool_reset_extra_data_locations"
version="0.15.0">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2370">Remove all explicitly added metadata locations.</doc>
<source-position filename="src/as-pool.h" line="152"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="pool" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2372">An instance of #AsPool.</doc>
<type name="Pool" c:type="AsPool*"/>
</instance-parameter>
</parameters>
</method>
<method name="search" c:identifier="as_pool_search" version="0.9.7">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2191">Search for a list of components matching the search term.
The list will be ordered by match score.</doc>
<source-position filename="src/as-pool.h" line="149"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2199">an #AsComponentBox of the found components.</doc>
<type name="ComponentBox" c:type="AsComponentBox*"/>
</return-value>
<parameters>
<instance-parameter name="pool" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2193">An instance of #AsPool</doc>
<type name="Pool" c:type="AsPool*"/>
</instance-parameter>
<parameter name="search" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2194">A search string</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_flags" c:identifier="as_pool_set_flags">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2528">Set the #AsPoolFlags for this data pool.</doc>
<source-position filename="src/as-pool.h" line="158"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="pool" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2530">An instance of #AsPool.</doc>
<type name="Pool" c:type="AsPool*"/>
</instance-parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2531">The new #AsPoolFlags.</doc>
<type name="PoolFlags" c:type="AsPoolFlags"/>
</parameter>
</parameters>
</method>
<method name="set_load_std_data_locations"
c:identifier="as_pool_set_load_std_data_locations"
version="0.15.0">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2588">This is a convenience function that enables or disables loading of metadata
from well-known standard locations by configuring the #AsPoolFlags of this
#AsPool accordingly.
Data affected by this includes the OS data catalog, metainfo, desktop-entry
files and Flatpak data.
If you need more fine-grained control, set the #AsPoolFlags explicitly.</doc>
<source-position filename="src/as-pool.h" line="162"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="pool" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2590">An instance of #AsPool.</doc>
<type name="Pool" c:type="AsPool*"/>
</instance-parameter>
<parameter name="enabled" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2591">Whether loading of data from standard locations should be enabled.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_locale" c:identifier="as_pool_set_locale">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2302">Sets the current locale which should be used when parsing metadata.</doc>
<source-position filename="src/as-pool.h" line="121"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="pool" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2304">An instance of #AsPool.</doc>
<type name="Pool" c:type="AsPool*"/>
</instance-parameter>
<parameter name="locale" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2305">the BCP47 or POSIX locale to use for this pool.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
<glib:signal name="changed" when="last" version="0.15.0">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="425">The ::changed signal is emitted when components have been added
or removed from the metadata pool.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</glib:signal>
</class>
<record name="PoolClass"
c:type="AsPoolClass"
glib:is-gtype-struct-for="Pool">
<source-position filename="src/as-pool.h" line="49"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="changed">
<callback name="changed">
<source-position filename="src/as-pool.h" line="41"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="pool" transfer-ownership="none">
<type name="Pool" c:type="AsPool*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="_as_reserved1" introspectable="0">
<callback name="_as_reserved1">
<source-position filename="src/as-pool.h" line="44"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved2" introspectable="0">
<callback name="_as_reserved2">
<source-position filename="src/as-pool.h" line="45"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved3" introspectable="0">
<callback name="_as_reserved3">
<source-position filename="src/as-pool.h" line="46"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved4" introspectable="0">
<callback name="_as_reserved4">
<source-position filename="src/as-pool.h" line="47"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved5" introspectable="0">
<callback name="_as_reserved5">
<source-position filename="src/as-pool.h" line="48"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
</record>
<enumeration name="PoolError"
glib:type-name="AsPoolError"
glib:get-type="as_pool_error_get_type"
c:type="AsPoolError"
glib:error-domain="AsPool">
<doc xml:space="preserve"
filename="src/as-pool.h"
line="95">A metadata pool error.</doc>
<member name="failed"
value="0"
c:identifier="AS_POOL_ERROR_FAILED"
glib:nick="failed"
glib:name="AS_POOL_ERROR_FAILED">
<doc xml:space="preserve"
filename="src/as-pool.h"
line="97">Generic failure</doc>
</member>
<member name="incomplete"
value="1"
c:identifier="AS_POOL_ERROR_INCOMPLETE"
glib:nick="incomplete"
glib:name="AS_POOL_ERROR_INCOMPLETE">
<doc xml:space="preserve"
filename="src/as-pool.h"
line="98">The pool was loaded, but we had to ignore some metadata.</doc>
</member>
<member name="collision"
value="2"
c:identifier="AS_POOL_ERROR_COLLISION"
glib:nick="collision"
glib:name="AS_POOL_ERROR_COLLISION">
<doc xml:space="preserve"
filename="src/as-pool.h"
line="99">An AppStream-ID collision occured (a component with that ID already existed in the pool)</doc>
</member>
<member name="cache_write_failed"
value="3"
c:identifier="AS_POOL_ERROR_CACHE_WRITE_FAILED"
glib:nick="cache-write-failed"
glib:name="AS_POOL_ERROR_CACHE_WRITE_FAILED">
<doc xml:space="preserve"
filename="src/as-pool.h"
line="100">Unable to write to *any* cache file (not even tmpfs writes worked)</doc>
</member>
<member name="cache_damaged"
value="4"
c:identifier="AS_POOL_ERROR_CACHE_DAMAGED"
glib:nick="cache-damaged"
glib:name="AS_POOL_ERROR_CACHE_DAMAGED">
<doc xml:space="preserve"
filename="src/as-pool.h"
line="101">The disk cache was broken and we could not automatically recover.</doc>
</member>
<function name="quark" c:identifier="as_pool_error_quark">
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2663">An error quark.</doc>
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
</enumeration>
<bitfield name="PoolFlags"
glib:type-name="AsPoolFlags"
glib:get-type="as_pool_flags_get_type"
c:type="AsPoolFlags">
<doc xml:space="preserve"
filename="src/as-pool.h"
line="51">Flags controlling the metadata pool behavior.</doc>
<member name="none"
value="0"
c:identifier="AS_POOL_FLAG_NONE"
glib:nick="none"
glib:name="AS_POOL_FLAG_NONE">
<doc xml:space="preserve"
filename="src/as-pool.h"
line="53">No flags.</doc>
</member>
<member name="load_os_catalog"
value="1"
c:identifier="AS_POOL_FLAG_LOAD_OS_CATALOG"
glib:nick="load-os-catalog"
glib:name="AS_POOL_FLAG_LOAD_OS_CATALOG">
<doc xml:space="preserve"
filename="src/as-pool.h"
line="54">Load AppStream catalog metadata from OS locations.</doc>
</member>
<member name="load_os_metainfo"
value="2"
c:identifier="AS_POOL_FLAG_LOAD_OS_METAINFO"
glib:nick="load-os-metainfo"
glib:name="AS_POOL_FLAG_LOAD_OS_METAINFO">
<doc xml:space="preserve"
filename="src/as-pool.h"
line="55">Load MetaInfo data from OS locations.</doc>
</member>
<member name="load_os_desktop_files"
value="4"
c:identifier="AS_POOL_FLAG_LOAD_OS_DESKTOP_FILES"
glib:nick="load-os-desktop-files"
glib:name="AS_POOL_FLAG_LOAD_OS_DESKTOP_FILES">
<doc xml:space="preserve"
filename="src/as-pool.h"
line="56">Load components from desktop-entry files in OS locations.</doc>
</member>
<member name="load_flatpak"
value="8"
c:identifier="AS_POOL_FLAG_LOAD_FLATPAK"
glib:nick="load-flatpak"
glib:name="AS_POOL_FLAG_LOAD_FLATPAK">
<doc xml:space="preserve"
filename="src/as-pool.h"
line="57">Load AppStream catalog metadata from Flatpak.</doc>
</member>
<member name="ignore_cache_age"
value="16"
c:identifier="AS_POOL_FLAG_IGNORE_CACHE_AGE"
glib:nick="ignore-cache-age"
glib:name="AS_POOL_FLAG_IGNORE_CACHE_AGE">
<doc xml:space="preserve"
filename="src/as-pool.h"
line="58">Load fresh data even if an up-o-date cache is available.</doc>
</member>
<member name="resolve_addons"
value="32"
c:identifier="AS_POOL_FLAG_RESOLVE_ADDONS"
glib:nick="resolve-addons"
glib:name="AS_POOL_FLAG_RESOLVE_ADDONS">
<doc xml:space="preserve"
filename="src/as-pool.h"
line="59">Always resolve addons for returned components.</doc>
</member>
<member name="prefer_os_metainfo"
value="64"
c:identifier="AS_POOL_FLAG_PREFER_OS_METAINFO"
glib:nick="prefer-os-metainfo"
glib:name="AS_POOL_FLAG_PREFER_OS_METAINFO">
<doc xml:space="preserve"
filename="src/as-pool.h"
line="60">Prefer local metainfo data over the system-provided catalog data. Useful for previewing local data.</doc>
</member>
<member name="monitor"
value="128"
c:identifier="AS_POOL_FLAG_MONITOR"
glib:nick="monitor"
glib:name="AS_POOL_FLAG_MONITOR">
<doc xml:space="preserve"
filename="src/as-pool.h"
line="61">Monitor registered directories for changes, and auto-reload metadata if necessary.</doc>
</member>
</bitfield>
<class name="Provided"
c:symbol-prefix="provided"
c:type="AsProvided"
parent="GObject.Object"
glib:type-name="AsProvided"
glib:get-type="as_provided_get_type"
glib:type-struct="ProvidedClass">
<source-position filename="src/as-provided.h" line="44"/>
<constructor name="new" c:identifier="as_provided_new">
<doc xml:space="preserve"
filename="src/as-provided.c"
line="286">Creates a new #AsProvided.</doc>
<source-position filename="src/as-provided.h" line="84"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-provided.c"
line="291">a #AsProvided</doc>
<type name="Provided" c:type="AsProvided*"/>
</return-value>
</constructor>
<method name="add_item" c:identifier="as_provided_add_item">
<doc xml:space="preserve"
filename="src/as-provided.c"
line="273">Add a new provided item.</doc>
<source-position filename="src/as-provided.h" line="90"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="prov" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-provided.c"
line="275">a #AsProvided instance.</doc>
<type name="Provided" c:type="AsProvided*"/>
</instance-parameter>
<parameter name="item" transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="get_items" c:identifier="as_provided_get_items">
<doc xml:space="preserve"
filename="src/as-provided.c"
line="258">Get an array of provided data.</doc>
<source-position filename="src/as-provided.h" line="89"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-provided.c"
line="264">An string list of provided items.</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="utf8"/>
</array>
</return-value>
<parameters>
<instance-parameter name="prov" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-provided.c"
line="260">a #AsProvided instance.</doc>
<type name="Provided" c:type="AsProvided*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_kind" c:identifier="as_provided_get_kind">
<doc xml:space="preserve"
filename="src/as-provided.c"
line="198">The kind of items this #AsProvided object stores.</doc>
<source-position filename="src/as-provided.h" line="86"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-provided.c"
line="204">an enum of type #AsProvidedKind</doc>
<type name="ProvidedKind" c:type="AsProvidedKind"/>
</return-value>
<parameters>
<instance-parameter name="prov" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-provided.c"
line="200">a #AsProvided instance.</doc>
<type name="Provided" c:type="AsProvided*"/>
</instance-parameter>
</parameters>
</method>
<method name="has_item" c:identifier="as_provided_has_item">
<doc xml:space="preserve"
filename="src/as-provided.c"
line="227">Check if the current #AsProvided contains an item
of the given name.</doc>
<source-position filename="src/as-provided.h" line="91"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-provided.c"
line="235">%TRUE if found.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="prov" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-provided.c"
line="229">a #AsProvided instance.</doc>
<type name="Provided" c:type="AsProvided*"/>
</instance-parameter>
<parameter name="item" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-provided.c"
line="230">the name of a provided item, e.g. "audio/x-vorbis" (in case the provided kind is a mimetype)</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_kind" c:identifier="as_provided_set_kind">
<doc xml:space="preserve"
filename="src/as-provided.c"
line="213">Set the kind of items this #AsProvided object stores.</doc>
<source-position filename="src/as-provided.h" line="87"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="prov" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-provided.c"
line="215">a #AsProvided instance.</doc>
<type name="Provided" c:type="AsProvided*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-provided.c"
line="216">the new #AsProvidedKind</doc>
<type name="ProvidedKind" c:type="AsProvidedKind"/>
</parameter>
</parameters>
</method>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<record name="ProvidedClass"
c:type="AsProvidedClass"
glib:is-gtype-struct-for="Provided">
<source-position filename="src/as-provided.h" line="44"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_as_reserved1" introspectable="0">
<callback name="_as_reserved1">
<source-position filename="src/as-provided.h" line="38"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved2" introspectable="0">
<callback name="_as_reserved2">
<source-position filename="src/as-provided.h" line="39"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved3" introspectable="0">
<callback name="_as_reserved3">
<source-position filename="src/as-provided.h" line="40"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved4" introspectable="0">
<callback name="_as_reserved4">
<source-position filename="src/as-provided.h" line="41"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved5" introspectable="0">
<callback name="_as_reserved5">
<source-position filename="src/as-provided.h" line="42"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved6" introspectable="0">
<callback name="_as_reserved6">
<source-position filename="src/as-provided.h" line="43"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
</record>
<enumeration name="ProvidedKind"
glib:type-name="AsProvidedKind"
glib:get-type="as_provided_kind_get_type"
c:type="AsProvidedKind">
<doc xml:space="preserve"
filename="src/as-provided.h"
line="46">Type of the public interface components can provide.</doc>
<member name="unknown"
value="0"
c:identifier="AS_PROVIDED_KIND_UNKNOWN"
glib:nick="unknown"
glib:name="AS_PROVIDED_KIND_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-provided.h"
line="48">Unknown kind</doc>
</member>
<member name="library"
value="1"
c:identifier="AS_PROVIDED_KIND_LIBRARY"
glib:nick="library"
glib:name="AS_PROVIDED_KIND_LIBRARY">
<doc xml:space="preserve"
filename="src/as-provided.h"
line="49">A shared library</doc>
</member>
<member name="binary"
value="2"
c:identifier="AS_PROVIDED_KIND_BINARY"
glib:nick="binary"
glib:name="AS_PROVIDED_KIND_BINARY">
<doc xml:space="preserve"
filename="src/as-provided.h"
line="50">A binary installed into a directory in PATH</doc>
</member>
<member name="mediatype"
value="3"
c:identifier="AS_PROVIDED_KIND_MEDIATYPE"
glib:nick="mediatype"
glib:name="AS_PROVIDED_KIND_MEDIATYPE">
<doc xml:space="preserve"
filename="src/as-provided.h"
line="51">Provides a handler for a mimetype</doc>
</member>
<member name="font"
value="4"
c:identifier="AS_PROVIDED_KIND_FONT"
glib:nick="font"
glib:name="AS_PROVIDED_KIND_FONT">
<doc xml:space="preserve"
filename="src/as-provided.h"
line="52">A font</doc>
</member>
<member name="modalias"
value="5"
c:identifier="AS_PROVIDED_KIND_MODALIAS"
glib:nick="modalias"
glib:name="AS_PROVIDED_KIND_MODALIAS">
<doc xml:space="preserve"
filename="src/as-provided.h"
line="53">A modalias</doc>
</member>
<member name="python"
value="6"
c:identifier="AS_PROVIDED_KIND_PYTHON"
glib:nick="python"
glib:name="AS_PROVIDED_KIND_PYTHON">
<doc xml:space="preserve"
filename="src/as-provided.h"
line="54">A Python 3 module</doc>
</member>
<member name="dbus_system"
value="7"
c:identifier="AS_PROVIDED_KIND_DBUS_SYSTEM"
glib:nick="dbus-system"
glib:name="AS_PROVIDED_KIND_DBUS_SYSTEM">
<doc xml:space="preserve"
filename="src/as-provided.h"
line="55">A DBus service name on the system bus.</doc>
</member>
<member name="dbus_user"
value="8"
c:identifier="AS_PROVIDED_KIND_DBUS_USER"
glib:nick="dbus-user"
glib:name="AS_PROVIDED_KIND_DBUS_USER">
<doc xml:space="preserve"
filename="src/as-provided.h"
line="56">A DBus service name on the user/session bus.</doc>
</member>
<member name="firmware_runtime"
value="9"
c:identifier="AS_PROVIDED_KIND_FIRMWARE_RUNTIME"
glib:nick="firmware-runtime"
glib:name="AS_PROVIDED_KIND_FIRMWARE_RUNTIME">
<doc xml:space="preserve"
filename="src/as-provided.h"
line="57">Firmware flashed at runtime.</doc>
</member>
<member name="firmware_flashed"
value="10"
c:identifier="AS_PROVIDED_KIND_FIRMWARE_FLASHED"
glib:nick="firmware-flashed"
glib:name="AS_PROVIDED_KIND_FIRMWARE_FLASHED">
<doc xml:space="preserve"
filename="src/as-provided.h"
line="58">Firmware flashed permanently to the device.</doc>
</member>
<member name="id"
value="11"
c:identifier="AS_PROVIDED_KIND_ID"
glib:nick="id"
glib:name="AS_PROVIDED_KIND_ID">
<doc xml:space="preserve"
filename="src/as-provided.h"
line="59">An AppStream component</doc>
</member>
<function name="from_string" c:identifier="as_provided_kind_from_string">
<doc xml:space="preserve"
filename="src/as-provided.c"
line="87">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-provided.h" line="81"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-provided.c"
line="93">a #AsProvidedKind or %AS_PROVIDED_KIND_UNKNOWN for unknown</doc>
<type name="ProvidedKind" c:type="AsProvidedKind"/>
</return-value>
<parameters>
<parameter name="kind_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-provided.c"
line="89">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="to_l10n_string"
c:identifier="as_provided_kind_to_l10n_string">
<doc xml:space="preserve"
filename="src/as-provided.c"
line="123">Converts the enumerated value to a localized text representation,
using the plural forms (e.g. "Libraries" instead of "Library").
This can be useful when displaying provided items in GUI dialogs.</doc>
<source-position filename="src/as-provided.h" line="82"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-provided.c"
line="132">Pluralized, l10n string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-provided.c"
line="125">the #AsProvidedKind.</doc>
<type name="ProvidedKind" c:type="AsProvidedKind"/>
</parameter>
</parameters>
</function>
<function name="to_string" c:identifier="as_provided_kind_to_string">
<doc xml:space="preserve"
filename="src/as-provided.c"
line="51">Converts the enumerated value to a text representation.</doc>
<source-position filename="src/as-provided.h" line="80"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-provided.c"
line="57">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-provided.c"
line="53">the #AsProvidedKind.</doc>
<type name="ProvidedKind" c:type="AsProvidedKind"/>
</parameter>
</parameters>
</function>
</enumeration>
<function-macro name="RELEASE_LIST"
c:identifier="AS_RELEASE_LIST"
introspectable="0">
<source-position filename="src/as-release-list.h" line="55"/>
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<class name="Reference"
c:symbol-prefix="reference"
c:type="AsReference"
parent="GObject.Object"
glib:type-name="AsReference"
glib:get-type="as_reference_get_type"
glib:type-struct="ReferenceClass">
<source-position filename="src/as-reference.h" line="43"/>
<constructor name="new" c:identifier="as_reference_new">
<doc xml:space="preserve"
filename="src/as-reference.c"
line="124">Creates a new #AsReference.</doc>
<source-position filename="src/as-reference.h" line="66"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-reference.c"
line="129">a #AsReference</doc>
<type name="Reference" c:type="AsReference*"/>
</return-value>
</constructor>
<method name="get_kind"
c:identifier="as_reference_get_kind"
version="1.0.0">
<doc xml:space="preserve"
filename="src/as-reference.c"
line="140">Gets the reference kind.</doc>
<source-position filename="src/as-reference.h" line="68"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-reference.c"
line="146">the #AsReferenceKind</doc>
<type name="ReferenceKind" c:type="AsReferenceKind"/>
</return-value>
<parameters>
<instance-parameter name="reference" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-reference.c"
line="142">an #AsReference instance.</doc>
<type name="Reference" c:type="AsReference*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_registry_name"
c:identifier="as_reference_get_registry_name">
<doc xml:space="preserve"
filename="src/as-reference.c"
line="207">Gets the name of the registry this reference is for,
if the reference is of type %AS_REFERENCE_KIND_REGISTRY.
Otherwise return %NULL.</doc>
<source-position filename="src/as-reference.h" line="74"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="src/as-reference.c"
line="215">the registry name.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="reference" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-reference.c"
line="209">an #AsReference instance.</doc>
<type name="Reference" c:type="AsReference*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_value" c:identifier="as_reference_get_value">
<doc xml:space="preserve"
filename="src/as-reference.c"
line="173">Gets the value of this reference, e.g. a DOI if the
reference kind is %AS_REFERENCE_KIND_DOI or an URL
for %AS_REFERENCE_KIND_CITATION_CFF.</doc>
<source-position filename="src/as-reference.h" line="71"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-reference.c"
line="181">the value of this reference.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="reference" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-reference.c"
line="175">an #AsReference instance.</doc>
<type name="Reference" c:type="AsReference*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_kind"
c:identifier="as_reference_set_kind"
version="1.0.0">
<doc xml:space="preserve"
filename="src/as-reference.c"
line="157">Sets the reference kind.</doc>
<source-position filename="src/as-reference.h" line="69"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="reference" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-reference.c"
line="159">an #AsReference instance.</doc>
<type name="Reference" c:type="AsReference*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-reference.c"
line="160">the #AsReferenceKind, e.g. %AS_REFERENCE_KIND_DOI.</doc>
<type name="ReferenceKind" c:type="AsReferenceKind"/>
</parameter>
</parameters>
</method>
<method name="set_registry_name"
c:identifier="as_reference_set_registry_name">
<doc xml:space="preserve"
filename="src/as-reference.c"
line="224">Sets a name of a registry if this reference is of
type %AS_REFERENCE_KIND_REGISTRY.</doc>
<source-position filename="src/as-reference.h" line="75"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="reference" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-reference.c"
line="226">an #AsReference instance.</doc>
<type name="Reference" c:type="AsReference*"/>
</instance-parameter>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-reference.c"
line="227">name of an external registry.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_value" c:identifier="as_reference_set_value">
<doc xml:space="preserve"
filename="src/as-reference.c"
line="190">Sets a value for this reference.</doc>
<source-position filename="src/as-reference.h" line="72"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="reference" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-reference.c"
line="192">an #AsReference instance.</doc>
<type name="Reference" c:type="AsReference*"/>
</instance-parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-reference.c"
line="193">a value for this reference, e.g. "10.1000/182"</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<record name="ReferenceClass"
c:type="AsReferenceClass"
glib:is-gtype-struct-for="Reference">
<source-position filename="src/as-reference.h" line="43"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_as_reserved1" introspectable="0">
<callback name="_as_reserved1">
<source-position filename="src/as-reference.h" line="37"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved2" introspectable="0">
<callback name="_as_reserved2">
<source-position filename="src/as-reference.h" line="38"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved3" introspectable="0">
<callback name="_as_reserved3">
<source-position filename="src/as-reference.h" line="39"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved4" introspectable="0">
<callback name="_as_reserved4">
<source-position filename="src/as-reference.h" line="40"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved5" introspectable="0">
<callback name="_as_reserved5">
<source-position filename="src/as-reference.h" line="41"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved6" introspectable="0">
<callback name="_as_reserved6">
<source-position filename="src/as-reference.h" line="42"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
</record>
<enumeration name="ReferenceKind"
glib:type-name="AsReferenceKind"
glib:get-type="as_reference_kind_get_type"
c:type="AsReferenceKind">
<doc xml:space="preserve"
filename="src/as-reference.h"
line="45">A reference type.</doc>
<member name="unknown"
value="0"
c:identifier="AS_REFERENCE_KIND_UNKNOWN"
glib:nick="unknown"
glib:name="AS_REFERENCE_KIND_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-reference.h"
line="47">Unknown reference kind.</doc>
</member>
<member name="doi"
value="1"
c:identifier="AS_REFERENCE_KIND_DOI"
glib:nick="doi"
glib:name="AS_REFERENCE_KIND_DOI">
<doc xml:space="preserve"
filename="src/as-reference.h"
line="48">Digital Object Identifier</doc>
</member>
<member name="citation_cff"
value="2"
c:identifier="AS_REFERENCE_KIND_CITATION_CFF"
glib:nick="citation-cff"
glib:name="AS_REFERENCE_KIND_CITATION_CFF">
<doc xml:space="preserve"
filename="src/as-reference.h"
line="49">Web URL to a Citation File Format file</doc>
</member>
<member name="registry"
value="3"
c:identifier="AS_REFERENCE_KIND_REGISTRY"
glib:nick="registry"
glib:name="AS_REFERENCE_KIND_REGISTRY">
<doc xml:space="preserve"
filename="src/as-reference.h"
line="50">A generic registry.</doc>
</member>
<function name="from_string"
c:identifier="as_reference_kind_from_string">
<doc xml:space="preserve"
filename="src/as-reference.c"
line="70">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-reference.h" line="64"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-reference.c"
line="76">a AsReferenceKind or %AS_REFERENCE_KIND_UNKNOWN for unknown</doc>
<type name="ReferenceKind" c:type="AsReferenceKind"/>
</return-value>
<parameters>
<parameter name="str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-reference.c"
line="72">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="to_string"
c:identifier="as_reference_kind_to_string"
version="1.0.0">
<doc xml:space="preserve"
filename="src/as-reference.c"
line="48">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-reference.h" line="63"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-reference.c"
line="54">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-reference.c"
line="50">the %AsReferenceKind.</doc>
<type name="ReferenceKind" c:type="AsReferenceKind"/>
</parameter>
</parameters>
</function>
</enumeration>
<class name="Relation"
c:symbol-prefix="relation"
c:type="AsRelation"
parent="GObject.Object"
glib:type-name="AsRelation"
glib:get-type="as_relation_get_type"
glib:type-struct="RelationClass">
<source-position filename="src/as-relation.h" line="49"/>
<constructor name="new" c:identifier="as_relation_new" version="0.11.0">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="1923">Creates a new #AsRelation.</doc>
<source-position filename="src/as-relation.h" line="229"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="1928">a #AsRelation</doc>
<type name="Relation" c:type="AsRelation*"/>
</return-value>
</constructor>
<function name="check_results_get_compatibility_score"
c:identifier="as_relation_check_results_get_compatibility_score">
<doc xml:space="preserve"
filename="src/as-relation-check-result.c"
line="220">Calculate a compatibility sore between 0 and 100 based on the given set of
AsRelationCheckResults.
A compatibility of 100 means all requirements are satisfied and the component will
run perfectly on the confoguration it was tested agains, while 0 means it will not run at all.</doc>
<source-position filename="src/as-relation-check-result.h" line="84"/>
<return-value transfer-ownership="none">
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<parameter name="rc_results" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation-check-result.c"
line="222">an array of #AsRelationCheckResult</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="RelationCheckResult"/>
</array>
</parameter>
</parameters>
</function>
<method name="get_compare"
c:identifier="as_relation_get_compare"
version="0.12.0">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="552">The version comparison type.</doc>
<source-position filename="src/as-relation.h" line="237"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="558">an enum of type #AsRelationCompare</doc>
<type name="RelationCompare" c:type="AsRelationCompare"/>
</return-value>
<parameters>
<instance-parameter name="relation" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="554">a #AsRelation instance.</doc>
<type name="Relation" c:type="AsRelation*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_display_side_kind"
c:identifier="as_relation_get_display_side_kind"
version="0.12.12">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="894">Gets the display side kind, in case this item is of
kind %AS_RELATION_ITEM_KIND_DISPLAY_LENGTH</doc>
<source-position filename="src/as-relation.h" line="252"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="901">a #AsDisplaySideKind or %AS_DISPLAY_SIDE_KIND_UNKNOWN</doc>
<type name="DisplaySideKind" c:type="AsDisplaySideKind"/>
</return-value>
<parameters>
<instance-parameter name="relation" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="896">an #AsRelation instance.</doc>
<type name="Relation" c:type="AsRelation*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_item_kind"
c:identifier="as_relation_get_item_kind"
version="0.12.0">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="519">The kind of the item of this #AsRelation.</doc>
<source-position filename="src/as-relation.h" line="234"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="525">an enum of type #AsRelationItemKind</doc>
<type name="RelationItemKind" c:type="AsRelationItemKind"/>
</return-value>
<parameters>
<instance-parameter name="relation" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="521">a #AsRelation instance.</doc>
<type name="Relation" c:type="AsRelation*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_kind"
c:identifier="as_relation_get_kind"
version="0.12.0">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="486">The type (and thereby strength) of this #AsRelation.</doc>
<source-position filename="src/as-relation.h" line="231"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="492">an enum of type #AsRelationKind</doc>
<type name="RelationKind" c:type="AsRelationKind"/>
</return-value>
<parameters>
<instance-parameter name="relation" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="488">a #AsRelation instance.</doc>
<type name="Relation" c:type="AsRelation*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_value_control_kind"
c:identifier="as_relation_get_value_control_kind"
version="0.12.11">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="728">Get the value of this #AsRelation item as #AsControlKind if the
type of this relation is %AS_RELATION_ITEM_KIND_CONTROL.
Otherwise return %AS_CONTROL_KIND_UNKNOWN</doc>
<source-position filename="src/as-relation.h" line="249"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="736">a #AsControlKind or %AS_CONTROL_KIND_UNKNOWN in case the item is not of the right kind.</doc>
<type name="ControlKind" c:type="AsControlKind"/>
</return-value>
<parameters>
<instance-parameter name="relation" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="730">an #AsRelation instance.</doc>
<type name="Relation" c:type="AsRelation*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_value_int"
c:identifier="as_relation_get_value_int"
version="0.12.0">
<source-position filename="src/as-relation.h" line="246"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="692">The value of this #AsRelation item as an integer. Returns 0 if the value was no integer.</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="relation" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="690">an #AsRelation instance.</doc>
<type name="Relation" c:type="AsRelation*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_value_internet_bandwidth"
c:identifier="as_relation_get_value_internet_bandwidth"
version="0.15.5">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="804">If this #AsRelation is of kind %AS_RELATION_ITEM_KIND_INTERNET, return the
minimum bandwidth requirement of the component, if set.
If the relation is of a different kind, or the requirement isn’t set, this
returns `0`.</doc>
<source-position filename="src/as-relation.h" line="260"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="814">The minimum bandwidth requirement, in Mbit/s.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="relation" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="806">an #AsRelation instance.</doc>
<type name="Relation" c:type="AsRelation*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_value_internet_kind"
c:identifier="as_relation_get_value_internet_kind"
version="0.15.5">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="766">Get the value of this #AsRelation item as #AsInternetKind if the
type of this relation is %AS_RELATION_ITEM_KIND_INTERNET.
Otherwise return %AS_INTERNET_KIND_UNKNOWN</doc>
<source-position filename="src/as-relation.h" line="258"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="774">a #AsInternetKind or %AS_INTERNET_KIND_UNKNOWN in case the item is not of the right kind.</doc>
<type name="InternetKind" c:type="AsInternetKind"/>
</return-value>
<parameters>
<instance-parameter name="relation" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="768">an #AsRelation instance.</doc>
<type name="Relation" c:type="AsRelation*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_value_px"
c:identifier="as_relation_get_value_px"
version="0.12.12">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="852">In case this #AsRelation is of kind %AS_RELATION_ITEM_KIND_DISPLAY_LENGTH,
return the set logical pixel amount.</doc>
<source-position filename="src/as-relation.h" line="255"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="859">The logical pixel amount for this display length, value <= 0 on error.</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="relation" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="854">an #AsRelation instance.</doc>
<type name="Relation" c:type="AsRelation*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_value_str"
c:identifier="as_relation_get_value_str"
version="0.12.12">
<source-position filename="src/as-relation.h" line="243"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="655">The value of the item this #AsRelation is about, as a string.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="relation" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="653">an #AsRelation instance.</doc>
<type name="Relation" c:type="AsRelation*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_version"
c:identifier="as_relation_get_version"
version="0.12.0">
<source-position filename="src/as-relation.h" line="240"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="589">The version of the item this #AsRelation is about.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="relation" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="587">an #AsRelation instance.</doc>
<type name="Relation" c:type="AsRelation*"/>
</instance-parameter>
</parameters>
</method>
<method name="is_satisfied"
c:identifier="as_relation_is_satisfied"
throws="1">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="1453">Test if this relation is satisfied on the current system or with the
provided #AsPool. If no #AsSystemInfo is found, a temporary one will be
created. If no #AsPool is provided, any component relationships can not
be validated and an error will be thrown.</doc>
<source-position filename="src/as-relation.h" line="265"/>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="1465">an #AsRelationCheckResult with details about the result, or %NULL on error.</doc>
<type name="RelationCheckResult" c:type="AsRelationCheckResult*"/>
</return-value>
<parameters>
<instance-parameter name="relation" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="1455">a #AsRelation instance.</doc>
<type name="Relation" c:type="AsRelation*"/>
</instance-parameter>
<parameter name="system_info"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="1456">an #AsSystemInfo to use for system information.</doc>
<type name="SystemInfo" c:type="AsSystemInfo*"/>
</parameter>
<parameter name="pool"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="1457">an #AsPool to find component dependencies in.</doc>
<type name="Pool" c:type="AsPool*"/>
</parameter>
</parameters>
</method>
<method name="set_compare"
c:identifier="as_relation_set_compare"
version="0.12.0">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="569">Set the version comparison type of this #AsRelation.</doc>
<source-position filename="src/as-relation.h" line="238"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="relation" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="571">an #AsRelation instance.</doc>
<type name="Relation" c:type="AsRelation*"/>
</instance-parameter>
<parameter name="compare" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="572">the new #AsRelationCompare</doc>
<type name="RelationCompare" c:type="AsRelationCompare"/>
</parameter>
</parameters>
</method>
<method name="set_display_side_kind"
c:identifier="as_relation_set_display_side_kind"
version="0.12.12">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="912">Sets the display side kind, in case this item is of
kind %AS_RELATION_ITEM_KIND_DISPLAY_LENGTH</doc>
<source-position filename="src/as-relation.h" line="253"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="relation" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="914">an #AsRelation instance.</doc>
<type name="Relation" c:type="AsRelation*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="915">the new #AsDisplaySideKind.</doc>
<type name="DisplaySideKind" c:type="AsDisplaySideKind"/>
</parameter>
</parameters>
</method>
<method name="set_item_kind"
c:identifier="as_relation_set_item_kind"
version="0.12.0">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="536">Set the kind of the item this #AsRelation is about.</doc>
<source-position filename="src/as-relation.h" line="235"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="relation" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="538">a #AsRelation instance.</doc>
<type name="Relation" c:type="AsRelation*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="539">the new #AsRelationItemKind</doc>
<type name="RelationItemKind" c:type="AsRelationItemKind"/>
</parameter>
</parameters>
</method>
<method name="set_kind"
c:identifier="as_relation_set_kind"
version="0.12.0">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="503">Set the kind of this #AsRelation.</doc>
<source-position filename="src/as-relation.h" line="232"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="relation" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="505">a #AsRelation instance.</doc>
<type name="Relation" c:type="AsRelation*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="506">the new #AsRelationKind</doc>
<type name="RelationKind" c:type="AsRelationKind"/>
</parameter>
</parameters>
</method>
<method name="set_value_control_kind"
c:identifier="as_relation_set_value_control_kind"
version="0.12.12">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="751">Set relation item value from an #AsControlKind.</doc>
<source-position filename="src/as-relation.h" line="250"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="relation" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="753">an #AsRelation instance.</doc>
<type name="Relation" c:type="AsRelation*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="754">an #AsControlKind</doc>
<type name="ControlKind" c:type="AsControlKind"/>
</parameter>
</parameters>
</method>
<method name="set_value_int"
c:identifier="as_relation_set_value_int"
version="0.12.12">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="708">Sets the item value as an integer, if the given item type
of this #AsRelation permits integer values.</doc>
<source-position filename="src/as-relation.h" line="247"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="relation" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="710">an #AsRelation instance.</doc>
<type name="Relation" c:type="AsRelation*"/>
</instance-parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="711">the new value.</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="set_value_internet_bandwidth"
c:identifier="as_relation_set_value_internet_bandwidth">
<source-position filename="src/as-relation.h" line="261"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="relation" transfer-ownership="none">
<type name="Relation" c:type="AsRelation*"/>
</instance-parameter>
<parameter name="bandwidth_mbitps" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="set_value_internet_kind"
c:identifier="as_relation_set_value_internet_kind"
version="0.15.5">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="789">Set relation item value from an #AsInternetKind.</doc>
<source-position filename="src/as-relation.h" line="259"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="relation" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="791">an #AsRelation instance.</doc>
<type name="Relation" c:type="AsRelation*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="792">an #AsInternetKind</doc>
<type name="InternetKind" c:type="AsInternetKind"/>
</parameter>
</parameters>
</method>
<method name="set_value_px"
c:identifier="as_relation_set_value_px"
version="0.12.12">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="875">Sets the item value as logical pixel count. This requires the relation
to be of item kind %AS_RELATION_ITEM_KIND_DISPLAY_LENGTH.</doc>
<source-position filename="src/as-relation.h" line="256"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="relation" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="877">an #AsRelation instance.</doc>
<type name="Relation" c:type="AsRelation*"/>
</instance-parameter>
<parameter name="logical_px" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="878">logical pixel count.</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="set_value_str"
c:identifier="as_relation_set_value_str"
version="0.12.12">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="668">Sets the item value as a string, if the given item type
of this #AsRelation permits string values.</doc>
<source-position filename="src/as-relation.h" line="244"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="relation" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="670">an #AsRelation instance.</doc>
<type name="Relation" c:type="AsRelation*"/>
</instance-parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="671">the new value.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_version"
c:identifier="as_relation_set_version"
version="0.12.0">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="600">Sets the item version.</doc>
<source-position filename="src/as-relation.h" line="241"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="relation" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="602">an #AsRelation instance.</doc>
<type name="Relation" c:type="AsRelation*"/>
</instance-parameter>
<parameter name="version" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="603">the new version.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="version_compare"
c:identifier="as_relation_version_compare"
version="0.12.0"
throws="1">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="929">Tests whether the version number of this #AsRelation is fulfilled by
@version. Whether the given version is sufficient to fulfill the version
requirement of this #AsRelation is determined by its comparison resraint.</doc>
<source-position filename="src/as-relation.h" line="263"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="939">%TRUE if the version from the parameter is sufficient.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="relation" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="931">an #AsRelation instance.</doc>
<type name="Relation" c:type="AsRelation*"/>
</instance-parameter>
<parameter name="version" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="932">a version number, e.g. `1.2.0`</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<class name="RelationCheckResult"
c:symbol-prefix="relation_check_result"
c:type="AsRelationCheckResult"
parent="GObject.Object"
glib:type-name="AsRelationCheckResult"
glib:get-type="as_relation_check_result_get_type"
glib:type-struct="RelationCheckResultClass">
<source-position filename="src/as-relation-check-result.h" line="49"/>
<constructor name="new"
c:identifier="as_relation_check_result_new"
version="1.0.0">
<doc xml:space="preserve"
filename="src/as-relation-check-result.c"
line="76">Creates a new #AsRelationCheckResult.</doc>
<source-position filename="src/as-relation-check-result.h" line="69"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-relation-check-result.c"
line="81">a #AsRelationCheckResult</doc>
<type name="RelationCheckResult" c:type="AsRelationCheckResult*"/>
</return-value>
</constructor>
<method name="get_error_code"
c:identifier="as_relation_check_result_get_error_code">
<doc xml:space="preserve"
filename="src/as-relation-check-result.c"
line="191">Retrieve the error code, in case this result represents an error.</doc>
<source-position filename="src/as-relation-check-result.h" line="81"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation-check-result.c"
line="197">an #AsRelationError</doc>
<type name="RelationError" c:type="AsRelationError"/>
</return-value>
<parameters>
<instance-parameter name="relcr" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation-check-result.c"
line="193">an #AsRelationCheckResult instance.</doc>
<type name="RelationCheckResult" c:type="AsRelationCheckResult*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_message"
c:identifier="as_relation_check_result_get_message">
<doc xml:space="preserve"
filename="src/as-relation-check-result.c"
line="155">Get a human-readable message about the state of this relation.
May be %NULL in case the relation is satisfied and there is no further information about it.</doc>
<source-position filename="src/as-relation-check-result.h" line="77"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="src/as-relation-check-result.c"
line="162">a human-readable message about this relation's state.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="relcr" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation-check-result.c"
line="157">an #AsRelationCheckResult instance.</doc>
<type name="RelationCheckResult" c:type="AsRelationCheckResult*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_relation"
c:identifier="as_relation_check_result_get_relation">
<doc xml:space="preserve"
filename="src/as-relation-check-result.c"
line="124">Get the relation that this check result was generated for.</doc>
<source-position filename="src/as-relation-check-result.h" line="74"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="src/as-relation-check-result.c"
line="130">an #AsRelation or %NULL</doc>
<type name="Relation" c:type="AsRelation*"/>
</return-value>
<parameters>
<instance-parameter name="relcr" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation-check-result.c"
line="126">an #AsRelationCheckResult instance.</doc>
<type name="RelationCheckResult" c:type="AsRelationCheckResult*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_status"
c:identifier="as_relation_check_result_get_status">
<doc xml:space="preserve"
filename="src/as-relation-check-result.c"
line="93">Returns the status of this relation check result.
If the status is %AS_RELATION_STATUS_ERROR, an error message will
have been set as message.</doc>
<source-position filename="src/as-relation-check-result.h" line="71"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation-check-result.c"
line="101">an #AsRelationStatus</doc>
<type name="RelationStatus" c:type="AsRelationStatus"/>
</return-value>
<parameters>
<instance-parameter name="relcr" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation-check-result.c"
line="95">an #AsRelationCheckResult instance.</doc>
<type name="RelationCheckResult" c:type="AsRelationCheckResult*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_error_code"
c:identifier="as_relation_check_result_set_error_code">
<doc xml:space="preserve"
filename="src/as-relation-check-result.c"
line="206">Set the error code in case this result represents an error.</doc>
<source-position filename="src/as-relation-check-result.h" line="82"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="relcr" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation-check-result.c"
line="208">an #AsRelationCheckResult instance.</doc>
<type name="RelationCheckResult" c:type="AsRelationCheckResult*"/>
</instance-parameter>
<parameter name="ecode" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation-check-result.c"
line="209">the #AsRelationError</doc>
<type name="RelationError" c:type="AsRelationError"/>
</parameter>
</parameters>
</method>
<method name="set_message"
c:identifier="as_relation_check_result_set_message"
introspectable="0">
<doc xml:space="preserve"
filename="src/as-relation-check-result.c"
line="171">Set a human-readable information message about the satisfaction state
of the dependency under the checked system configuration.</doc>
<source-position filename="src/as-relation-check-result.h" line="78"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="relcr" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation-check-result.c"
line="173">an #AsRelationCheckResult instance.</doc>
<type name="RelationCheckResult" c:type="AsRelationCheckResult*"/>
</instance-parameter>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation-check-result.c"
line="174">the new message</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<varargs/>
</parameter>
</parameters>
</method>
<method name="set_relation"
c:identifier="as_relation_check_result_set_relation">
<doc xml:space="preserve"
filename="src/as-relation-check-result.c"
line="139">Set an #AsRelation to associate with this check result.</doc>
<source-position filename="src/as-relation-check-result.h" line="75"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="relcr" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation-check-result.c"
line="141">an #AsRelationCheckResult instance.</doc>
<type name="RelationCheckResult" c:type="AsRelationCheckResult*"/>
</instance-parameter>
<parameter name="relation" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation-check-result.c"
line="142">the #AsRelation</doc>
<type name="Relation" c:type="AsRelation*"/>
</parameter>
</parameters>
</method>
<method name="set_status"
c:identifier="as_relation_check_result_set_status">
<doc xml:space="preserve"
filename="src/as-relation-check-result.c"
line="110">Set the outcome of this relation check result.</doc>
<source-position filename="src/as-relation-check-result.h" line="72"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="relcr" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation-check-result.c"
line="112">an #AsRelationCheckResult instance.</doc>
<type name="RelationCheckResult" c:type="AsRelationCheckResult*"/>
</instance-parameter>
<parameter name="status" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation-check-result.c"
line="113">the new #AsRelationStatus</doc>
<type name="RelationStatus" c:type="AsRelationStatus"/>
</parameter>
</parameters>
</method>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<record name="RelationCheckResultClass"
c:type="AsRelationCheckResultClass"
glib:is-gtype-struct-for="RelationCheckResult">
<source-position filename="src/as-relation-check-result.h" line="49"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_as_reserved1" introspectable="0">
<callback name="_as_reserved1">
<source-position filename="src/as-relation-check-result.h"
line="43"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved2" introspectable="0">
<callback name="_as_reserved2">
<source-position filename="src/as-relation-check-result.h"
line="44"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved3" introspectable="0">
<callback name="_as_reserved3">
<source-position filename="src/as-relation-check-result.h"
line="45"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved4" introspectable="0">
<callback name="_as_reserved4">
<source-position filename="src/as-relation-check-result.h"
line="46"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved5" introspectable="0">
<callback name="_as_reserved5">
<source-position filename="src/as-relation-check-result.h"
line="47"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved6" introspectable="0">
<callback name="_as_reserved6">
<source-position filename="src/as-relation-check-result.h"
line="48"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
</record>
<record name="RelationClass"
c:type="AsRelationClass"
glib:is-gtype-struct-for="Relation">
<source-position filename="src/as-relation.h" line="49"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_as_reserved1" introspectable="0">
<callback name="_as_reserved1">
<source-position filename="src/as-relation.h" line="43"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved2" introspectable="0">
<callback name="_as_reserved2">
<source-position filename="src/as-relation.h" line="44"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved3" introspectable="0">
<callback name="_as_reserved3">
<source-position filename="src/as-relation.h" line="45"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved4" introspectable="0">
<callback name="_as_reserved4">
<source-position filename="src/as-relation.h" line="46"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved5" introspectable="0">
<callback name="_as_reserved5">
<source-position filename="src/as-relation.h" line="47"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved6" introspectable="0">
<callback name="_as_reserved6">
<source-position filename="src/as-relation.h" line="48"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
</record>
<enumeration name="RelationCompare"
glib:type-name="AsRelationCompare"
glib:get-type="as_relation_compare_get_type"
c:type="AsRelationCompare">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="99">The relational comparison type.</doc>
<member name="unknown"
value="0"
c:identifier="AS_RELATION_COMPARE_UNKNOWN"
glib:nick="unknown"
glib:name="AS_RELATION_COMPARE_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="101">Comparison predicate invalid or not known</doc>
</member>
<member name="eq"
value="1"
c:identifier="AS_RELATION_COMPARE_EQ"
glib:nick="eq"
glib:name="AS_RELATION_COMPARE_EQ">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="102">Equal to</doc>
</member>
<member name="ne"
value="2"
c:identifier="AS_RELATION_COMPARE_NE"
glib:nick="ne"
glib:name="AS_RELATION_COMPARE_NE">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="103">Not equal to</doc>
</member>
<member name="lt"
value="3"
c:identifier="AS_RELATION_COMPARE_LT"
glib:nick="lt"
glib:name="AS_RELATION_COMPARE_LT">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="104">Less than</doc>
</member>
<member name="gt"
value="4"
c:identifier="AS_RELATION_COMPARE_GT"
glib:nick="gt"
glib:name="AS_RELATION_COMPARE_GT">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="105">Greater than</doc>
</member>
<member name="le"
value="5"
c:identifier="AS_RELATION_COMPARE_LE"
glib:nick="le"
glib:name="AS_RELATION_COMPARE_LE">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="106">Less than or equal to</doc>
</member>
<member name="ge"
value="6"
c:identifier="AS_RELATION_COMPARE_GE"
glib:nick="ge"
glib:name="AS_RELATION_COMPARE_GE">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="107">Greater than or equal to</doc>
</member>
<function name="from_string"
c:identifier="as_relation_compare_from_string"
version="0.12.0">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="186">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-relation.h" line="216"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="192">a #AsRelationCompare, or %AS_RELATION_COMPARE_UNKNOWN for unknown.</doc>
<type name="RelationCompare" c:type="AsRelationCompare"/>
</return-value>
<parameters>
<parameter name="compare_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="188">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="to_string"
c:identifier="as_relation_compare_to_string"
version="0.12.0">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="233">Converts the enumerated value to an text representation.
The enum is converted into a two-letter identifier ("eq", "ge", etc.)
for use in the XML representation.</doc>
<source-position filename="src/as-relation.h" line="217"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="241">string version of @compare</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="compare" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="235">the #AsRelationCompare.</doc>
<type name="RelationCompare" c:type="AsRelationCompare"/>
</parameter>
</parameters>
</function>
<function name="to_symbols_string"
c:identifier="as_relation_compare_to_symbols_string"
version="0.12.0">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="263">Converts the enumerated value to an text representation.
The enum is converted into an identifier consisting of two
mathematical comparison operators ("==", ">=", etc.)
for use in the YAML representation and user interfaces.</doc>
<source-position filename="src/as-relation.h" line="218"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="272">string version of @compare</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="compare" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="265">the #AsRelationCompare.</doc>
<type name="RelationCompare" c:type="AsRelationCompare"/>
</parameter>
</parameters>
</function>
</enumeration>
<enumeration name="RelationError"
glib:type-name="AsRelationError"
glib:get-type="as_relation_error_get_type"
c:type="AsRelationError"
glib:error-domain="as-relation-error-quark">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="190">The error type.</doc>
<member name="failed"
value="0"
c:identifier="AS_RELATION_ERROR_FAILED"
glib:nick="failed"
glib:name="AS_RELATION_ERROR_FAILED">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="192">Generic failure</doc>
</member>
<member name="bad_value"
value="1"
c:identifier="AS_RELATION_ERROR_BAD_VALUE"
glib:nick="bad-value"
glib:name="AS_RELATION_ERROR_BAD_VALUE">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="193">A metadata value was bad.</doc>
</member>
<member name="not_implemented"
value="2"
c:identifier="AS_RELATION_ERROR_NOT_IMPLEMENTED"
glib:nick="not-implemented"
glib:name="AS_RELATION_ERROR_NOT_IMPLEMENTED">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="194">Some check was not (yet) implemented.</doc>
</member>
<function name="quark"
c:identifier="as_relation_error_quark"
version="0.16.0">
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="68">An error quark.</doc>
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
</enumeration>
<enumeration name="RelationItemKind"
glib:type-name="AsRelationItemKind"
glib:get-type="as_relation_item_kind_get_type"
c:type="AsRelationItemKind">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="69">Type of the item an #AsRelation is for.</doc>
<member name="unknown"
value="0"
c:identifier="AS_RELATION_ITEM_KIND_UNKNOWN"
glib:nick="unknown"
glib:name="AS_RELATION_ITEM_KIND_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="71">Unknown kind</doc>
</member>
<member name="id"
value="1"
c:identifier="AS_RELATION_ITEM_KIND_ID"
glib:nick="id"
glib:name="AS_RELATION_ITEM_KIND_ID">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="72">A component ID</doc>
</member>
<member name="modalias"
value="2"
c:identifier="AS_RELATION_ITEM_KIND_MODALIAS"
glib:nick="modalias"
glib:name="AS_RELATION_ITEM_KIND_MODALIAS">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="73">A hardware modalias</doc>
</member>
<member name="kernel"
value="3"
c:identifier="AS_RELATION_ITEM_KIND_KERNEL"
glib:nick="kernel"
glib:name="AS_RELATION_ITEM_KIND_KERNEL">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="74">An operating system kernel (like Linux)</doc>
</member>
<member name="memory"
value="4"
c:identifier="AS_RELATION_ITEM_KIND_MEMORY"
glib:nick="memory"
glib:name="AS_RELATION_ITEM_KIND_MEMORY">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="75">A system RAM requirement</doc>
</member>
<member name="firmware"
value="5"
c:identifier="AS_RELATION_ITEM_KIND_FIRMWARE"
glib:nick="firmware"
glib:name="AS_RELATION_ITEM_KIND_FIRMWARE">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="76">A device firmware requirement (used by fwupd)</doc>
</member>
<member name="control"
value="6"
c:identifier="AS_RELATION_ITEM_KIND_CONTROL"
glib:nick="control"
glib:name="AS_RELATION_ITEM_KIND_CONTROL">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="77">An input method for users to control software</doc>
</member>
<member name="display_length"
value="7"
c:identifier="AS_RELATION_ITEM_KIND_DISPLAY_LENGTH"
glib:nick="display-length"
glib:name="AS_RELATION_ITEM_KIND_DISPLAY_LENGTH">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="78">Display edge length</doc>
</member>
<member name="hardware"
value="8"
c:identifier="AS_RELATION_ITEM_KIND_HARDWARE"
glib:nick="hardware"
glib:name="AS_RELATION_ITEM_KIND_HARDWARE">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="79">A Computer Hardware ID (CHID) to depend on system hardware</doc>
</member>
<member name="internet"
value="9"
c:identifier="AS_RELATION_ITEM_KIND_INTERNET"
glib:nick="internet"
glib:name="AS_RELATION_ITEM_KIND_INTERNET">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="80">Internet connectivity (Since: 0.15.5)</doc>
</member>
<function name="from_string"
c:identifier="as_relation_item_kind_from_string"
version="0.12.0">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="152">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-relation.h" line="214"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="158">a #AsRelationItemKind or %AS_RELATION_ITEM_KIND_UNKNOWN for unknown</doc>
<type name="RelationItemKind" c:type="AsRelationItemKind"/>
</return-value>
<parameters>
<parameter name="kind_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="154">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="to_string"
c:identifier="as_relation_item_kind_to_string"
version="0.12.0">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="118">Converts the enumerated value to a text representation.</doc>
<source-position filename="src/as-relation.h" line="213"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="124">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="120">the #AsRelationKind.</doc>
<type name="RelationItemKind" c:type="AsRelationItemKind"/>
</parameter>
</parameters>
</function>
</enumeration>
<enumeration name="RelationKind"
glib:type-name="AsRelationKind"
glib:get-type="as_relation_kind_get_type"
c:type="AsRelationKind">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="51">Type of a component's relation to other items.</doc>
<member name="unknown"
value="0"
c:identifier="AS_RELATION_KIND_UNKNOWN"
glib:nick="unknown"
glib:name="AS_RELATION_KIND_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="53">Unknown kind</doc>
</member>
<member name="requires"
value="1"
c:identifier="AS_RELATION_KIND_REQUIRES"
glib:nick="requires"
glib:name="AS_RELATION_KIND_REQUIRES">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="54">The referenced item is required by the component</doc>
</member>
<member name="recommends"
value="2"
c:identifier="AS_RELATION_KIND_RECOMMENDS"
glib:nick="recommends"
glib:name="AS_RELATION_KIND_RECOMMENDS">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="55">The referenced item is recommended</doc>
</member>
<member name="supports"
value="3"
c:identifier="AS_RELATION_KIND_SUPPORTS"
glib:nick="supports"
glib:name="AS_RELATION_KIND_SUPPORTS">
<doc xml:space="preserve"
filename="src/as-relation.h"
line="56">The referenced item is supported</doc>
</member>
<function name="from_string"
c:identifier="as_relation_kind_from_string"
version="0.12.0">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="96">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-relation.h" line="211"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="102">a #AsRelationKind or %AS_RELATION_KIND_UNKNOWN for unknown</doc>
<type name="RelationKind" c:type="AsRelationKind"/>
</return-value>
<parameters>
<parameter name="kind_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="98">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="to_string"
c:identifier="as_relation_kind_to_string"
version="0.12.0">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="74">Converts the enumerated value to a text representation.</doc>
<source-position filename="src/as-relation.h" line="210"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="80">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="76">the #AsRelationKind.</doc>
<type name="RelationKind" c:type="AsRelationKind"/>
</parameter>
</parameters>
</function>
</enumeration>
<enumeration name="RelationStatus"
glib:type-name="AsRelationStatus"
glib:get-type="as_relation_status_get_type"
c:type="AsRelationStatus">
<doc xml:space="preserve"
filename="src/as-relation-check-result.h"
line="51">Status of a relation check result.</doc>
<member name="unknown"
value="0"
c:identifier="AS_RELATION_STATUS_UNKNOWN"
glib:nick="unknown"
glib:name="AS_RELATION_STATUS_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-relation-check-result.h"
line="53">Unknown status.</doc>
</member>
<member name="error"
value="1"
c:identifier="AS_RELATION_STATUS_ERROR"
glib:nick="error"
glib:name="AS_RELATION_STATUS_ERROR">
<doc xml:space="preserve"
filename="src/as-relation-check-result.h"
line="54">An error occured and the status could not be checked.</doc>
</member>
<member name="not_satisfied"
value="2"
c:identifier="AS_RELATION_STATUS_NOT_SATISFIED"
glib:nick="not-satisfied"
glib:name="AS_RELATION_STATUS_NOT_SATISFIED">
<doc xml:space="preserve"
filename="src/as-relation-check-result.h"
line="55">The relation is not satisfied.</doc>
</member>
<member name="satisfied"
value="3"
c:identifier="AS_RELATION_STATUS_SATISFIED"
glib:nick="satisfied"
glib:name="AS_RELATION_STATUS_SATISFIED">
<doc xml:space="preserve"
filename="src/as-relation-check-result.h"
line="56">The relation is satisfied.</doc>
</member>
</enumeration>
<class name="Release"
c:symbol-prefix="release"
c:type="AsRelease"
parent="GObject.Object"
glib:type-name="AsRelease"
glib:get-type="as_release_get_type"
glib:type-struct="ReleaseClass">
<source-position filename="src/as-release.h" line="47"/>
<constructor name="new" c:identifier="as_release_new">
<doc xml:space="preserve"
filename="src/as-release.c"
line="1291">Creates a new #AsRelease.</doc>
<source-position filename="src/as-release.h" line="114"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-release.c"
line="1296">a #AsRelease</doc>
<type name="Release" c:type="AsRelease*"/>
</return-value>
</constructor>
<method name="add_artifact"
c:identifier="as_release_add_artifact"
version="0.12.6">
<doc xml:space="preserve"
filename="src/as-release.c"
line="603">Add an artifact (binary / source download) for this release.</doc>
<source-position filename="src/as-release.h" line="147"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="release" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="605">An instance of #AsRelease.</doc>
<type name="Release" c:type="AsRelease*"/>
</instance-parameter>
<parameter name="artifact" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="606">The #AsArtifact.</doc>
<type name="Artifact" c:type="AsArtifact*"/>
</parameter>
</parameters>
</method>
<method name="add_issue"
c:identifier="as_release_add_issue"
version="0.12.9">
<doc xml:space="preserve"
filename="src/as-release.c"
line="640">Add information about a (resolved) issue to this release.</doc>
<source-position filename="src/as-release.h" line="144"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="release" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="642">An instance of #AsRelease.</doc>
<type name="Release" c:type="AsRelease*"/>
</instance-parameter>
<parameter name="issue" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="643">The #AsIssue.</doc>
<type name="Issue" c:type="AsIssue*"/>
</parameter>
</parameters>
</method>
<method name="add_tag" c:identifier="as_release_add_tag" version="1.0.0">
<doc xml:space="preserve"
filename="src/as-release.c"
line="756">Add a tag to this release.</doc>
<source-position filename="src/as-release.h" line="153"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="764">%TRUE if the tag was added.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="release" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="758">an #AsRelease instance.</doc>
<type name="Release" c:type="AsRelease*"/>
</instance-parameter>
<parameter name="ns" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="759">The namespace the tag belongs to</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="tag" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="760">The tag name</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="clear_tags"
c:identifier="as_release_clear_tags"
version="1.0.0">
<doc xml:space="preserve"
filename="src/as-release.c"
line="741">Remove all tags associated with this release.</doc>
<source-position filename="src/as-release.h" line="152"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="release" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="743">an #AsRelease instance.</doc>
<type name="Release" c:type="AsRelease*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_artifacts"
c:identifier="as_release_get_artifacts"
version="0.12.6">
<doc xml:space="preserve"
filename="src/as-release.c"
line="585">Get a list of all downloadable artifacts that are associated with
this release.</doc>
<source-position filename="src/as-release.h" line="146"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="591">an array of #AsArtifact objects.</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="Artifact"/>
</array>
</return-value>
<parameters>
<instance-parameter name="release" transfer-ownership="none">
<type name="Release" c:type="AsRelease*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_context"
c:identifier="as_release_get_context"
version="0.11.2">
<source-position filename="src/as-release.h" line="116"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="src/as-release.c"
line="708">the #AsContext associated with this release.
This function may return %NULL if no context is set.</doc>
<type name="Context" c:type="AsContext*"/>
</return-value>
<parameters>
<instance-parameter name="release" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="706">An instance of #AsRelease.</doc>
<type name="Release" c:type="AsRelease*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_date"
c:identifier="as_release_get_date"
version="0.12.5">
<doc xml:space="preserve"
filename="src/as-release.c"
line="374">Gets the release date.</doc>
<source-position filename="src/as-release.h" line="127"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="src/as-release.c"
line="380">The date in ISO8601 format.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="release" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="376">a #AsRelease instance.</doc>
<type name="Release" c:type="AsRelease*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_date_eol"
c:identifier="as_release_get_date_eol"
version="0.12.5">
<doc xml:space="preserve"
filename="src/as-release.c"
line="421">Gets the end-of-life date for this release.</doc>
<source-position filename="src/as-release.h" line="132"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="src/as-release.c"
line="427">The EOL date in ISO8601 format.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="release" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="423">a #AsRelease instance.</doc>
<type name="Release" c:type="AsRelease*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_description" c:identifier="as_release_get_description">
<doc xml:space="preserve"
filename="src/as-release.c"
line="550">Gets the release description markup for a given locale.</doc>
<source-position filename="src/as-release.h" line="137"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="src/as-release.c"
line="556">markup, or %NULL for not set or invalid</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="release" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="552">a #AsRelease instance.</doc>
<type name="Release" c:type="AsRelease*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_issues"
c:identifier="as_release_get_issues"
version="0.12.9">
<doc xml:space="preserve"
filename="src/as-release.c"
line="623">Get a list of all issues resolved by this release.</doc>
<source-position filename="src/as-release.h" line="143"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="628">an array of #AsIssue objects.</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="Issue"/>
</array>
</return-value>
<parameters>
<instance-parameter name="release" transfer-ownership="none">
<type name="Release" c:type="AsRelease*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_kind"
c:identifier="as_release_get_kind"
version="0.12.0">
<doc xml:space="preserve"
filename="src/as-release.c"
line="255">Gets the type of the release.
(development or stable release)</doc>
<source-position filename="src/as-release.h" line="119"/>
<return-value transfer-ownership="none">
<type name="ReleaseKind" c:type="AsReleaseKind"/>
</return-value>
<parameters>
<instance-parameter name="release" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="257">a #AsRelease instance.</doc>
<type name="Release" c:type="AsRelease*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_timestamp" c:identifier="as_release_get_timestamp">
<doc xml:space="preserve"
filename="src/as-release.c"
line="338">Gets the release timestamp.</doc>
<source-position filename="src/as-release.h" line="129"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="344">timestamp, or 0 for unset</doc>
<type name="guint64" c:type="guint64"/>
</return-value>
<parameters>
<instance-parameter name="release" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="340">a #AsRelease instance.</doc>
<type name="Release" c:type="AsRelease*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_timestamp_eol"
c:identifier="as_release_get_timestamp_eol"
version="0.12.5">
<doc xml:space="preserve"
filename="src/as-release.c"
line="457">Gets the UNIX timestamp for the date when this
release is out of support (end-of-life).</doc>
<source-position filename="src/as-release.h" line="134"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="464">UNIX timestamp, or 0 for unset or invalid.</doc>
<type name="guint64" c:type="guint64"/>
</return-value>
<parameters>
<instance-parameter name="release" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="459">a #AsRelease instance.</doc>
<type name="Release" c:type="AsRelease*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_urgency"
c:identifier="as_release_get_urgency"
version="0.6.5">
<doc xml:space="preserve"
filename="src/as-release.c"
line="514">Gets the urgency of the release
(showing how important it is to update to a more recent release)</doc>
<source-position filename="src/as-release.h" line="140"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="521">#AsUrgencyKind, or %AS_URGENCY_KIND_UNKNOWN for not set</doc>
<type name="UrgencyKind" c:type="AsUrgencyKind"/>
</return-value>
<parameters>
<instance-parameter name="release" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="516">a #AsRelease instance.</doc>
<type name="Release" c:type="AsRelease*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_url"
c:identifier="as_release_get_url"
version="0.12.5">
<doc xml:space="preserve"
filename="src/as-release.c"
line="660">Gets an URL.</doc>
<source-position filename="src/as-release.h" line="149"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="src/as-release.c"
line="667">string, or %NULL if unset</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="release" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="662">a #AsRelease instance.</doc>
<type name="Release" c:type="AsRelease*"/>
</instance-parameter>
<parameter name="url_kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="663">the URL kind, e.g. %AS_RELEASE_URL_KIND_DETAILS.</doc>
<type name="ReleaseUrlKind" c:type="AsReleaseUrlKind"/>
</parameter>
</parameters>
</method>
<method name="get_version" c:identifier="as_release_get_version">
<doc xml:space="preserve"
filename="src/as-release.c"
line="290">Gets the release version.</doc>
<source-position filename="src/as-release.h" line="122"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="src/as-release.c"
line="296">string, or %NULL for not set or invalid</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="release" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="292">a #AsRelease instance.</doc>
<type name="Release" c:type="AsRelease*"/>
</instance-parameter>
</parameters>
</method>
<method name="has_tag" c:identifier="as_release_has_tag" version="1.0.0">
<doc xml:space="preserve"
filename="src/as-release.c"
line="817">Test if the release is tagged with the selected tag.</doc>
<source-position filename="src/as-release.h" line="155"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="825">%TRUE if tag exists.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="release" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="819">an #AsRelease instance.</doc>
<type name="Release" c:type="AsRelease*"/>
</instance-parameter>
<parameter name="ns" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="820">The namespace the tag belongs to</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="tag" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="821">The tag name</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="remove_tag"
c:identifier="as_release_remove_tag"
version="1.0.0">
<doc xml:space="preserve"
filename="src/as-release.c"
line="788">Remove a tag from this release</doc>
<source-position filename="src/as-release.h" line="154"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="796">%TRUE if the tag was removed.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="release" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="790">an #AsRelease instance.</doc>
<type name="Release" c:type="AsRelease*"/>
</instance-parameter>
<parameter name="ns" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="791">The namespace the tag belongs to</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="tag" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="792">The tag name</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_context"
c:identifier="as_release_set_context"
version="0.11.2">
<doc xml:space="preserve"
filename="src/as-release.c"
line="722">Sets the document context this release is associated
with.</doc>
<source-position filename="src/as-release.h" line="117"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="release" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="724">An instance of #AsRelease.</doc>
<type name="Release" c:type="AsRelease*"/>
</instance-parameter>
<parameter name="context" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="725">the #AsContext.</doc>
<type name="Context" c:type="AsContext*"/>
</parameter>
</parameters>
</method>
<method name="set_date"
c:identifier="as_release_set_date"
version="0.12.5">
<doc xml:space="preserve"
filename="src/as-release.c"
line="392">Sets the release date.</doc>
<source-position filename="src/as-release.h" line="128"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="release" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="394">a #AsRelease instance.</doc>
<type name="Release" c:type="AsRelease*"/>
</instance-parameter>
<parameter name="date" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="395">the date in ISO8601 format.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_date_eol"
c:identifier="as_release_set_date_eol"
version="0.12.5">
<doc xml:space="preserve"
filename="src/as-release.c"
line="439">Sets the end-of-life date for this release.</doc>
<source-position filename="src/as-release.h" line="133"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="release" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="441">a #AsRelease instance.</doc>
<type name="Release" c:type="AsRelease*"/>
</instance-parameter>
<parameter name="date" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="442">the EOL date in ISO8601 format.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_description" c:identifier="as_release_set_description">
<doc xml:space="preserve"
filename="src/as-release.c"
line="568">Sets the description release markup.</doc>
<source-position filename="src/as-release.h" line="138"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="release" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="570">a #AsRelease instance.</doc>
<type name="Release" c:type="AsRelease*"/>
</instance-parameter>
<parameter name="description" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="571">the description markup.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="locale"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="src/as-release.c"
line="572">the BCP47 locale, or %NULL. e.g. "en-GB".</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_kind"
c:identifier="as_release_set_kind"
version="0.12.0">
<doc xml:space="preserve"
filename="src/as-release.c"
line="272">Sets the release kind to distinguish between end-user ready
stable releases and development prereleases..</doc>
<source-position filename="src/as-release.h" line="120"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="release" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="274">a #AsRelease instance.</doc>
<type name="Release" c:type="AsRelease*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="275">the #AsReleaseKind</doc>
<type name="ReleaseKind" c:type="AsReleaseKind"/>
</parameter>
</parameters>
</method>
<method name="set_timestamp" c:identifier="as_release_set_timestamp">
<doc xml:space="preserve"
filename="src/as-release.c"
line="354">Sets the release timestamp.</doc>
<source-position filename="src/as-release.h" line="130"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="release" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="356">a #AsRelease instance.</doc>
<type name="Release" c:type="AsRelease*"/>
</instance-parameter>
<parameter name="timestamp" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="357">the timestamp value.</doc>
<type name="guint64" c:type="guint64"/>
</parameter>
</parameters>
</method>
<method name="set_timestamp_eol"
c:identifier="as_release_set_timestamp_eol"
version="0.12.5">
<doc xml:space="preserve"
filename="src/as-release.c"
line="488">Sets the UNIX timestamp for the date when this
release is out of support (end-of-life).</doc>
<source-position filename="src/as-release.h" line="135"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="release" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="490">a #AsRelease instance.</doc>
<type name="Release" c:type="AsRelease*"/>
</instance-parameter>
<parameter name="timestamp" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="491">the timestamp value.</doc>
<type name="guint64" c:type="guint64"/>
</parameter>
</parameters>
</method>
<method name="set_urgency"
c:identifier="as_release_set_urgency"
version="0.6.5">
<doc xml:space="preserve"
filename="src/as-release.c"
line="533">Sets the release urgency.</doc>
<source-position filename="src/as-release.h" line="141"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="release" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="535">a #AsRelease instance.</doc>
<type name="Release" c:type="AsRelease*"/>
</instance-parameter>
<parameter name="urgency" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="536">the urgency of this release/update (as #AsUrgencyKind)</doc>
<type name="UrgencyKind" c:type="AsUrgencyKind"/>
</parameter>
</parameters>
</method>
<method name="set_url"
c:identifier="as_release_set_url"
version="0.12.5">
<doc xml:space="preserve"
filename="src/as-release.c"
line="683">Sets an URL for this release.</doc>
<source-position filename="src/as-release.h" line="150"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="release" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="685">a #AsRelease instance.</doc>
<type name="Release" c:type="AsRelease*"/>
</instance-parameter>
<parameter name="url_kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="686">the URL kind, e.g. %AS_RELEASE_URL_KIND_DETAILS</doc>
<type name="ReleaseUrlKind" c:type="AsReleaseUrlKind"/>
</parameter>
<parameter name="url" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="687">the full URL.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_version" c:identifier="as_release_set_version">
<doc xml:space="preserve"
filename="src/as-release.c"
line="306">Sets the release version.</doc>
<source-position filename="src/as-release.h" line="123"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="release" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="308">a #AsRelease instance.</doc>
<type name="Release" c:type="AsRelease*"/>
</instance-parameter>
<parameter name="version" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="309">the version string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="vercmp" c:identifier="as_release_vercmp">
<doc xml:space="preserve"
filename="src/as-release.c"
line="321">Compare the version numbers of two releases.</doc>
<source-position filename="src/as-release.h" line="125"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="328">1 if @rel1 version is higher than @rel2, 0 if versions are equal, -1 if @rel2 version is higher than @rel1.</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="rel1" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="323">an #AsRelease</doc>
<type name="Release" c:type="AsRelease*"/>
</instance-parameter>
<parameter name="rel2" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="324">an #AsRelease</doc>
<type name="Release" c:type="AsRelease*"/>
</parameter>
</parameters>
</method>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<record name="ReleaseClass"
c:type="AsReleaseClass"
glib:is-gtype-struct-for="Release">
<source-position filename="src/as-release.h" line="47"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_as_reserved1" introspectable="0">
<callback name="_as_reserved1">
<source-position filename="src/as-release.h" line="41"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved2" introspectable="0">
<callback name="_as_reserved2">
<source-position filename="src/as-release.h" line="42"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved3" introspectable="0">
<callback name="_as_reserved3">
<source-position filename="src/as-release.h" line="43"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved4" introspectable="0">
<callback name="_as_reserved4">
<source-position filename="src/as-release.h" line="44"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved5" introspectable="0">
<callback name="_as_reserved5">
<source-position filename="src/as-release.h" line="45"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved6" introspectable="0">
<callback name="_as_reserved6">
<source-position filename="src/as-release.h" line="46"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
</record>
<enumeration name="ReleaseKind"
version="0.12.0"
glib:type-name="AsReleaseKind"
glib:get-type="as_release_kind_get_type"
c:type="AsReleaseKind">
<doc xml:space="preserve"
filename="src/as-release.h"
line="49">The release kind.</doc>
<member name="unknown"
value="0"
c:identifier="AS_RELEASE_KIND_UNKNOWN"
glib:nick="unknown"
glib:name="AS_RELEASE_KIND_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-release.h"
line="51">Unknown release type</doc>
</member>
<member name="stable"
value="1"
c:identifier="AS_RELEASE_KIND_STABLE"
glib:nick="stable"
glib:name="AS_RELEASE_KIND_STABLE">
<doc xml:space="preserve"
filename="src/as-release.h"
line="52">A stable release for end-users</doc>
</member>
<member name="development"
value="2"
c:identifier="AS_RELEASE_KIND_DEVELOPMENT"
glib:nick="development"
glib:name="AS_RELEASE_KIND_DEVELOPMENT">
<doc xml:space="preserve"
filename="src/as-release.h"
line="53">A development release or pre-release for testing</doc>
</member>
<member name="snapshot"
value="3"
c:identifier="AS_RELEASE_KIND_SNAPSHOT"
glib:nick="snapshot"
glib:name="AS_RELEASE_KIND_SNAPSHOT">
<doc xml:space="preserve"
filename="src/as-release.h"
line="54">A snapshot of a software being worked on</doc>
</member>
<function name="from_string"
c:identifier="as_release_kind_from_string"
version="0.12.0">
<doc xml:space="preserve"
filename="src/as-release.c"
line="92">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-release.h" line="70"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="98">an #AsReleaseKind or %AS_RELEASE_KIND_UNKNOWN for unknown</doc>
<type name="ReleaseKind" c:type="AsReleaseKind"/>
</return-value>
<parameters>
<parameter name="kind_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="94">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="to_string"
c:identifier="as_release_kind_to_string"
version="0.12.0">
<doc xml:space="preserve"
filename="src/as-release.c"
line="70">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-release.h" line="69"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="76">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="72">the #AsReleaseKind.</doc>
<type name="ReleaseKind" c:type="AsReleaseKind"/>
</parameter>
</parameters>
</function>
</enumeration>
<class name="ReleaseList"
c:symbol-prefix="release_list"
c:type="AsReleaseList"
parent="GObject.Object"
glib:type-name="AsReleaseList"
glib:get-type="as_release_list_get_type"
glib:type-struct="ReleaseListClass">
<source-position filename="src/as-release-list.h" line="51"/>
<constructor name="new" c:identifier="as_release_list_new" version="1.0">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="127">Creates a new #AsReleaseList.</doc>
<source-position filename="src/as-release-list.h" line="80"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="132">an #AsReleaseList</doc>
<type name="ReleaseList" c:type="AsReleaseList*"/>
</return-value>
</constructor>
<method name="add" c:identifier="as_release_list_add">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="228">Append a release entry to this #AsReleaseList container.</doc>
<source-position filename="src/as-release-list.h" line="92"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="rels" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="230">An instance of #AsReleaseList.</doc>
<type name="ReleaseList" c:type="AsReleaseList*"/>
</instance-parameter>
<parameter name="release" transfer-ownership="none">
<type name="Release" c:type="AsRelease*"/>
</parameter>
</parameters>
</method>
<method name="clear" c:identifier="as_release_list_clear">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="385">Remove all release entries from this releases object.</doc>
<source-position filename="src/as-release-list.h" line="93"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="rels" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="387">a #AsReleaseList instance.</doc>
<type name="ReleaseList" c:type="AsReleaseList*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_context" c:identifier="as_release_list_get_context">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="240">Get the #AsContext associated with these releases.
This function may return %NULL if no context is set</doc>
<source-position filename="src/as-release-list.h" line="97"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="247">the associated #AsContext or %NULL</doc>
<type name="Context" c:type="AsContext*"/>
</return-value>
<parameters>
<instance-parameter name="rels" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="242">a #AsReleaseList instance.</doc>
<type name="ReleaseList" c:type="AsReleaseList*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_entries" c:identifier="as_release_list_get_entries">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="168">Get the release entries as #GPtrArray.</doc>
<source-position filename="src/as-release-list.h" line="86"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="174">an array of #AsRelease instances.</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="Release"/>
</array>
</return-value>
<parameters>
<instance-parameter name="rels" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="170">An instance of #AsReleaseList.</doc>
<type name="ReleaseList" c:type="AsReleaseList*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_kind"
c:identifier="as_release_list_get_kind"
version="0.16.0">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="282">Returns the #AsReleaseListKind of the release metadata
associated with this component.</doc>
<source-position filename="src/as-release-list.h" line="100"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="289">The kind.</doc>
<type name="ReleaseListKind" c:type="AsReleaseListKind"/>
</return-value>
<parameters>
<instance-parameter name="rels" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="284">a #AsReleaseList instance.</doc>
<type name="ReleaseList" c:type="AsReleaseList*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_size" c:identifier="as_release_list_get_size">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="182">Get the amount of components in this box.</doc>
<source-position filename="src/as-release-list.h" line="87"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="188">Amount of components.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="rels" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="184">An instance of #AsReleaseList.</doc>
<type name="ReleaseList" c:type="AsReleaseList*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_url"
c:identifier="as_release_list_get_url"
version="0.16.0">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="317">Get the remote URL to obtain release information from.</doc>
<source-position filename="src/as-release-list.h" line="103"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="323">The URL of external release data, or %NULL</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="rels" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="319">a #AsReleaseList instance.</doc>
<type name="ReleaseList" c:type="AsReleaseList*"/>
</instance-parameter>
</parameters>
</method>
<method name="index_safe" c:identifier="as_release_list_index_safe">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="210">Retrieve a release entry at the respective index from the
release entry list.</doc>
<source-position filename="src/as-release-list.h" line="89"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="218">An #AsRelease or %NULL</doc>
<type name="Release" c:type="AsRelease*"/>
</return-value>
<parameters>
<instance-parameter name="rels" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="212">An instance of #AsReleaseList.</doc>
<type name="ReleaseList" c:type="AsReleaseList*"/>
</instance-parameter>
<parameter name="index" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="213">The release entry index.</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="is_empty" c:identifier="as_release_list_is_empty">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="196">Check if there are any components present.</doc>
<source-position filename="src/as-release-list.h" line="90"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="202">%TRUE if this component box is empty.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="rels" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="198">An instance of #AsReleaseList.</doc>
<type name="ReleaseList" c:type="AsReleaseList*"/>
</instance-parameter>
</parameters>
</method>
<method name="load_from_bytes"
c:identifier="as_release_list_load_from_bytes"
version="0.16.0"
throws="1">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="409">Load release information from XML bytes.</doc>
<source-position filename="src/as-release-list.h" line="106"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="418">%TRUE on success.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="rels" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="411">a #AsReleaseList instance.</doc>
<type name="ReleaseList" c:type="AsReleaseList*"/>
</instance-parameter>
<parameter name="context"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="412">the attached #AsContext or %NULL to use the current context</doc>
<type name="Context" c:type="AsContext*"/>
</parameter>
<parameter name="bytes" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="413">the release XML data as #GBytes</doc>
<type name="GLib.Bytes" c:type="GBytes*"/>
</parameter>
</parameters>
</method>
<method name="set_context" c:identifier="as_release_list_set_context">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="256">Sets the document context these releases are associated with.</doc>
<source-position filename="src/as-release-list.h" line="98"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="rels" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="258">a #AsReleaseList instance.</doc>
<type name="ReleaseList" c:type="AsReleaseList*"/>
</instance-parameter>
<parameter name="context" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="259">the #AsContext.</doc>
<type name="Context" c:type="AsContext*"/>
</parameter>
</parameters>
</method>
<method name="set_kind"
c:identifier="as_release_list_set_kind"
version="0.16.0">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="300">Sets the #AsReleaseListKind of the release metadata
associated with this component.</doc>
<source-position filename="src/as-release-list.h" line="101"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="rels" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="302">a #AsReleaseList instance.</doc>
<type name="ReleaseList" c:type="AsReleaseList*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="303">the #AsComponentKind.</doc>
<type name="ReleaseListKind" c:type="AsReleaseListKind"/>
</parameter>
</parameters>
</method>
<method name="set_size" c:identifier="as_release_list_set_size">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="397">Set the amount of release entries stored.</doc>
<source-position filename="src/as-release-list.h" line="88"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="rels" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="399">a #AsReleaseList instance.</doc>
<type name="ReleaseList" c:type="AsReleaseList*"/>
</instance-parameter>
<parameter name="size" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="set_url"
c:identifier="as_release_list_set_url"
version="0.16.0">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="334">Set a remote URL pointing to an AppStream release info file.</doc>
<source-position filename="src/as-release-list.h" line="104"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="rels" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="336">a #AsReleaseList instance.</doc>
<type name="ReleaseList" c:type="AsReleaseList*"/>
</instance-parameter>
<parameter name="url" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="337">the web URL where release data is found.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="sort" c:identifier="as_release_list_sort">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="372">Sort releases by their release version,
starting with the most recent release.</doc>
<source-position filename="src/as-release-list.h" line="95"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="rels" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="374">a #AsReleaseList instance.</doc>
<type name="ReleaseList" c:type="AsReleaseList*"/>
</instance-parameter>
</parameters>
</method>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
<field name="entries" readable="0" private="1">
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</class>
<record name="ReleaseListClass"
c:type="AsReleaseListClass"
glib:is-gtype-struct-for="ReleaseList">
<source-position filename="src/as-release-list.h" line="51"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_as_reserved1" introspectable="0">
<callback name="_as_reserved1">
<source-position filename="src/as-release-list.h" line="45"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved2" introspectable="0">
<callback name="_as_reserved2">
<source-position filename="src/as-release-list.h" line="46"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved3" introspectable="0">
<callback name="_as_reserved3">
<source-position filename="src/as-release-list.h" line="47"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved4" introspectable="0">
<callback name="_as_reserved4">
<source-position filename="src/as-release-list.h" line="48"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved5" introspectable="0">
<callback name="_as_reserved5">
<source-position filename="src/as-release-list.h" line="49"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved6" introspectable="0">
<callback name="_as_reserved6">
<source-position filename="src/as-release-list.h" line="50"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
</record>
<enumeration name="ReleaseListKind"
version="0.16.0"
glib:type-name="AsReleaseListKind"
glib:get-type="as_release_list_kind_get_type"
c:type="AsReleaseListKind">
<doc xml:space="preserve"
filename="src/as-release-list.h"
line="59">The kind of a releases block.</doc>
<member name="unknown"
value="0"
c:identifier="AS_RELEASE_LIST_KIND_UNKNOWN"
glib:nick="unknown"
glib:name="AS_RELEASE_LIST_KIND_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-release-list.h"
line="61">Unknown releases type</doc>
</member>
<member name="embedded"
value="1"
c:identifier="AS_RELEASE_LIST_KIND_EMBEDDED"
glib:nick="embedded"
glib:name="AS_RELEASE_LIST_KIND_EMBEDDED">
<doc xml:space="preserve"
filename="src/as-release-list.h"
line="62">Release info is embedded in metainfo file</doc>
</member>
<member name="external"
value="2"
c:identifier="AS_RELEASE_LIST_KIND_EXTERNAL"
glib:nick="external"
glib:name="AS_RELEASE_LIST_KIND_EXTERNAL">
<doc xml:space="preserve"
filename="src/as-release-list.h"
line="63">Release info is split to a separate file</doc>
</member>
<function name="from_string"
c:identifier="as_release_list_kind_from_string"
version="0.16.0">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="74">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-release-list.h" line="78"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="80">an #AsReleaseKind or %AS_RELEASE_KIND_UNKNOWN for unknown</doc>
<type name="ReleaseListKind" c:type="AsReleaseListKind"/>
</return-value>
<parameters>
<parameter name="kind_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="76">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="to_string"
c:identifier="as_release_list_kind_to_string"
version="0.16.0">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="54">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-release-list.h" line="77"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="60">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="56">the #AsReleaseKind.</doc>
<type name="ReleaseListKind" c:type="AsReleaseListKind"/>
</parameter>
</parameters>
</function>
</enumeration>
<enumeration name="ReleaseUrlKind"
version="0.12.5"
glib:type-name="AsReleaseUrlKind"
glib:get-type="as_release_url_kind_get_type"
c:type="AsReleaseUrlKind">
<doc xml:space="preserve"
filename="src/as-release.h"
line="95">@AS_RELEASE_URL_KIND_UNKNOWN Unknown release web URL type
The release URL kinds.</doc>
<member name="unknown"
value="0"
c:identifier="AS_RELEASE_URL_KIND_UNKNOWN"
glib:nick="unknown"
glib:name="AS_RELEASE_URL_KIND_UNKNOWN">
</member>
<member name="details"
value="1"
c:identifier="AS_RELEASE_URL_KIND_DETAILS"
glib:nick="details"
glib:name="AS_RELEASE_URL_KIND_DETAILS">
<doc xml:space="preserve"
filename="src/as-release.h"
line="98">Weblink to detailed release notes.</doc>
</member>
<function name="from_string"
c:identifier="as_release_url_kind_from_string"
version="0.12.5">
<doc xml:space="preserve"
filename="src/as-release.c"
line="180">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-release.h" line="112"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="186">an #AsReleaseUrlKind or %AS_RELEASE_URL_KIND_UNKNOWN for unknown</doc>
<type name="ReleaseUrlKind" c:type="AsReleaseUrlKind"/>
</return-value>
<parameters>
<parameter name="kind_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="182">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="to_string"
c:identifier="as_release_url_kind_to_string"
version="0.12.5">
<doc xml:space="preserve"
filename="src/as-release.c"
line="162">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-release.h" line="111"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="168">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="164">the #AsReleaseUrlKind.</doc>
<type name="ReleaseUrlKind" c:type="AsReleaseUrlKind"/>
</parameter>
</parameters>
</function>
</enumeration>
<class name="Review"
c:symbol-prefix="review"
c:type="AsReview"
parent="GObject.Object"
glib:type-name="AsReview"
glib:get-type="as_review_get_type"
glib:type-struct="ReviewClass">
<source-position filename="src/as-review.h" line="47"/>
<constructor name="new" c:identifier="as_review_new" version="0.14.0">
<doc xml:space="preserve"
filename="src/as-review.c"
line="1046">Creates a new #AsReview.</doc>
<source-position filename="src/as-review.h" line="67"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-review.c"
line="1051">a #AsReview</doc>
<type name="Review" c:type="AsReview*"/>
</return-value>
</constructor>
<method name="add_flags"
c:identifier="as_review_add_flags"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-review.c"
line="626">Adds flags to an existing review without replacing the other flags.</doc>
<source-position filename="src/as-review.h" line="101"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="review" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="628">a #AsReview</doc>
<type name="Review" c:type="AsReview*"/>
</instance-parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="629">a #AsReviewFlags, e.g. %AS_REVIEW_FLAG_SELF</doc>
<type name="ReviewFlags" c:type="AsReviewFlags"/>
</parameter>
</parameters>
</method>
<method name="add_metadata"
c:identifier="as_review_add_metadata"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-review.c"
line="820">Adds metadata to the review object.
It is left for the the plugin to use this method as required, but a
typical use would be to store some secure authentication token.</doc>
<source-position filename="src/as-review.h" line="104"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="review" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="822">a #AsReview</doc>
<type name="Review" c:type="AsReview*"/>
</instance-parameter>
<parameter name="key" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="823">a string</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="824">a string</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="equal" c:identifier="as_review_equal" version="0.14.0">
<doc xml:space="preserve"
filename="src/as-review.c"
line="842">Checks if two reviews are the same.</doc>
<source-position filename="src/as-review.h" line="106"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="849">%TRUE for success</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="review1" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="844">a #AsReview instance.</doc>
<type name="Review" c:type="AsReview*"/>
</instance-parameter>
<parameter name="review2" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="845">a #AsReview instance.</doc>
<type name="Review" c:type="AsReview*"/>
</parameter>
</parameters>
</method>
<method name="get_date"
c:identifier="as_review_get_date"
glib:get-property="date"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-review.c"
line="755">Gets the date the review was originally submitted.</doc>
<source-position filename="src/as-review.h" line="96"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="761">the #GDateTime, or %NULL for unset</doc>
<type name="GLib.DateTime" c:type="GDateTime*"/>
</return-value>
<parameters>
<instance-parameter name="review" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="757">a #AsReview</doc>
<type name="Review" c:type="AsReview*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_description"
c:identifier="as_review_get_description"
glib:get-property="description"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-review.c"
line="474">Gets the multi-line review text that forms the body of the review.</doc>
<source-position filename="src/as-review.h" line="78"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="480">the string, or %NULL</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="review" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="476">a #AsReview</doc>
<type name="Review" c:type="AsReview*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_flags"
c:identifier="as_review_get_flags"
glib:get-property="flags"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-review.c"
line="585">Gets any flags set on the review, for example if the user has already
voted on the review or if the user wrote the review themselves.</doc>
<source-position filename="src/as-review.h" line="99"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="592">a #AsReviewFlags, e.g. %AS_REVIEW_FLAG_SELF</doc>
<type name="ReviewFlags" c:type="AsReviewFlags"/>
</return-value>
<parameters>
<instance-parameter name="review" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="587">a #AsReview</doc>
<type name="Review" c:type="AsReview*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_id"
c:identifier="as_review_get_id"
glib:get-property="id"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-review.c"
line="402">Gets the review id.</doc>
<source-position filename="src/as-review.h" line="72"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="408">the review identifier, e.g. "deadbeef"</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="review" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="404">a #AsReview</doc>
<type name="Review" c:type="AsReview*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_locale"
c:identifier="as_review_get_locale"
glib:get-property="locale"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-review.c"
line="510">Gets the locale for the review.</doc>
<source-position filename="src/as-review.h" line="81"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="516">the string, or %NULL</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="review" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="512">a #AsReview</doc>
<type name="Review" c:type="AsReview*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_metadata_item"
c:identifier="as_review_get_metadata_item"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-review.c"
line="798">Gets some metadata from a review object.
It is left for the the plugin to use this method as required, but a
typical use would be to retrieve some secure authentication token.</doc>
<source-position filename="src/as-review.h" line="103"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="807">A string value, or %NULL for not found</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="review" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="800">a #AsReview</doc>
<type name="Review" c:type="AsReview*"/>
</instance-parameter>
<parameter name="key" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="801">a string</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="get_priority"
c:identifier="as_review_get_priority"
glib:get-property="priority"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-review.c"
line="361">This allows the UI to sort reviews into the correct order.
Higher numbers indicate a more important or relevant review.</doc>
<source-position filename="src/as-review.h" line="69"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="368">the review priority, or 0 for unset.</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="review" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="363">a #AsReview</doc>
<type name="Review" c:type="AsReview*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_rating"
c:identifier="as_review_get_rating"
glib:get-property="rating"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-review.c"
line="546">Gets the star rating of the review, where 100 is 5 stars.</doc>
<source-position filename="src/as-review.h" line="84"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="552">integer as a percentage, or 0 for unset</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="review" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="548">a #AsReview</doc>
<type name="Review" c:type="AsReview*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_reviewer_id"
c:identifier="as_review_get_reviewer_id"
glib:get-property="reviewer-id"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-review.c"
line="647">Gets the name of the reviewer.</doc>
<source-position filename="src/as-review.h" line="90"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="653">the reviewer ID, e.g. "deadbeef", or %NULL</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="review" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="649">a #AsReview</doc>
<type name="Review" c:type="AsReview*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_reviewer_name"
c:identifier="as_review_get_reviewer_name"
glib:get-property="reviewer-name"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-review.c"
line="665">Gets the name of the reviewer.</doc>
<source-position filename="src/as-review.h" line="93"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="671">the reviewer name, e.g. "David Smith", or %NULL</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="review" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="667">a #AsReview</doc>
<type name="Review" c:type="AsReview*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_summary"
c:identifier="as_review_get_summary"
glib:get-property="summary"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-review.c"
line="420">Gets the review summary.</doc>
<source-position filename="src/as-review.h" line="75"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="426">the one-line summary, e.g. "Awesome application"</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="review" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="422">a #AsReview</doc>
<type name="Review" c:type="AsReview*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_version"
c:identifier="as_review_get_version"
glib:get-property="version"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-review.c"
line="737">Gets the version string for the application being reviewed..</doc>
<source-position filename="src/as-review.h" line="87"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="743">the version string, e.g. "0.1.2", or %NULL for unset</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="review" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="739">a #AsReview</doc>
<type name="Review" c:type="AsReview*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_date"
c:identifier="as_review_set_date"
glib:set-property="date"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-review.c"
line="773">Sets the date the review was originally submitted.</doc>
<source-position filename="src/as-review.h" line="97"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="review" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="775">a #AsReview</doc>
<type name="Review" c:type="AsReview*"/>
</instance-parameter>
<parameter name="date" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="776">a #GDateTime, or %NULL</doc>
<type name="GLib.DateTime" c:type="GDateTime*"/>
</parameter>
</parameters>
</method>
<method name="set_description"
c:identifier="as_review_set_description"
glib:set-property="description"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-review.c"
line="492">Sets the multi-line review text that forms the body of the review.</doc>
<source-position filename="src/as-review.h" line="79"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="review" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="494">a #AsReview</doc>
<type name="Review" c:type="AsReview*"/>
</instance-parameter>
<parameter name="description" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="495">multi-line description</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_flags"
c:identifier="as_review_set_flags"
glib:set-property="flags"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-review.c"
line="604">Gets any flags set on the review, for example if the user has already
voted on the review or if the user wrote the review themselves.</doc>
<source-position filename="src/as-review.h" line="100"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="review" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="606">a #AsReview</doc>
<type name="Review" c:type="AsReview*"/>
</instance-parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="607">a #AsReviewFlags, e.g. %AS_REVIEW_FLAG_SELF</doc>
<type name="ReviewFlags" c:type="AsReviewFlags"/>
</parameter>
</parameters>
</method>
<method name="set_id"
c:identifier="as_review_set_id"
glib:set-property="id"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-review.c"
line="438">Sets the review identifier that is unique to each review.</doc>
<source-position filename="src/as-review.h" line="73"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="review" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="440">a #AsReview</doc>
<type name="Review" c:type="AsReview*"/>
</instance-parameter>
<parameter name="id" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="441">review identifier, e.g. "deadbeef"</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_locale"
c:identifier="as_review_set_locale"
glib:set-property="locale"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-review.c"
line="528">Sets the locale for the review.</doc>
<source-position filename="src/as-review.h" line="82"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="review" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="530">a #AsReview</doc>
<type name="Review" c:type="AsReview*"/>
</instance-parameter>
<parameter name="locale" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="531">a BCP47 locale, e.g. "en-GB"</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_priority"
c:identifier="as_review_set_priority"
glib:set-property="priority"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-review.c"
line="380">Sets the priority for the review, where positive numbers indicate
a better review for the specific user.</doc>
<source-position filename="src/as-review.h" line="70"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="review" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="382">a #AsReview</doc>
<type name="Review" c:type="AsReview*"/>
</instance-parameter>
<parameter name="priority" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="383">a priority value</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="set_rating"
c:identifier="as_review_set_rating"
glib:set-property="rating"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-review.c"
line="564">Sets the star rating of the review, where 100 is 5 stars..</doc>
<source-position filename="src/as-review.h" line="85"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="review" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="566">a #AsReview</doc>
<type name="Review" c:type="AsReview*"/>
</instance-parameter>
<parameter name="rating" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="567">a integer as a percentage, or 0 for unset</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="set_reviewer_id"
c:identifier="as_review_set_reviewer_id"
glib:set-property="reviewer-id"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-review.c"
line="683">Sets the name of the reviewer, which can be left unset.</doc>
<source-position filename="src/as-review.h" line="91"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="review" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="685">a #AsReview</doc>
<type name="Review" c:type="AsReview*"/>
</instance-parameter>
<parameter name="reviewer_id" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="686">the reviewer ID, e.g. "deadbeef"</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_reviewer_name"
c:identifier="as_review_set_reviewer_name"
glib:set-property="reviewer-name"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-review.c"
line="701">Sets the name of the reviewer, which can be left unset.</doc>
<source-position filename="src/as-review.h" line="94"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="review" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="703">a #AsReview</doc>
<type name="Review" c:type="AsReview*"/>
</instance-parameter>
<parameter name="reviewer_name" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="704">the reviewer name, e.g. "David Smith"</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_summary"
c:identifier="as_review_set_summary"
glib:set-property="summary"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-review.c"
line="456">Sets the one-line summary that may be displayed in bold.</doc>
<source-position filename="src/as-review.h" line="76"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="review" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="458">a #AsReview</doc>
<type name="Review" c:type="AsReview*"/>
</instance-parameter>
<parameter name="summary" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="459">a one-line summary, e.g. "Awesome application"</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_version"
c:identifier="as_review_set_version"
glib:set-property="version"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-review.c"
line="719">Sets the version string for the application being reviewed.</doc>
<source-position filename="src/as-review.h" line="88"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="review" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="721">a #AsReview</doc>
<type name="Review" c:type="AsReview*"/>
</instance-parameter>
<parameter name="version" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-review.c"
line="722">a version string, e.g. "0.1.2"</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<property name="date"
version="0.14.0"
writable="1"
construct="1"
transfer-ownership="none"
setter="set_date"
getter="get_date">
<type name="Review"/>
</property>
<property name="description"
version="0.14.0"
writable="1"
construct="1"
transfer-ownership="none"
setter="set_description"
getter="get_description"
default-value="NULL">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="flags"
version="0.14.0"
writable="1"
construct="1"
transfer-ownership="none"
setter="set_flags"
getter="get_flags"
default-value="0">
<type name="guint64" c:type="guint64"/>
</property>
<property name="id"
version="0.14.0"
writable="1"
construct="1"
transfer-ownership="none"
setter="set_id"
getter="get_id"
default-value="NULL">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="locale"
version="0.14.0"
writable="1"
construct="1"
transfer-ownership="none"
setter="set_locale"
getter="get_locale"
default-value="NULL">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="priority"
version="0.15.6"
writable="1"
construct="1"
transfer-ownership="none"
setter="set_priority"
getter="get_priority"
default-value="0">
<doc xml:space="preserve"
filename="src/as-review.c"
line="258">The priority for the review, where positive numbers indicate
a better review for the specific user.</doc>
<type name="gint" c:type="gint"/>
</property>
<property name="rating"
version="0.14.0"
writable="1"
construct="1"
transfer-ownership="none"
setter="set_rating"
getter="get_rating"
default-value="0">
<type name="gint" c:type="gint"/>
</property>
<property name="reviewer-id"
version="0.14.0"
writable="1"
construct="1"
transfer-ownership="none"
setter="set_reviewer_id"
getter="get_reviewer_id"
default-value="NULL">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="reviewer-name"
version="0.14.0"
writable="1"
construct="1"
transfer-ownership="none"
setter="set_reviewer_name"
getter="get_reviewer_name"
default-value="NULL">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="summary"
version="0.14.0"
writable="1"
construct="1"
transfer-ownership="none"
setter="set_summary"
getter="get_summary"
default-value="NULL">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="version"
version="0.14.0"
writable="1"
construct="1"
transfer-ownership="none"
setter="set_version"
getter="get_version"
default-value="NULL">
<type name="utf8" c:type="gchar*"/>
</property>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<record name="ReviewClass"
c:type="AsReviewClass"
glib:is-gtype-struct-for="Review">
<source-position filename="src/as-review.h" line="47"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_as_reserved1" introspectable="0">
<callback name="_as_reserved1">
<source-position filename="src/as-review.h" line="39"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved2" introspectable="0">
<callback name="_as_reserved2">
<source-position filename="src/as-review.h" line="40"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved3" introspectable="0">
<callback name="_as_reserved3">
<source-position filename="src/as-review.h" line="41"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved4" introspectable="0">
<callback name="_as_reserved4">
<source-position filename="src/as-review.h" line="42"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved5" introspectable="0">
<callback name="_as_reserved5">
<source-position filename="src/as-review.h" line="43"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved6" introspectable="0">
<callback name="_as_reserved6">
<source-position filename="src/as-review.h" line="44"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved7" introspectable="0">
<callback name="_as_reserved7">
<source-position filename="src/as-review.h" line="45"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved8" introspectable="0">
<callback name="_as_reserved8">
<source-position filename="src/as-review.h" line="46"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
</record>
<bitfield name="ReviewFlags"
version="0.14.0"
glib:type-name="AsReviewFlags"
glib:get-type="as_review_flags_get_type"
c:type="AsReviewFlags">
<doc xml:space="preserve"
filename="src/as-review.h"
line="49">The flags for the review.</doc>
<member name="none"
value="0"
c:identifier="AS_REVIEW_FLAG_NONE"
glib:nick="none"
glib:name="AS_REVIEW_FLAG_NONE">
<doc xml:space="preserve"
filename="src/as-review.h"
line="51">No special flags set</doc>
</member>
<member name="self"
value="1"
c:identifier="AS_REVIEW_FLAG_SELF"
glib:nick="self"
glib:name="AS_REVIEW_FLAG_SELF">
<doc xml:space="preserve"
filename="src/as-review.h"
line="52">The user wrote the review themselves</doc>
</member>
<member name="voted"
value="2"
c:identifier="AS_REVIEW_FLAG_VOTED"
glib:nick="voted"
glib:name="AS_REVIEW_FLAG_VOTED">
<doc xml:space="preserve"
filename="src/as-review.h"
line="53">The user voted on the review</doc>
</member>
</bitfield>
<class name="Screenshot"
c:symbol-prefix="screenshot"
c:type="AsScreenshot"
parent="GObject.Object"
glib:type-name="AsScreenshot"
glib:get-type="as_screenshot_get_type"
glib:type-struct="ScreenshotClass">
<source-position filename="src/as-screenshot.h" line="49"/>
<constructor name="new" c:identifier="as_screenshot_new">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="843">Creates a new #AsScreenshot.</doc>
<source-position filename="src/as-screenshot.h" line="87"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="848">a #AsScreenshot</doc>
<type name="Screenshot" c:type="AsScreenshot*"/>
</return-value>
</constructor>
<method name="add_image" c:identifier="as_screenshot_add_image">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="322">Adds an image to the screenshot.</doc>
<source-position filename="src/as-screenshot.h" line="108"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="screenshot" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="324">a #AsScreenshot instance.</doc>
<type name="Screenshot" c:type="AsScreenshot*"/>
</instance-parameter>
<parameter name="image" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="325">a #AsImage instance.</doc>
<type name="Image" c:type="AsImage*"/>
</parameter>
</parameters>
</method>
<method name="add_video" c:identifier="as_screenshot_add_video">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="391">Adds a video to the screenshot.</doc>
<source-position filename="src/as-screenshot.h" line="113"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="screenshot" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="393">a #AsScreenshot instance.</doc>
<type name="Screenshot" c:type="AsScreenshot*"/>
</instance-parameter>
<parameter name="video" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="394">a #AsVideo instance.</doc>
<type name="Video" c:type="AsVideo*"/>
</parameter>
</parameters>
</method>
<method name="clear_images"
c:identifier="as_screenshot_clear_images"
version="0.15.4">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="340">Remove all images associated with this screenshot.</doc>
<source-position filename="src/as-screenshot.h" line="109"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="screenshot" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="342">a #AsScreenshot instance.</doc>
<type name="Screenshot" c:type="AsScreenshot*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_caption" c:identifier="as_screenshot_get_caption">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="410">Gets the image caption</doc>
<source-position filename="src/as-screenshot.h" line="100"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="416">the caption</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="screenshot" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="412">a #AsScreenshot instance.</doc>
<type name="Screenshot" c:type="AsScreenshot*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_context"
c:identifier="as_screenshot_get_context"
version="0.11.2">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="536">Returns the #AsContext associated with this screenshot.
This function may return %NULL if no context is set.</doc>
<source-position filename="src/as-screenshot.h" line="95"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="543">the #AsContext used by this screenshot.</doc>
<type name="Context" c:type="AsContext*"/>
</return-value>
<parameters>
<instance-parameter name="screenshot" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="538">an #AsScreenshot instance.</doc>
<type name="Screenshot" c:type="AsScreenshot*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_environment"
c:identifier="as_screenshot_get_environment">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="193">Get the GUI environment ID of this screenshot, if any
is associated with it. E.g. "plasma-mobile" or "gnome:dark".</doc>
<source-position filename="src/as-screenshot.h" line="92"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="200">The GUI environment ID the screenshot was recorded in, or %NULL if none set.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="screenshot" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="195">a #AsScreenshot instance.</doc>
<type name="Screenshot" c:type="AsScreenshot*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_image"
c:identifier="as_screenshot_get_image"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="266">Gets the AsImage closest to the target size. The #AsImage may not actually
be the requested size, and the application may have to pad / rescale the
image to make it fit.
Only images for the current active locale (or fallback, if images are not localized)
are considered.</doc>
<source-position filename="src/as-screenshot.h" line="107"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="279">an #AsImage, or %NULL</doc>
<type name="Image" c:type="AsImage*"/>
</return-value>
<parameters>
<instance-parameter name="screenshot" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="268">a #AsScreenshot instance.</doc>
<type name="Screenshot" c:type="AsScreenshot*"/>
</instance-parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="269">target width</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="270">target height</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="scale" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="271">the target scaling factor.</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="get_images" c:identifier="as_screenshot_get_images">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="248">Gets the images for this screenshots. Only images valid for the current
language are returned. We return all sizes.</doc>
<source-position filename="src/as-screenshot.h" line="106"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="255">an array</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="Image"/>
</array>
</return-value>
<parameters>
<instance-parameter name="screenshot" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="250">a #AsScreenshot instance.</doc>
<type name="Screenshot" c:type="AsScreenshot*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_images_all"
c:identifier="as_screenshot_get_images_all"
version="0.10">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="518">Returns an array of all images we have, regardless of their
size and language.</doc>
<source-position filename="src/as-screenshot.h" line="105"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="525">an array</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="Image"/>
</array>
</return-value>
<parameters>
<instance-parameter name="screenshot" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="520">an #AsScreenshot instance.</doc>
<type name="Screenshot" c:type="AsScreenshot*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_kind" c:identifier="as_screenshot_get_kind">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="149">Gets the screenshot kind.</doc>
<source-position filename="src/as-screenshot.h" line="89"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="155">a #AsScreenshotKind</doc>
<type name="ScreenshotKind" c:type="AsScreenshotKind"/>
</return-value>
<parameters>
<instance-parameter name="screenshot" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="151">a #AsScreenshot instance.</doc>
<type name="Screenshot" c:type="AsScreenshot*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_media_kind"
c:identifier="as_screenshot_get_media_kind">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="178">Gets the screenshot media kind.</doc>
<source-position filename="src/as-screenshot.h" line="98"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="184">a #AsScreenshotMediaKind</doc>
<type name="ScreenshotMediaKind" c:type="AsScreenshotMediaKind"/>
</return-value>
<parameters>
<instance-parameter name="screenshot" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="180">a #AsScreenshot instance.</doc>
<type name="Screenshot" c:type="AsScreenshot*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_videos" c:identifier="as_screenshot_get_videos">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="373">Gets the videos for this screenshots. Only videos valid for the current
language selection are returned. We return all sizes.</doc>
<source-position filename="src/as-screenshot.h" line="112"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="380">an array</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="Video"/>
</array>
</return-value>
<parameters>
<instance-parameter name="screenshot" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="375">a #AsScreenshot instance.</doc>
<type name="Screenshot" c:type="AsScreenshot*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_videos_all"
c:identifier="as_screenshot_get_videos_all">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="357">Returns an array of all screencast videos we have, regardless of their
size and locale.</doc>
<source-position filename="src/as-screenshot.h" line="111"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="364">an array</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="Video"/>
</array>
</return-value>
<parameters>
<instance-parameter name="screenshot" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="359">a #AsScreenshot instance.</doc>
<type name="Screenshot" c:type="AsScreenshot*"/>
</instance-parameter>
</parameters>
</method>
<method name="is_valid" c:identifier="as_screenshot_is_valid">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="441">Performs a quick validation on this screenshot</doc>
<source-position filename="src/as-screenshot.h" line="85"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="447">TRUE if the screenshot is a complete #AsScreenshot</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="screenshot" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="443">a #AsScreenshot instance.</doc>
<type name="Screenshot" c:type="AsScreenshot*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_caption" c:identifier="as_screenshot_set_caption">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="427">Sets a caption on the screenshot</doc>
<source-position filename="src/as-screenshot.h" line="101"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="screenshot" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="429">a #AsScreenshot instance.</doc>
<type name="Screenshot" c:type="AsScreenshot*"/>
</instance-parameter>
<parameter name="caption" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="430">the caption text.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="locale" transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_context"
c:identifier="as_screenshot_set_context"
version="0.11.2">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="554">Sets the document context this screenshot is associated
with.</doc>
<source-position filename="src/as-screenshot.h" line="96"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="screenshot" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="556">an #AsScreenshot instance.</doc>
<type name="Screenshot" c:type="AsScreenshot*"/>
</instance-parameter>
<parameter name="context" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="557">the #AsContext.</doc>
<type name="Context" c:type="AsContext*"/>
</parameter>
</parameters>
</method>
<method name="set_environment"
c:identifier="as_screenshot_set_environment">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="209">Sets the GUI environment ID of this screenshot.</doc>
<source-position filename="src/as-screenshot.h" line="93"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="screenshot" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="211">a #AsScreenshot instance.</doc>
<type name="Screenshot" c:type="AsScreenshot*"/>
</instance-parameter>
<parameter name="env_id"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="212">the GUI environment ID, e.g. "plasma-mobile" or "gnome:dark"</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_kind" c:identifier="as_screenshot_set_kind">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="164">Sets the screenshot kind.</doc>
<source-position filename="src/as-screenshot.h" line="90"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="screenshot" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="166">a #AsScreenshot instance.</doc>
<type name="Screenshot" c:type="AsScreenshot*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="167">the #AsScreenshotKind.</doc>
<type name="ScreenshotKind" c:type="AsScreenshotKind"/>
</parameter>
</parameters>
</method>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<record name="ScreenshotClass"
c:type="AsScreenshotClass"
glib:is-gtype-struct-for="Screenshot">
<source-position filename="src/as-screenshot.h" line="49"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_as_reserved1" introspectable="0">
<callback name="_as_reserved1">
<source-position filename="src/as-screenshot.h" line="43"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved2" introspectable="0">
<callback name="_as_reserved2">
<source-position filename="src/as-screenshot.h" line="44"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved3" introspectable="0">
<callback name="_as_reserved3">
<source-position filename="src/as-screenshot.h" line="45"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved4" introspectable="0">
<callback name="_as_reserved4">
<source-position filename="src/as-screenshot.h" line="46"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved5" introspectable="0">
<callback name="_as_reserved5">
<source-position filename="src/as-screenshot.h" line="47"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved6" introspectable="0">
<callback name="_as_reserved6">
<source-position filename="src/as-screenshot.h" line="48"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
</record>
<enumeration name="ScreenshotKind"
glib:type-name="AsScreenshotKind"
glib:get-type="as_screenshot_kind_get_type"
c:type="AsScreenshotKind">
<doc xml:space="preserve"
filename="src/as-screenshot.h"
line="51">The screenshot type.</doc>
<member name="unknown"
value="0"
c:identifier="AS_SCREENSHOT_KIND_UNKNOWN"
glib:nick="unknown"
glib:name="AS_SCREENSHOT_KIND_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-screenshot.h"
line="53">Type invalid or not known</doc>
</member>
<member name="default"
value="1"
c:identifier="AS_SCREENSHOT_KIND_DEFAULT"
glib:nick="default"
glib:name="AS_SCREENSHOT_KIND_DEFAULT">
<doc xml:space="preserve"
filename="src/as-screenshot.h"
line="54">The primary screenshot to show by default</doc>
</member>
<member name="extra"
value="2"
c:identifier="AS_SCREENSHOT_KIND_EXTRA"
glib:nick="extra"
glib:name="AS_SCREENSHOT_KIND_EXTRA">
<doc xml:space="preserve"
filename="src/as-screenshot.h"
line="55">Optional screenshot</doc>
</member>
<function name="from_string"
c:identifier="as_screenshot_kind_from_string">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="111">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-screenshot.h" line="83"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="117">a %AsScreenshotKind, or %AS_SCREENSHOT_KIND_UNKNOWN if not known.</doc>
<type name="ScreenshotKind" c:type="AsScreenshotKind"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="113">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="to_string" c:identifier="as_screenshot_kind_to_string">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="131">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-screenshot.h" line="84"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="137">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="133">the #AsScreenshotKind.</doc>
<type name="ScreenshotKind" c:type="AsScreenshotKind"/>
</parameter>
</parameters>
</function>
</enumeration>
<enumeration name="ScreenshotMediaKind"
glib:type-name="AsScreenshotMediaKind"
glib:get-type="as_screenshot_media_kind_get_type"
c:type="AsScreenshotMediaKind">
<doc xml:space="preserve"
filename="src/as-screenshot.h"
line="67">The media kind contained in this screenshot.</doc>
<member name="unknown"
value="0"
c:identifier="AS_SCREENSHOT_MEDIA_KIND_UNKNOWN"
glib:nick="unknown"
glib:name="AS_SCREENSHOT_MEDIA_KIND_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-screenshot.h"
line="69">Media kind is unknown</doc>
</member>
<member name="image"
value="1"
c:identifier="AS_SCREENSHOT_MEDIA_KIND_IMAGE"
glib:nick="image"
glib:name="AS_SCREENSHOT_MEDIA_KIND_IMAGE">
<doc xml:space="preserve"
filename="src/as-screenshot.h"
line="70">The screenshot contains images</doc>
</member>
<member name="video"
value="2"
c:identifier="AS_SCREENSHOT_MEDIA_KIND_VIDEO"
glib:nick="video"
glib:name="AS_SCREENSHOT_MEDIA_KIND_VIDEO">
<doc xml:space="preserve"
filename="src/as-screenshot.h"
line="71">The screenshot contains videos</doc>
</member>
</enumeration>
<enumeration name="SizeKind"
version="0.8.6"
glib:type-name="AsSizeKind"
glib:get-type="as_size_kind_get_type"
c:type="AsSizeKind">
<doc xml:space="preserve"
filename="src/as-artifact.h"
line="48">The artifact size kind.</doc>
<member name="unknown"
value="0"
c:identifier="AS_SIZE_KIND_UNKNOWN"
glib:nick="unknown"
glib:name="AS_SIZE_KIND_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-artifact.h"
line="50">Unknown size</doc>
</member>
<member name="download"
value="1"
c:identifier="AS_SIZE_KIND_DOWNLOAD"
glib:nick="download"
glib:name="AS_SIZE_KIND_DOWNLOAD">
<doc xml:space="preserve"
filename="src/as-artifact.h"
line="51">Size of download of component</doc>
</member>
<member name="installed"
value="2"
c:identifier="AS_SIZE_KIND_INSTALLED"
glib:nick="installed"
glib:name="AS_SIZE_KIND_INSTALLED">
<doc xml:space="preserve"
filename="src/as-artifact.h"
line="52">Size of installed component</doc>
</member>
<function name="from_string" c:identifier="as_size_kind_from_string">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="70">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-artifact.h" line="67"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="76">an #AsSizeKind or %AS_SIZE_KIND_UNKNOWN for unknown</doc>
<type name="SizeKind" c:type="AsSizeKind"/>
</return-value>
<parameters>
<parameter name="size_kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="72">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="to_string" c:identifier="as_size_kind_to_string">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="52">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-artifact.h" line="66"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="58">string version of @size_kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="size_kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="54">the #AsSizeKind.</doc>
<type name="SizeKind" c:type="AsSizeKind"/>
</parameter>
</parameters>
</function>
</enumeration>
<class name="Suggested"
c:symbol-prefix="suggested"
c:type="AsSuggested"
parent="GObject.Object"
glib:type-name="AsSuggested"
glib:get-type="as_suggested_get_type"
glib:type-struct="SuggestedClass">
<source-position filename="src/as-suggested.h" line="45"/>
<constructor name="new" c:identifier="as_suggested_new">
<doc xml:space="preserve"
filename="src/as-suggested.c"
line="320">Creates a new #AsSuggested.</doc>
<source-position filename="src/as-suggested.h" line="66"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-suggested.c"
line="325">a new #AsSuggested</doc>
<type name="Suggested" c:type="AsSuggested*"/>
</return-value>
</constructor>
<method name="add_id" c:identifier="as_suggested_add_id">
<doc xml:space="preserve"
filename="src/as-suggested.c"
line="156">Add a component id to this suggested object.</doc>
<source-position filename="src/as-suggested.h" line="72"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="suggested" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-suggested.c"
line="158">a #AsSuggested instance.</doc>
<type name="Suggested" c:type="AsSuggested*"/>
</instance-parameter>
<parameter name="cid" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-suggested.c"
line="159">The component id to add</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="get_ids" c:identifier="as_suggested_get_ids">
<doc xml:space="preserve"
filename="src/as-suggested.c"
line="141">Get a list of components id that generated the suggestion</doc>
<source-position filename="src/as-suggested.h" line="71"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-suggested.c"
line="147">an array of components id</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="utf8"/>
</array>
</return-value>
<parameters>
<instance-parameter name="suggested" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-suggested.c"
line="143">a #AsSuggested instance.</doc>
<type name="Suggested" c:type="AsSuggested*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_kind" c:identifier="as_suggested_get_kind">
<doc xml:space="preserve"
filename="src/as-suggested.c"
line="112">Gets the suggested kind.</doc>
<source-position filename="src/as-suggested.h" line="68"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-suggested.c"
line="118">the #AsSuggestedKind</doc>
<type name="SuggestedKind" c:type="AsSuggestedKind"/>
</return-value>
<parameters>
<instance-parameter name="suggested" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-suggested.c"
line="114">a #AsSuggested instance.</doc>
<type name="Suggested" c:type="AsSuggested*"/>
</instance-parameter>
</parameters>
</method>
<method name="is_valid" c:identifier="as_suggested_is_valid">
<doc xml:space="preserve"
filename="src/as-suggested.c"
line="170">Check if the essential properties of this suggestion are
populated with useful data.</doc>
<source-position filename="src/as-suggested.h" line="74"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-suggested.c"
line="177">%TRUE if we have useful data.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="suggested" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-suggested.c"
line="172">a #AsSuggested instance.</doc>
<type name="Suggested" c:type="AsSuggested*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_kind" c:identifier="as_suggested_set_kind">
<doc xml:space="preserve"
filename="src/as-suggested.c"
line="127">Sets the suggested kind.</doc>
<source-position filename="src/as-suggested.h" line="69"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="suggested" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-suggested.c"
line="129">a #AsSuggested instance.</doc>
<type name="Suggested" c:type="AsSuggested*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-suggested.c"
line="130">the #AsSuggestedKind, e.g. %AS_SUGGESTED_KIND_HEURISTIC.</doc>
<type name="SuggestedKind" c:type="AsSuggestedKind"/>
</parameter>
</parameters>
</method>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<record name="SuggestedClass"
c:type="AsSuggestedClass"
glib:is-gtype-struct-for="Suggested">
<source-position filename="src/as-suggested.h" line="45"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_as_reserved1" introspectable="0">
<callback name="_as_reserved1">
<source-position filename="src/as-suggested.h" line="39"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved2" introspectable="0">
<callback name="_as_reserved2">
<source-position filename="src/as-suggested.h" line="40"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved3" introspectable="0">
<callback name="_as_reserved3">
<source-position filename="src/as-suggested.h" line="41"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved4" introspectable="0">
<callback name="_as_reserved4">
<source-position filename="src/as-suggested.h" line="42"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved5" introspectable="0">
<callback name="_as_reserved5">
<source-position filename="src/as-suggested.h" line="43"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved6" introspectable="0">
<callback name="_as_reserved6">
<source-position filename="src/as-suggested.h" line="44"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
</record>
<enumeration name="SuggestedKind"
glib:type-name="AsSuggestedKind"
glib:get-type="as_suggested_kind_get_type"
c:type="AsSuggestedKind">
<doc xml:space="preserve"
filename="src/as-suggested.h"
line="47">The suggested type.</doc>
<member name="unknown"
value="0"
c:identifier="AS_SUGGESTED_KIND_UNKNOWN"
glib:nick="unknown"
glib:name="AS_SUGGESTED_KIND_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-suggested.h"
line="49">Unknown suggested kind</doc>
</member>
<member name="upstream"
value="1"
c:identifier="AS_SUGGESTED_KIND_UPSTREAM"
glib:nick="upstream"
glib:name="AS_SUGGESTED_KIND_UPSTREAM">
<doc xml:space="preserve"
filename="src/as-suggested.h"
line="50">Suggestions provided by the upstream project.</doc>
</member>
<member name="heuristic"
value="2"
c:identifier="AS_SUGGESTED_KIND_HEURISTIC"
glib:nick="heuristic"
glib:name="AS_SUGGESTED_KIND_HEURISTIC">
<doc xml:space="preserve"
filename="src/as-suggested.h"
line="51">Suggestions provided by automatic heuristics.</doc>
</member>
<function name="from_string"
c:identifier="as_suggested_kind_from_string">
<doc xml:space="preserve"
filename="src/as-suggested.c"
line="64">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-suggested.h" line="63"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-suggested.c"
line="70">a #AsSuggestedKind or %AS_SUGGESTED_KIND_UNKNOWN for unknown</doc>
<type name="SuggestedKind" c:type="AsSuggestedKind"/>
</return-value>
<parameters>
<parameter name="kind_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-suggested.c"
line="66">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="to_string" c:identifier="as_suggested_kind_to_string">
<doc xml:space="preserve"
filename="src/as-suggested.c"
line="45">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-suggested.h" line="64"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-suggested.c"
line="51">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-suggested.c"
line="47">the %AsSuggestedKind.</doc>
<type name="SuggestedKind" c:type="AsSuggestedKind"/>
</parameter>
</parameters>
</function>
</enumeration>
<class name="SystemInfo"
c:symbol-prefix="system_info"
c:type="AsSystemInfo"
parent="GObject.Object"
glib:type-name="AsSystemInfo"
glib:get-type="as_system_info_get_type"
glib:type-struct="SystemInfoClass">
<source-position filename="src/as-system-info.h" line="46"/>
<constructor name="new" c:identifier="as_system_info_new" version="0.10">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="1129">Creates a new #AsSystemInfo.</doc>
<source-position filename="src/as-system-info.h" line="109"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="1134">a #AsSystemInfo</doc>
<type name="SystemInfo" c:type="AsSystemInfo*"/>
</return-value>
</constructor>
<constructor name="new_template_for_chassis"
c:identifier="as_system_info_new_template_for_chassis"
version="1.0.0"
throws="1">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="1146">Creates a new #AsSystemInfo that can be used as a mock system
for the given chassis type, reading (mostly) no information
from the current system.
This function will try to generate a device most representative of
the given chassis class. This can be useful when testing compatibility
for other devices on a different device that is not of the same chassis
type as the one to be tested.</doc>
<source-position filename="src/as-system-info.h" line="110"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="1160">an #AsSystemInfo template</doc>
<type name="SystemInfo" c:type="AsSystemInfo*"/>
</return-value>
<parameters>
<parameter name="chassis" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="1148">the #AsChassisKind to generate a template for</doc>
<type name="ChassisKind" c:type="AsChassisKind"/>
</parameter>
</parameters>
</constructor>
<method name="get_device_name_for_modalias"
c:identifier="as_system_info_get_device_name_for_modalias"
throws="1">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="833">Return a human readable device name for the given modalias.
Will return the modalias again if no device name could be found,
and returns %NULL on error.
If @allow_fallback is set to %FALSE, this function will return %NULL and error
%AS_SYSTEM_INFO_ERROR_NOT_FOUND in case no suitable description could be found.</doc>
<source-position filename="src/as-system-info.h" line="128"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="846">a human-readable device name, or %NULL on error.</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<instance-parameter name="sysinfo" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="835">a #AsSystemInfo instance.</doc>
<type name="SystemInfo" c:type="AsSystemInfo*"/>
</instance-parameter>
<parameter name="modalias" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="836">the modalias value to resolve (may contain wildcards).</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="allow_fallback" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="837">fall back to low-quality data if no better information is available</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="get_display_length"
c:identifier="as_system_info_get_display_length">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="1084">Get the current display length for the given side kind.
If the display size is unknown, this function will return 0.</doc>
<source-position filename="src/as-system-info.h" line="141"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="1092">the display size in logical pixels.</doc>
<type name="gulong" c:type="gulong"/>
</return-value>
<parameters>
<instance-parameter name="sysinfo" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="1086">a #AsSystemInfo instance.</doc>
<type name="SystemInfo" c:type="AsSystemInfo*"/>
</instance-parameter>
<parameter name="side" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="1087">the #AsDisplaySideKind to select.</doc>
<type name="DisplaySideKind" c:type="AsDisplaySideKind"/>
</parameter>
</parameters>
</method>
<method name="get_gui_available"
c:identifier="as_system_info_get_gui_available">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="1055">Check whether graphical applications can be displayed via X11 or Wayland.</doc>
<source-position filename="src/as-system-info.h" line="138"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="1061">%TRUE if graphical applications can be displayed.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="sysinfo" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="1057">a #AsSystemInfo instance.</doc>
<type name="SystemInfo" c:type="AsSystemInfo*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_kernel_name"
c:identifier="as_system_info_get_kernel_name">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="417">Get the name of the current kernel, e.g. "Linux"</doc>
<source-position filename="src/as-system-info.h" line="118"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="423">the current OS kernel name</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="sysinfo" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="419">a #AsSystemInfo instance.</doc>
<type name="SystemInfo" c:type="AsSystemInfo*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_kernel_version"
c:identifier="as_system_info_get_kernel_version">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="433">Get the version of the current kernel, e.g. "6.2.0-2"</doc>
<source-position filename="src/as-system-info.h" line="119"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="439">the current kernel version</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="sysinfo" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="435">a #AsSystemInfo instance.</doc>
<type name="SystemInfo" c:type="AsSystemInfo*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_memory_total"
c:identifier="as_system_info_get_memory_total">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="527">Get the current total amount of physical memory in MiB.</doc>
<source-position filename="src/as-system-info.h" line="121"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="533">the current total amount of usable memory in MiB</doc>
<type name="gulong" c:type="gulong"/>
</return-value>
<parameters>
<instance-parameter name="sysinfo" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="529">a #AsSystemInfo instance.</doc>
<type name="SystemInfo" c:type="AsSystemInfo*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_modaliases"
c:identifier="as_system_info_get_modaliases">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="643">Get a list of modaliases for all the hardware on this system that has them.</doc>
<source-position filename="src/as-system-info.h" line="123"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="649">a list of modaliases on the system.</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="utf8"/>
</array>
</return-value>
<parameters>
<instance-parameter name="sysinfo" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="645">a #AsSystemInfo instance.</doc>
<type name="SystemInfo" c:type="AsSystemInfo*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_os_cid" c:identifier="as_system_info_get_os_cid">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="310">Get the AppStream component ID of the current operating system.</doc>
<source-position filename="src/as-system-info.h" line="113"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="316">the component ID of the current OS.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="sysinfo" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="312">a #AsSystemInfo instance.</doc>
<type name="SystemInfo" c:type="AsSystemInfo*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_os_homepage"
c:identifier="as_system_info_get_os_homepage">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="369">Get the homepage URL of the current operating system.</doc>
<source-position filename="src/as-system-info.h" line="116"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="375">the homepage of the current OS.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="sysinfo" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="371">a #AsSystemInfo instance.</doc>
<type name="SystemInfo" c:type="AsSystemInfo*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_os_id" c:identifier="as_system_info_get_os_id">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="294">Get the ID of the current operating system.</doc>
<source-position filename="src/as-system-info.h" line="112"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="300">the current OS ID.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="sysinfo" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="296">a #AsSystemInfo instance.</doc>
<type name="SystemInfo" c:type="AsSystemInfo*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_os_name" c:identifier="as_system_info_get_os_name">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="337">Get the humen-readable name of the current operating system.</doc>
<source-position filename="src/as-system-info.h" line="114"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="343">the name of the current OS.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="sysinfo" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="339">a #AsSystemInfo instance.</doc>
<type name="SystemInfo" c:type="AsSystemInfo*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_os_version"
c:identifier="as_system_info_get_os_version">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="353">Get the version string of the current operating system.</doc>
<source-position filename="src/as-system-info.h" line="115"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="359">the version of the current OS.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="sysinfo" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="355">a #AsSystemInfo instance.</doc>
<type name="SystemInfo" c:type="AsSystemInfo*"/>
</instance-parameter>
</parameters>
</method>
<method name="has_device_matching_modalias"
c:identifier="as_system_info_has_device_matching_modalias">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="676">Check if there is a device on this system that matches the given modalias glob.</doc>
<source-position filename="src/as-system-info.h" line="125"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="683">%TRUE if a matching device was found.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="sysinfo" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="678">a #AsSystemInfo instance.</doc>
<type name="SystemInfo" c:type="AsSystemInfo*"/>
</instance-parameter>
<parameter name="modalias_glob" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="679">the modalias value to to look for, may contain wildcards.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="has_input_control"
c:identifier="as_system_info_has_input_control"
throws="1">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="1006">Test if the current system has a specific user input control method.
Returns %AS_CHECK_RESULT_UNKNOWN if we could not test for an input control method,
%AS_CHECK_RESULT_ERROR on error and %AS_CHECK_RESULT_FALSE if the control was not found.</doc>
<source-position filename="src/as-system-info.h" line="133"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="1016">%AS_CHECK_RESULT_TRUE if control was found</doc>
<type name="CheckResult" c:type="AsCheckResult"/>
</return-value>
<parameters>
<instance-parameter name="sysinfo" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="1008">a #AsSystemInfo instance.</doc>
<type name="SystemInfo" c:type="AsSystemInfo*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="1009">the #AsControlKind to test for.</doc>
<type name="ControlKind" c:type="AsControlKind"/>
</parameter>
</parameters>
</method>
<method name="modalias_to_syspath"
c:identifier="as_system_info_modalias_to_syspath">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="659">Receive a path in /sys for the devices with the given modalias.</doc>
<source-position filename="src/as-system-info.h" line="124"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="666">the syspath, or %NULL if none was found.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="sysinfo" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="661">a #AsSystemInfo instance.</doc>
<type name="SystemInfo" c:type="AsSystemInfo*"/>
</instance-parameter>
<parameter name="modalias" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="662">the modalias value to resolve.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_display_length"
c:identifier="as_system_info_set_display_length">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="1106">Set the current display length for the given side kind.
The size needs to be in device-independent pixels, see the
AppStream documentation for more information:
https://www.freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-relations-display_length</doc>
<source-position filename="src/as-system-info.h" line="142"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="sysinfo" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="1108">a #AsSystemInfo instance.</doc>
<type name="SystemInfo" c:type="AsSystemInfo*"/>
</instance-parameter>
<parameter name="side" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="1109">the #AsDisplaySideKind to select.</doc>
<type name="DisplaySideKind" c:type="AsDisplaySideKind"/>
</parameter>
<parameter name="value_dip" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="1110">the length value in device-independt pixels.</doc>
<type name="gulong" c:type="gulong"/>
</parameter>
</parameters>
</method>
<method name="set_gui_available"
c:identifier="as_system_info_set_gui_available">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="1070">Set whether this system has a GUI / desktop environment available.</doc>
<source-position filename="src/as-system-info.h" line="139"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="sysinfo" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="1072">a #AsSystemInfo instance.</doc>
<type name="SystemInfo" c:type="AsSystemInfo*"/>
</instance-parameter>
<parameter name="available" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="1073">%TRUE if GUI is available.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_input_control"
c:identifier="as_system_info_set_input_control">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="1038">Explicitly mark a user input control as present or not present on this system.</doc>
<source-position filename="src/as-system-info.h" line="136"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="sysinfo" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="1040">a #AsSystemInfo instance.</doc>
<type name="SystemInfo" c:type="AsSystemInfo*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="1041">the #AsControlKind to set.</doc>
<type name="ControlKind" c:type="AsControlKind"/>
</parameter>
<parameter name="found" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="1042">%TRUE if the control should be marked as found.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<record name="SystemInfoClass"
c:type="AsSystemInfoClass"
glib:is-gtype-struct-for="SystemInfo">
<source-position filename="src/as-system-info.h" line="46"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_as_reserved1" introspectable="0">
<callback name="_as_reserved1">
<source-position filename="src/as-system-info.h" line="40"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved2" introspectable="0">
<callback name="_as_reserved2">
<source-position filename="src/as-system-info.h" line="41"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved3" introspectable="0">
<callback name="_as_reserved3">
<source-position filename="src/as-system-info.h" line="42"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved4" introspectable="0">
<callback name="_as_reserved4">
<source-position filename="src/as-system-info.h" line="43"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved5" introspectable="0">
<callback name="_as_reserved5">
<source-position filename="src/as-system-info.h" line="44"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved6" introspectable="0">
<callback name="_as_reserved6">
<source-position filename="src/as-system-info.h" line="45"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
</record>
<enumeration name="SystemInfoError"
glib:type-name="AsSystemInfoError"
glib:get-type="as_system_info_error_get_type"
c:type="AsSystemInfoError"
glib:error-domain="as-system-info-error-quark">
<doc xml:space="preserve"
filename="src/as-system-info.h"
line="91">The error type.</doc>
<member name="failed"
value="0"
c:identifier="AS_SYSTEM_INFO_ERROR_FAILED"
glib:nick="failed"
glib:name="AS_SYSTEM_INFO_ERROR_FAILED">
<doc xml:space="preserve"
filename="src/as-system-info.h"
line="93">Generic failure</doc>
</member>
<member name="not_found"
value="1"
c:identifier="AS_SYSTEM_INFO_ERROR_NOT_FOUND"
glib:nick="not-found"
glib:name="AS_SYSTEM_INFO_ERROR_NOT_FOUND">
<doc xml:space="preserve"
filename="src/as-system-info.h"
line="94">Information was not found.</doc>
</member>
<function name="quark"
c:identifier="as_system_info_error_quark"
version="0.16.0">
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="105">An error quark.</doc>
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
</enumeration>
<class name="Translation"
c:symbol-prefix="translation"
c:type="AsTranslation"
parent="GObject.Object"
glib:type-name="AsTranslation"
glib:get-type="as_translation_get_type"
glib:type-struct="TranslationClass">
<source-position filename="src/as-translation.h" line="44"/>
<constructor name="new" c:identifier="as_translation_new">
<doc xml:space="preserve"
filename="src/as-translation.c"
line="266">Creates a new #AsTranslation.</doc>
<source-position filename="src/as-translation.h" line="65"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-translation.c"
line="271">a #AsTranslation</doc>
<type name="Translation" c:type="AsTranslation*"/>
</return-value>
</constructor>
<method name="get_id" c:identifier="as_translation_get_id">
<doc xml:space="preserve"
filename="src/as-translation.c"
line="150">The ID (e.g. Gettext translation domain) of this translation.</doc>
<source-position filename="src/as-translation.h" line="70"/>
<return-value transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="tr" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-translation.c"
line="152">a #AsTranslation instance.</doc>
<type name="Translation" c:type="AsTranslation*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_kind" c:identifier="as_translation_get_kind">
<doc xml:space="preserve"
filename="src/as-translation.c"
line="121">The translation system type.</doc>
<source-position filename="src/as-translation.h" line="67"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-translation.c"
line="127">an enum of type #AsTranslationKind</doc>
<type name="TranslationKind" c:type="AsTranslationKind"/>
</return-value>
<parameters>
<instance-parameter name="tr" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-translation.c"
line="123">a #AsTranslation instance.</doc>
<type name="Translation" c:type="AsTranslation*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_source_locale"
c:identifier="as_translation_get_source_locale"
version="0.14.6">
<doc xml:space="preserve"
filename="src/as-translation.c"
line="177">The locale of the source strings for this component. If this has not been
explicitly specified, `en_US` will be returned.</doc>
<source-position filename="src/as-translation.h" line="73"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-translation.c"
line="184">The locale of the source strings for this component.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="tr" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-translation.c"
line="179">a #AsTranslation instance.</doc>
<type name="Translation" c:type="AsTranslation*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_id" c:identifier="as_translation_set_id">
<doc xml:space="preserve"
filename="src/as-translation.c"
line="163">Set the ID (e.g. Gettext domain) of this translation.</doc>
<source-position filename="src/as-translation.h" line="71"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="tr" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-translation.c"
line="165">a #AsTranslation instance.</doc>
<type name="Translation" c:type="AsTranslation*"/>
</instance-parameter>
<parameter name="id" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-translation.c"
line="166">The ID of this translation.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_kind" c:identifier="as_translation_set_kind">
<doc xml:space="preserve"
filename="src/as-translation.c"
line="136">Set the translation system type.</doc>
<source-position filename="src/as-translation.h" line="68"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="tr" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-translation.c"
line="138">a #AsTranslation instance.</doc>
<type name="Translation" c:type="AsTranslation*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-translation.c"
line="139">the new #AsTranslationKind</doc>
<type name="TranslationKind" c:type="AsTranslationKind"/>
</parameter>
</parameters>
</method>
<method name="set_source_locale"
c:identifier="as_translation_set_source_locale"
version="0.14.6">
<doc xml:space="preserve"
filename="src/as-translation.c"
line="194">Set the locale of the source strings for this component. In gettext, this is
referred to as the `C` locale. It’s almost always `en_US`, but for some
components it may not be.</doc>
<source-position filename="src/as-translation.h" line="74"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="tr" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-translation.c"
line="196">a #AsTranslation instance.</doc>
<type name="Translation" c:type="AsTranslation*"/>
</instance-parameter>
<parameter name="locale"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="src/as-translation.c"
line="197">The POSIX locale that the source strings are in, or %NULL if unknown or default.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<record name="TranslationClass"
c:type="AsTranslationClass"
glib:is-gtype-struct-for="Translation">
<source-position filename="src/as-translation.h" line="44"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_as_reserved1" introspectable="0">
<callback name="_as_reserved1">
<source-position filename="src/as-translation.h" line="38"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved2" introspectable="0">
<callback name="_as_reserved2">
<source-position filename="src/as-translation.h" line="39"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved3" introspectable="0">
<callback name="_as_reserved3">
<source-position filename="src/as-translation.h" line="40"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved4" introspectable="0">
<callback name="_as_reserved4">
<source-position filename="src/as-translation.h" line="41"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved5" introspectable="0">
<callback name="_as_reserved5">
<source-position filename="src/as-translation.h" line="42"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved6" introspectable="0">
<callback name="_as_reserved6">
<source-position filename="src/as-translation.h" line="43"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
</record>
<enumeration name="TranslationKind"
glib:type-name="AsTranslationKind"
glib:get-type="as_translation_kind_get_type"
c:type="AsTranslationKind">
<doc xml:space="preserve"
filename="src/as-translation.h"
line="46">The translation type.</doc>
<member name="unknown"
value="0"
c:identifier="AS_TRANSLATION_KIND_UNKNOWN"
glib:nick="unknown"
glib:name="AS_TRANSLATION_KIND_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-translation.h"
line="48">Type invalid or not known</doc>
</member>
<member name="gettext"
value="1"
c:identifier="AS_TRANSLATION_KIND_GETTEXT"
glib:nick="gettext"
glib:name="AS_TRANSLATION_KIND_GETTEXT">
<doc xml:space="preserve"
filename="src/as-translation.h"
line="49">Gettext translation domain</doc>
</member>
<member name="qt"
value="2"
c:identifier="AS_TRANSLATION_KIND_QT"
glib:nick="qt"
glib:name="AS_TRANSLATION_KIND_QT">
<doc xml:space="preserve"
filename="src/as-translation.h"
line="50">Qt translation domain</doc>
</member>
<function name="from_string"
c:identifier="as_translation_kind_from_string">
<doc xml:space="preserve"
filename="src/as-translation.c"
line="68">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-translation.h" line="63"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-translation.c"
line="74">a #AsTranslationKind or %AS_TRANSLATION_KIND_UNKNOWN for unknown</doc>
<type name="TranslationKind" c:type="AsTranslationKind"/>
</return-value>
<parameters>
<parameter name="kind_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-translation.c"
line="70">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="to_string" c:identifier="as_translation_kind_to_string">
<doc xml:space="preserve"
filename="src/as-translation.c"
line="50">Converts the enumerated value to a text representation.</doc>
<source-position filename="src/as-translation.h" line="62"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-translation.c"
line="56">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-translation.c"
line="52">the #AsTranslationKind.</doc>
<type name="TranslationKind" c:type="AsTranslationKind"/>
</parameter>
</parameters>
</function>
</enumeration>
<enumeration name="UrgencyKind"
glib:type-name="AsUrgencyKind"
glib:get-type="as_urgency_kind_get_type"
c:type="AsUrgencyKind">
<doc xml:space="preserve"
filename="src/as-release.h"
line="72">The urgency of an #AsRelease</doc>
<member name="unknown"
value="0"
c:identifier="AS_URGENCY_KIND_UNKNOWN"
glib:nick="unknown"
glib:name="AS_URGENCY_KIND_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-release.h"
line="74">Urgency is unknown or not set</doc>
</member>
<member name="low"
value="1"
c:identifier="AS_URGENCY_KIND_LOW"
glib:nick="low"
glib:name="AS_URGENCY_KIND_LOW">
<doc xml:space="preserve"
filename="src/as-release.h"
line="75">Low urgency</doc>
</member>
<member name="medium"
value="2"
c:identifier="AS_URGENCY_KIND_MEDIUM"
glib:nick="medium"
glib:name="AS_URGENCY_KIND_MEDIUM">
<doc xml:space="preserve"
filename="src/as-release.h"
line="76">Medium urgency</doc>
</member>
<member name="high"
value="3"
c:identifier="AS_URGENCY_KIND_HIGH"
glib:nick="high"
glib:name="AS_URGENCY_KIND_HIGH">
<doc xml:space="preserve"
filename="src/as-release.h"
line="77">High urgency</doc>
</member>
<member name="critical"
value="4"
c:identifier="AS_URGENCY_KIND_CRITICAL"
glib:nick="critical"
glib:name="AS_URGENCY_KIND_CRITICAL">
<doc xml:space="preserve"
filename="src/as-release.h"
line="78">Critical urgency</doc>
</member>
<function name="from_string"
c:identifier="as_urgency_kind_from_string"
version="0.6.5">
<doc xml:space="preserve"
filename="src/as-release.c"
line="138">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-release.h" line="93"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="144">a %AsUrgencyKind or %AS_URGENCY_KIND_UNKNOWN for unknown</doc>
<type name="UrgencyKind" c:type="AsUrgencyKind"/>
</return-value>
<parameters>
<parameter name="urgency_kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="140">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="to_string"
c:identifier="as_urgency_kind_to_string"
version="0.6.5">
<doc xml:space="preserve"
filename="src/as-release.c"
line="114">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-release.h" line="92"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="120">string version of @urgency_kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="urgency_kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="116">the %AsUrgencyKind.</doc>
<type name="UrgencyKind" c:type="AsUrgencyKind"/>
</parameter>
</parameters>
</function>
</enumeration>
<enumeration name="UrlKind"
glib:type-name="AsUrlKind"
glib:get-type="as_url_kind_get_type"
c:type="AsUrlKind">
<doc xml:space="preserve"
filename="src/as-component.h"
line="156">The URL type.</doc>
<member name="unknown"
value="0"
c:identifier="AS_URL_KIND_UNKNOWN"
glib:nick="unknown"
glib:name="AS_URL_KIND_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-component.h"
line="158">Type invalid or not known</doc>
</member>
<member name="homepage"
value="1"
c:identifier="AS_URL_KIND_HOMEPAGE"
glib:nick="homepage"
glib:name="AS_URL_KIND_HOMEPAGE">
<doc xml:space="preserve"
filename="src/as-component.h"
line="159">Project homepage</doc>
</member>
<member name="bugtracker"
value="2"
c:identifier="AS_URL_KIND_BUGTRACKER"
glib:nick="bugtracker"
glib:name="AS_URL_KIND_BUGTRACKER">
<doc xml:space="preserve"
filename="src/as-component.h"
line="160">Bugtracker</doc>
</member>
<member name="faq"
value="3"
c:identifier="AS_URL_KIND_FAQ"
glib:nick="faq"
glib:name="AS_URL_KIND_FAQ">
<doc xml:space="preserve"
filename="src/as-component.h"
line="161">FAQ page</doc>
</member>
<member name="help"
value="4"
c:identifier="AS_URL_KIND_HELP"
glib:nick="help"
glib:name="AS_URL_KIND_HELP">
<doc xml:space="preserve"
filename="src/as-component.h"
line="162">Help manual</doc>
</member>
<member name="donation"
value="5"
c:identifier="AS_URL_KIND_DONATION"
glib:nick="donation"
glib:name="AS_URL_KIND_DONATION">
<doc xml:space="preserve"
filename="src/as-component.h"
line="163">Page with information about how to donate to the project</doc>
</member>
<member name="translate"
value="6"
c:identifier="AS_URL_KIND_TRANSLATE"
glib:nick="translate"
glib:name="AS_URL_KIND_TRANSLATE">
<doc xml:space="preserve"
filename="src/as-component.h"
line="164">Page with instructions on how to translate the project / submit translations.</doc>
</member>
<member name="contact"
value="7"
c:identifier="AS_URL_KIND_CONTACT"
glib:nick="contact"
glib:name="AS_URL_KIND_CONTACT">
<doc xml:space="preserve"
filename="src/as-component.h"
line="165">Contact the developers</doc>
</member>
<member name="vcs_browser"
value="8"
c:identifier="AS_URL_KIND_VCS_BROWSER"
glib:nick="vcs-browser"
glib:name="AS_URL_KIND_VCS_BROWSER">
<doc xml:space="preserve"
filename="src/as-component.h"
line="166">Browse the source code</doc>
</member>
<member name="contribute"
value="9"
c:identifier="AS_URL_KIND_CONTRIBUTE"
glib:nick="contribute"
glib:name="AS_URL_KIND_CONTRIBUTE">
<doc xml:space="preserve"
filename="src/as-component.h"
line="167">Help developing</doc>
</member>
<function name="from_string" c:identifier="as_url_kind_from_string">
<doc xml:space="preserve"
filename="src/as-component.c"
line="365">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-component.h" line="187"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="371">a #AsUrlKind or %AS_URL_KIND_UNKNOWN for unknown</doc>
<type name="UrlKind" c:type="AsUrlKind"/>
</return-value>
<parameters>
<parameter name="url_kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="367">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="to_string" c:identifier="as_url_kind_to_string">
<doc xml:space="preserve"
filename="src/as-component.c"
line="333">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-component.h" line="186"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="339">string version of @url_kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="url_kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="335">the %AsUrlKind.</doc>
<type name="UrlKind" c:type="AsUrlKind"/>
</parameter>
</parameters>
</function>
</enumeration>
<enumeration name="UtilsError"
glib:type-name="AsUtilsError"
glib:get-type="as_utils_error_get_type"
c:type="AsUtilsError"
glib:error-domain="as-utils-error-quark">
<doc xml:space="preserve"
filename="src/as-utils.h"
line="33">The error type.</doc>
<member name="failed"
value="0"
c:identifier="AS_UTILS_ERROR_FAILED"
glib:nick="failed"
glib:name="AS_UTILS_ERROR_FAILED">
<doc xml:space="preserve"
filename="src/as-utils.h"
line="35">Generic failure</doc>
</member>
<function name="quark"
c:identifier="as_utils_error_quark"
version="0.14.0">
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="64">An error quark.</doc>
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
</enumeration>
<class name="Validator"
c:symbol-prefix="validator"
c:type="AsValidator"
parent="GObject.Object"
glib:type-name="AsValidator"
glib:get-type="as_validator_get_type"
glib:type-struct="ValidatorClass">
<source-position filename="src/as-validator.h" line="45"/>
<constructor name="new" c:identifier="as_validator_new">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="4619">Creates a new #AsValidator.</doc>
<source-position filename="src/as-validator.h" line="66"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="4624">an #AsValidator</doc>
<type name="Validator" c:type="AsValidator*"/>
</return-value>
</constructor>
<method name="add_override"
c:identifier="as_validator_add_override"
version="0.15.4"
throws="1">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="617">Override the severity of a selected tag. For most tags, the severity
can not be lowered to a value that makes a validation
that would otherwise fail pass (so e.g. an ERROR can not become an INFO).
Some tags are explicitly allowed to have their severity lowered to enable
validation of e.g. incomplete metadata during development.
Increasing the severity of any tag is always allowed.</doc>
<source-position filename="src/as-validator.h" line="94"/>
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="validator" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="619">a #AsValidator instance.</doc>
<type name="Validator" c:type="AsValidator*"/>
</instance-parameter>
<parameter name="tag" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="620">the issue tag to override, e.g. "release-time-missing"</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="severity_override" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="621">the new severity for the tag.</doc>
<type name="IssueSeverity" c:type="AsIssueSeverity"/>
</parameter>
</parameters>
</method>
<method name="add_release_bytes"
c:identifier="as_validator_add_release_bytes"
version="0.16.0"
throws="1">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="455">Add release metadata explicitly from bytes.</doc>
<source-position filename="src/as-validator.h" line="74"/>
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="validator" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="457">a #AsValidator instance.</doc>
<type name="Validator" c:type="AsValidator*"/>
</instance-parameter>
<parameter name="release_fname" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="458">File basename of the release metadata file to add.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="release_metadata" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="459">Data of the release metadata file.</doc>
<type name="GLib.Bytes" c:type="GBytes*"/>
</parameter>
</parameters>
</method>
<method name="add_release_file"
c:identifier="as_validator_add_release_file"
version="0.16.0"
throws="1">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="499">Add a release metadata file to the validation process.</doc>
<source-position filename="src/as-validator.h" line="78"/>
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="validator" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="501">a #AsValidator instance.</doc>
<type name="Validator" c:type="AsValidator*"/>
</instance-parameter>
<parameter name="release_file" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="502">Release metadata file to add.</doc>
<type name="Gio.File" c:type="GFile*"/>
</parameter>
</parameters>
</method>
<method name="check_success" c:identifier="as_validator_check_success">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="325">Check the current registered values again and return %TRUE
if no issues were found that would make the previously validated
files fail validation.
Usually you do not need to call this function explicitly, as
the as_validator_validate_* functions will already return whether
data was valid as return value.</doc>
<source-position filename="src/as-validator.h" line="86"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="337">%TRUE if previously validated files were valid.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="validator" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="327">An instance of #AsValidator.</doc>
<type name="Validator" c:type="AsValidator*"/>
</instance-parameter>
</parameters>
</method>
<method name="clear_release_data"
c:identifier="as_validator_clear_release_data"
version="0.16.0">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="439">Clear all release information that was explicitly added to the
validation process.</doc>
<source-position filename="src/as-validator.h" line="73"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="validator" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="441">a #AsValidator instance.</doc>
<type name="Validator" c:type="AsValidator*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_allow_net" c:identifier="as_validator_get_allow_net">
<source-position filename="src/as-validator.h" line="88"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="557">%TRUE in case we allow network access.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="validator" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="555">a #AsValidator instance.</doc>
<type name="Validator" c:type="AsValidator*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_issue_files_count"
c:identifier="as_validator_get_issue_files_count"
version="0.16.0">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="4366">Get the number of files for which issues have been found.</doc>
<source-position filename="src/as-validator.h" line="82"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="4372">The number of files that have issues.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="validator" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="4368">An instance of #AsValidator.</doc>
<type name="Validator" c:type="AsValidator*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_issues" c:identifier="as_validator_get_issues">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="4383">Get a list of found metadata format issues.</doc>
<source-position filename="src/as-validator.h" line="83"/>
<return-value transfer-ownership="container">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="4389">a list of #AsValidatorIssue instances, free with g_list_free()</doc>
<type name="GLib.List" c:type="GList*">
<type name="ValidatorIssue"/>
</type>
</return-value>
<parameters>
<instance-parameter name="validator" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="4385">An instance of #AsValidator.</doc>
<type name="Validator" c:type="AsValidator*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_issues_per_file"
c:identifier="as_validator_get_issues_per_file"
version="0.12.8">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="4398">Get a hash table of filenames mapped to lists of issues.
This is useful if validation was requested for multiple files and
a list of issues per-file is desired without prior explicit sorting.</doc>
<source-position filename="src/as-validator.h" line="84"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="4406">a file to issue list mapping</doc>
<type name="GLib.HashTable" c:type="GHashTable*">
<type name="utf8"/>
<array name="GLib.PtrArray">
<type name="ValidatorIssue"/>
</array>
</type>
</return-value>
<parameters>
<instance-parameter name="validator" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="4400">An instance of #AsValidator.</doc>
<type name="Validator" c:type="AsValidator*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_report_yaml"
c:identifier="as_validator_get_report_yaml"
throws="1">
<source-position filename="src/as-validator.h" line="85"/>
<return-value transfer-ownership="full">
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<instance-parameter name="validator" transfer-ownership="none">
<type name="Validator" c:type="AsValidator*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_strict"
c:identifier="as_validator_get_strict"
version="0.15.4">
<source-position filename="src/as-validator.h" line="91"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="588">%TRUE in case we are in strict mode and consider any issues as fatal.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="validator" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="586">a #AsValidator instance.</doc>
<type name="Validator" c:type="AsValidator*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_tag_explanation"
c:identifier="as_validator_get_tag_explanation">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="4547">Get the explanatory text for a given issue tag.</doc>
<source-position filename="src/as-validator.h" line="99"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="4553">Explanation text.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="validator" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="4549">An instance of #AsValidator.</doc>
<type name="Validator" c:type="AsValidator*"/>
</instance-parameter>
<parameter name="tag" transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="get_tag_severity"
c:identifier="as_validator_get_tag_severity">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="4565">Get the severity for a given issue tag.</doc>
<source-position filename="src/as-validator.h" line="100"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="4571">The #AsIssueSeverity</doc>
<type name="IssueSeverity" c:type="AsIssueSeverity"/>
</return-value>
<parameters>
<instance-parameter name="validator" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="4567">An instance of #AsValidator.</doc>
<type name="Validator" c:type="AsValidator*"/>
</instance-parameter>
<parameter name="tag" transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="get_tags" c:identifier="as_validator_get_tags">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="4583">Get an array of all tags known to the validator.</doc>
<source-position filename="src/as-validator.h" line="101"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="4589">A string array of tags</doc>
<array c:type="gchar**">
<type name="utf8"/>
</array>
</return-value>
<parameters>
<instance-parameter name="validator" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="4585">An instance of #AsValidator.</doc>
<type name="Validator" c:type="AsValidator*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_allow_net" c:identifier="as_validator_set_allow_net">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="566">If set to %TRUE, the validator will be allowed to connect
to the internet to e.g. check URLs for validity.</doc>
<source-position filename="src/as-validator.h" line="89"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="validator" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="568">a #AsValidator instance.</doc>
<type name="Validator" c:type="AsValidator*"/>
</instance-parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="569">%TRUE if remote URLs should be checked for availability.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_strict"
c:identifier="as_validator_set_strict"
version="0.15.4">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="599">Enable or disable strict mode. In strict mode, any found issue will result
in a failed validation (except for issues of "pedantic" severity).
Otherwise, only a "warning" or "error" will cause the validation to fail.</doc>
<source-position filename="src/as-validator.h" line="92"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="validator" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="601">a #AsValidator instance.</doc>
<type name="Validator" c:type="AsValidator*"/>
</instance-parameter>
<parameter name="is_strict" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="602">%TRUE to enable strict mode.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="validate_bytes"
c:identifier="as_validator_validate_bytes"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="3922">Validate AppStream XML data from a byte array.
Remember to run %as_validator_clear_issues if you do not want previous
validation runs to affect the outcome of this validation.</doc>
<source-position filename="src/as-validator.h" line="69"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="3931">%TRUE if bytes validated successfully.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="validator" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="3924">An instance of #AsValidator.</doc>
<type name="Validator" c:type="AsValidator*"/>
</instance-parameter>
<parameter name="metadata" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="3925">XML metadata as #GBytes.</doc>
<type name="GLib.Bytes" c:type="GBytes*"/>
</parameter>
</parameters>
</method>
<method name="validate_data" c:identifier="as_validator_validate_data">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="4002">Validate AppStream XML data.</doc>
<source-position filename="src/as-validator.h" line="70"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="4009">%TRUE if data validated successfully.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="validator" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="4004">An instance of #AsValidator.</doc>
<type name="Validator" c:type="AsValidator*"/>
</instance-parameter>
<parameter name="metadata" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="4005">XML metadata.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="validate_file" c:identifier="as_validator_validate_file">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="3795">Validate an AppStream XML file.</doc>
<source-position filename="src/as-validator.h" line="68"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="3802">%TRUE if file validated successfully.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="validator" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="3797">An instance of #AsValidator.</doc>
<type name="Validator" c:type="AsValidator*"/>
</instance-parameter>
<parameter name="metadata_file" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="3798">An AppStream XML file.</doc>
<type name="Gio.File" c:type="GFile*"/>
</parameter>
</parameters>
</method>
<method name="validate_tree" c:identifier="as_validator_validate_tree">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="4184">Validate a full directory tree for issues in AppStream metadata.</doc>
<source-position filename="src/as-validator.h" line="71"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="4191">%TRUE if file validated successfully.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="validator" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="4186">An instance of #AsValidator.</doc>
<type name="Validator" c:type="AsValidator*"/>
</instance-parameter>
<parameter name="root_dir" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="4187">The root directory of the filesystem tree that should be validated.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<record name="ValidatorClass"
c:type="AsValidatorClass"
glib:is-gtype-struct-for="Validator">
<source-position filename="src/as-validator.h" line="45"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_as_reserved1" introspectable="0">
<callback name="_as_reserved1">
<source-position filename="src/as-validator.h" line="39"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved2" introspectable="0">
<callback name="_as_reserved2">
<source-position filename="src/as-validator.h" line="40"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved3" introspectable="0">
<callback name="_as_reserved3">
<source-position filename="src/as-validator.h" line="41"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved4" introspectable="0">
<callback name="_as_reserved4">
<source-position filename="src/as-validator.h" line="42"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved5" introspectable="0">
<callback name="_as_reserved5">
<source-position filename="src/as-validator.h" line="43"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved6" introspectable="0">
<callback name="_as_reserved6">
<source-position filename="src/as-validator.h" line="44"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
</record>
<enumeration name="ValidatorError"
glib:type-name="AsValidatorError"
glib:get-type="as_validator_error_get_type"
c:type="AsValidatorError"
glib:error-domain="as-validator-error-quark">
<doc xml:space="preserve"
filename="src/as-validator.h"
line="47">The error type.</doc>
<member name="failed"
value="0"
c:identifier="AS_VALIDATOR_ERROR_FAILED"
glib:nick="failed"
glib:name="AS_VALIDATOR_ERROR_FAILED">
<doc xml:space="preserve"
filename="src/as-validator.h"
line="49">Generic failure</doc>
</member>
<member name="invalid_override"
value="1"
c:identifier="AS_VALIDATOR_ERROR_INVALID_OVERRIDE"
glib:nick="invalid-override"
glib:name="AS_VALIDATOR_ERROR_INVALID_OVERRIDE">
<doc xml:space="preserve"
filename="src/as-validator.h"
line="50">The issue override was not accepted.</doc>
</member>
<member name="invalid_filename"
value="2"
c:identifier="AS_VALIDATOR_ERROR_INVALID_FILENAME"
glib:nick="invalid-filename"
glib:name="AS_VALIDATOR_ERROR_INVALID_FILENAME">
<doc xml:space="preserve"
filename="src/as-validator.h"
line="51">The filename was invalid.</doc>
</member>
<function name="quark"
c:identifier="as_validator_error_quark"
version="0.15.4">
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="77">An error quark.</doc>
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
</enumeration>
<class name="ValidatorIssue"
c:symbol-prefix="validator_issue"
c:type="AsValidatorIssue"
parent="GObject.Object"
glib:type-name="AsValidatorIssue"
glib:get-type="as_validator_issue_get_type"
glib:type-struct="ValidatorIssueClass">
<source-position filename="src/as-validator-issue.h" line="44"/>
<constructor name="new" c:identifier="as_validator_issue_new">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="387">Creates a new #AsValidatorIssue.</doc>
<source-position filename="src/as-validator-issue.h" line="69"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="392">a #AsValidatorIssue</doc>
<type name="ValidatorIssue" c:type="AsValidatorIssue*"/>
</return-value>
</constructor>
<method name="get_cid" c:identifier="as_validator_issue_get_cid">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="266">The component-id this issue is about.</doc>
<source-position filename="src/as-validator-issue.h" line="83"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="272">a component-id.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="issue" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="268">a #AsValidatorIssue instance.</doc>
<type name="ValidatorIssue" c:type="AsValidatorIssue*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_explanation"
c:identifier="as_validator_issue_get_explanation"
version="0.12.8">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="232">Get an extended explanation on this issue, or return %NULL
if none is available.</doc>
<source-position filename="src/as-validator-issue.h" line="80"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="239">the explanation</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="issue" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="234">a #AsValidatorIssue instance.</doc>
<type name="ValidatorIssue" c:type="AsValidatorIssue*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_filename"
c:identifier="as_validator_issue_get_filename">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="324">The name of the file this issue was found in.</doc>
<source-position filename="src/as-validator-issue.h" line="86"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="330">the filename</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="issue" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="326">a #AsValidatorIssue instance.</doc>
<type name="ValidatorIssue" c:type="AsValidatorIssue*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_hint"
c:identifier="as_validator_issue_get_hint"
version="0.12.8">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="199">Get a short context hint for this issue.</doc>
<source-position filename="src/as-validator-issue.h" line="77"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="205">the hint</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="issue" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="201">a #AsValidatorIssue instance.</doc>
<type name="ValidatorIssue" c:type="AsValidatorIssue*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_line" c:identifier="as_validator_issue_get_line">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="295">Gets the line number where this issue was found.</doc>
<source-position filename="src/as-validator-issue.h" line="89"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="301">the line number where this issue occured, or -1 if unknown.</doc>
<type name="glong" c:type="glong"/>
</return-value>
<parameters>
<instance-parameter name="issue" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="297">a #AsValidatorIssue instance.</doc>
<type name="ValidatorIssue" c:type="AsValidatorIssue*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_location"
c:identifier="as_validator_issue_get_location">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="353">Builds a string containing all information about the location
where this issue occured that we know about.</doc>
<source-position filename="src/as-validator-issue.h" line="92"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="360">the location hint as string.</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<instance-parameter name="issue" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="355">a #AsValidatorIssue instance.</doc>
<type name="ValidatorIssue" c:type="AsValidatorIssue*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_severity"
c:identifier="as_validator_issue_get_severity">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="170">Gets the severity of this issue.</doc>
<source-position filename="src/as-validator-issue.h" line="74"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="176">a #AsIssueSeverity</doc>
<type name="IssueSeverity" c:type="AsIssueSeverity"/>
</return-value>
<parameters>
<instance-parameter name="issue" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="172">a #AsValidatorIssue instance.</doc>
<type name="ValidatorIssue" c:type="AsValidatorIssue*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_tag"
c:identifier="as_validator_issue_get_tag"
version="0.12.8">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="137">Gets the issue tag string for this issue.</doc>
<source-position filename="src/as-validator-issue.h" line="71"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="143">the tag</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="issue" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="139">a #AsValidatorIssue instance.</doc>
<type name="ValidatorIssue" c:type="AsValidatorIssue*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_cid" c:identifier="as_validator_issue_set_cid">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="281">Sets the component-id this issue is about.</doc>
<source-position filename="src/as-validator-issue.h" line="84"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="issue" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="283">a #AsValidatorIssue instance.</doc>
<type name="ValidatorIssue" c:type="AsValidatorIssue*"/>
</instance-parameter>
<parameter name="cid" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="284">a component-id.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_explanation"
c:identifier="as_validator_issue_set_explanation"
version="0.12.8">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="250">Set explanatory text for this issue.</doc>
<source-position filename="src/as-validator-issue.h" line="81"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="issue" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="252">a #AsValidatorIssue instance.</doc>
<type name="ValidatorIssue" c:type="AsValidatorIssue*"/>
</instance-parameter>
<parameter name="explanation" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="253">the explanation.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_filename"
c:identifier="as_validator_issue_set_filename">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="339">Sets the name of the file the issue was found in.</doc>
<source-position filename="src/as-validator-issue.h" line="87"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="issue" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="341">a #AsValidatorIssue instance.</doc>
<type name="ValidatorIssue" c:type="AsValidatorIssue*"/>
</instance-parameter>
<parameter name="fname" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="342">the filename.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_hint"
c:identifier="as_validator_issue_set_hint"
version="0.12.8">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="216">Sets short issue hint.</doc>
<source-position filename="src/as-validator-issue.h" line="78"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="issue" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="218">a #AsValidatorIssue instance.</doc>
<type name="ValidatorIssue" c:type="AsValidatorIssue*"/>
</instance-parameter>
<parameter name="hint" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="219">the hint.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_line" c:identifier="as_validator_issue_set_line">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="310">Sets the line number where this issue was found.</doc>
<source-position filename="src/as-validator-issue.h" line="90"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="issue" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="312">a #AsValidatorIssue instance.</doc>
<type name="ValidatorIssue" c:type="AsValidatorIssue*"/>
</instance-parameter>
<parameter name="line" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="313">the line number.</doc>
<type name="glong" c:type="glong"/>
</parameter>
</parameters>
</method>
<method name="set_severity"
c:identifier="as_validator_issue_set_severity">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="185">Sets the severity for this issue.</doc>
<source-position filename="src/as-validator-issue.h" line="75"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="issue" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="187">a #AsValidatorIssue instance.</doc>
<type name="ValidatorIssue" c:type="AsValidatorIssue*"/>
</instance-parameter>
<parameter name="severity" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="188">the #AsIssueSeverity.</doc>
<type name="IssueSeverity" c:type="AsIssueSeverity"/>
</parameter>
</parameters>
</method>
<method name="set_tag"
c:identifier="as_validator_issue_set_tag"
version="0.12.8">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="154">Sets the issue tag.</doc>
<source-position filename="src/as-validator-issue.h" line="72"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="issue" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="156">a #AsValidatorIssue instance.</doc>
<type name="ValidatorIssue" c:type="AsValidatorIssue*"/>
</instance-parameter>
<parameter name="tag" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="157">the tag.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<record name="ValidatorIssueClass"
c:type="AsValidatorIssueClass"
glib:is-gtype-struct-for="ValidatorIssue">
<source-position filename="src/as-validator-issue.h" line="44"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_as_reserved1" introspectable="0">
<callback name="_as_reserved1">
<source-position filename="src/as-validator-issue.h" line="38"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved2" introspectable="0">
<callback name="_as_reserved2">
<source-position filename="src/as-validator-issue.h" line="39"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved3" introspectable="0">
<callback name="_as_reserved3">
<source-position filename="src/as-validator-issue.h" line="40"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved4" introspectable="0">
<callback name="_as_reserved4">
<source-position filename="src/as-validator-issue.h" line="41"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved5" introspectable="0">
<callback name="_as_reserved5">
<source-position filename="src/as-validator-issue.h" line="42"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved6" introspectable="0">
<callback name="_as_reserved6">
<source-position filename="src/as-validator-issue.h" line="43"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
</record>
<bitfield name="ValueFlags"
glib:type-name="AsValueFlags"
glib:get-type="as_value_flags_get_type"
c:type="AsValueFlags">
<doc xml:space="preserve"
filename="src/as-context.h"
line="105">Set how values assigned to an #AsComponent should be treated when
they are set or retrieved.</doc>
<member name="none"
value="0"
c:identifier="AS_VALUE_FLAG_NONE"
glib:nick="none"
glib:name="AS_VALUE_FLAG_NONE">
<doc xml:space="preserve"
filename="src/as-context.h"
line="107">No flags.</doc>
</member>
<member name="duplicate_check"
value="1"
c:identifier="AS_VALUE_FLAG_DUPLICATE_CHECK"
glib:nick="duplicate-check"
glib:name="AS_VALUE_FLAG_DUPLICATE_CHECK">
<doc xml:space="preserve"
filename="src/as-context.h"
line="108">Check for duplicates when adding items to list values.</doc>
</member>
<member name="no_translation_fallback"
value="2"
c:identifier="AS_VALUE_FLAG_NO_TRANSLATION_FALLBACK"
glib:nick="no-translation-fallback"
glib:name="AS_VALUE_FLAG_NO_TRANSLATION_FALLBACK">
<doc xml:space="preserve"
filename="src/as-context.h"
line="109">Don't fall back to C when retrieving translated values.</doc>
</member>
</bitfield>
<bitfield name="VercmpFlags"
glib:type-name="AsVercmpFlags"
glib:get-type="as_vercmp_flags_get_type"
c:type="AsVercmpFlags">
<doc xml:space="preserve"
filename="src/as-vercmp.h"
line="31">The flags used when matching unique IDs.</doc>
<member name="none"
value="0"
c:identifier="AS_VERCMP_FLAG_NONE"
glib:nick="none"
glib:name="AS_VERCMP_FLAG_NONE">
<doc xml:space="preserve"
filename="src/as-vercmp.h"
line="33">No flags set</doc>
</member>
<member name="ignore_epoch"
value="1"
c:identifier="AS_VERCMP_FLAG_IGNORE_EPOCH"
glib:nick="ignore-epoch"
glib:name="AS_VERCMP_FLAG_IGNORE_EPOCH">
<doc xml:space="preserve"
filename="src/as-vercmp.h"
line="34">Ignore epoch part of a version string.</doc>
</member>
</bitfield>
<class name="Video"
c:symbol-prefix="video"
c:type="AsVideo"
parent="GObject.Object"
glib:type-name="AsVideo"
glib:get-type="as_video_get_type"
glib:type-struct="VideoClass">
<source-position filename="src/as-video.h" line="44"/>
<constructor name="new" c:identifier="as_video_new">
<doc xml:space="preserve"
filename="src/as-video.c"
line="550">Creates a new #AsVideo.</doc>
<source-position filename="src/as-video.h" line="84"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-video.c"
line="555">a #AsVideo</doc>
<type name="Video" c:type="AsVideo*"/>
</return-value>
</constructor>
<method name="get_codec_kind" c:identifier="as_video_get_codec_kind">
<doc xml:space="preserve"
filename="src/as-video.c"
line="166">Gets the video codec, if known.</doc>
<source-position filename="src/as-video.h" line="86"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-video.c"
line="172">the #AsVideoCodecKind</doc>
<type name="VideoCodecKind" c:type="AsVideoCodecKind"/>
</return-value>
<parameters>
<instance-parameter name="video" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-video.c"
line="168">a #AsVideo instance.</doc>
<type name="Video" c:type="AsVideo*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_container_kind"
c:identifier="as_video_get_container_kind">
<doc xml:space="preserve"
filename="src/as-video.c"
line="197">Gets the video container format, if known.</doc>
<source-position filename="src/as-video.h" line="89"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-video.c"
line="203">the #AsVideoContainerKind</doc>
<type name="VideoContainerKind" c:type="AsVideoContainerKind"/>
</return-value>
<parameters>
<instance-parameter name="video" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-video.c"
line="199">a #AsVideo instance.</doc>
<type name="Video" c:type="AsVideo*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_height" c:identifier="as_video_get_height">
<doc xml:space="preserve"
filename="src/as-video.c"
line="275">Gets the video height, if known.</doc>
<source-position filename="src/as-video.h" line="98"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-video.c"
line="281">height in pixels or 0 if unknown</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="video" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-video.c"
line="277">a #AsVideo instance.</doc>
<type name="Video" c:type="AsVideo*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_locale" c:identifier="as_video_get_locale">
<doc xml:space="preserve"
filename="src/as-video.c"
line="306">Get locale for this video.</doc>
<source-position filename="src/as-video.h" line="101"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-video.c"
line="312">Locale string</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="video" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-video.c"
line="308">a #AsVideo instance.</doc>
<type name="Video" c:type="AsVideo*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_url" c:identifier="as_video_get_url">
<doc xml:space="preserve"
filename="src/as-video.c"
line="213">Gets the full qualified URL for the video, usually pointing at a mirror or CDN server.</doc>
<source-position filename="src/as-video.h" line="92"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-video.c"
line="219">a web URL</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="video" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-video.c"
line="215">a #AsVideo instance.</doc>
<type name="Video" c:type="AsVideo*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_width" c:identifier="as_video_get_width">
<doc xml:space="preserve"
filename="src/as-video.c"
line="244">Gets the video width, if known.</doc>
<source-position filename="src/as-video.h" line="95"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-video.c"
line="250">width in pixels or 0 if unknown</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="video" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-video.c"
line="246">a #AsVideo instance.</doc>
<type name="Video" c:type="AsVideo*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_codec_kind" c:identifier="as_video_set_codec_kind">
<doc xml:space="preserve"
filename="src/as-video.c"
line="151">Sets the video codec.</doc>
<source-position filename="src/as-video.h" line="87"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="video" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-video.c"
line="153">a #AsVideo instance.</doc>
<type name="Video" c:type="AsVideo*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-video.c"
line="154">the #AsVideoCodecKind, e.g. %AS_VIDEO_CODEC_KIND_AV1.</doc>
<type name="VideoCodecKind" c:type="AsVideoCodecKind"/>
</parameter>
</parameters>
</method>
<method name="set_container_kind"
c:identifier="as_video_set_container_kind">
<doc xml:space="preserve"
filename="src/as-video.c"
line="182">Sets the video container.</doc>
<source-position filename="src/as-video.h" line="90"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="video" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-video.c"
line="184">a #AsVideo instance.</doc>
<type name="Video" c:type="AsVideo*"/>
</instance-parameter>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-video.c"
line="185">the #AsVideoContainerKind, e.g. %AS_VIDEO_CONTAINER_KIND_MKV.</doc>
<type name="VideoContainerKind" c:type="AsVideoContainerKind"/>
</parameter>
</parameters>
</method>
<method name="set_height" c:identifier="as_video_set_height">
<doc xml:space="preserve"
filename="src/as-video.c"
line="291">Sets the video height.</doc>
<source-position filename="src/as-video.h" line="99"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="video" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-video.c"
line="293">a #AsVideo instance.</doc>
<type name="Video" c:type="AsVideo*"/>
</instance-parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-video.c"
line="294">the height in pixels.</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="set_locale" c:identifier="as_video_set_locale">
<doc xml:space="preserve"
filename="src/as-video.c"
line="321">Sets the locale for this video.</doc>
<source-position filename="src/as-video.h" line="102"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="video" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-video.c"
line="323">a #AsVideo instance.</doc>
<type name="Video" c:type="AsVideo*"/>
</instance-parameter>
<parameter name="locale" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-video.c"
line="324">the BCP47 locale string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_url" c:identifier="as_video_set_url">
<doc xml:space="preserve"
filename="src/as-video.c"
line="229">Sets the fully-qualified URL to use for the video.</doc>
<source-position filename="src/as-video.h" line="93"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="video" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-video.c"
line="231">a #AsVideo instance.</doc>
<type name="Video" c:type="AsVideo*"/>
</instance-parameter>
<parameter name="url" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-video.c"
line="232">the URL.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_width" c:identifier="as_video_set_width">
<doc xml:space="preserve"
filename="src/as-video.c"
line="260">Sets the video width.</doc>
<source-position filename="src/as-video.h" line="96"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="video" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-video.c"
line="262">a #AsVideo instance.</doc>
<type name="Video" c:type="AsVideo*"/>
</instance-parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-video.c"
line="263">the width in pixels.</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<record name="VideoClass"
c:type="AsVideoClass"
glib:is-gtype-struct-for="Video">
<source-position filename="src/as-video.h" line="44"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_as_reserved1" introspectable="0">
<callback name="_as_reserved1">
<source-position filename="src/as-video.h" line="38"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved2" introspectable="0">
<callback name="_as_reserved2">
<source-position filename="src/as-video.h" line="39"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved3" introspectable="0">
<callback name="_as_reserved3">
<source-position filename="src/as-video.h" line="40"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved4" introspectable="0">
<callback name="_as_reserved4">
<source-position filename="src/as-video.h" line="41"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved5" introspectable="0">
<callback name="_as_reserved5">
<source-position filename="src/as-video.h" line="42"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_as_reserved6" introspectable="0">
<callback name="_as_reserved6">
<source-position filename="src/as-video.h" line="43"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
</record>
<enumeration name="VideoCodecKind"
glib:type-name="AsVideoCodecKind"
glib:get-type="as_video_codec_kind_get_type"
c:type="AsVideoCodecKind">
<doc xml:space="preserve"
filename="src/as-video.h"
line="46">Supported video codecs.</doc>
<member name="unknown"
value="0"
c:identifier="AS_VIDEO_CODEC_KIND_UNKNOWN"
glib:nick="unknown"
glib:name="AS_VIDEO_CODEC_KIND_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-video.h"
line="48">Unknown video codec</doc>
</member>
<member name="vp9"
value="1"
c:identifier="AS_VIDEO_CODEC_KIND_VP9"
glib:nick="vp9"
glib:name="AS_VIDEO_CODEC_KIND_VP9">
<doc xml:space="preserve"
filename="src/as-video.h"
line="49">The VP9 video codec</doc>
</member>
<member name="av1"
value="2"
c:identifier="AS_VIDEO_CODEC_KIND_AV1"
glib:nick="av1"
glib:name="AS_VIDEO_CODEC_KIND_AV1">
<doc xml:space="preserve"
filename="src/as-video.h"
line="50">The AV1 video codec</doc>
</member>
<function name="from_string"
c:identifier="as_video_codec_kind_from_string">
<doc xml:space="preserve"
filename="src/as-video.c"
line="73">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-video.h" line="78"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-video.c"
line="79">a #AsVideoCodecKind, or %AS_VIDEO_CODEC_KIND_UNKNOWN for unknown.</doc>
<type name="VideoCodecKind" c:type="AsVideoCodecKind"/>
</return-value>
<parameters>
<parameter name="str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-video.c"
line="75">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="to_string" c:identifier="as_video_codec_kind_to_string">
<doc xml:space="preserve"
filename="src/as-video.c"
line="92">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-video.h" line="79"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-video.c"
line="98">string version of @codec</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-video.c"
line="94">the #AsVideoCodecKind.</doc>
<type name="VideoCodecKind" c:type="AsVideoCodecKind"/>
</parameter>
</parameters>
</function>
</enumeration>
<enumeration name="VideoContainerKind"
glib:type-name="AsVideoContainerKind"
glib:get-type="as_video_container_kind_get_type"
c:type="AsVideoContainerKind">
<doc xml:space="preserve"
filename="src/as-video.h"
line="62">Supported video codecs.</doc>
<member name="unknown"
value="0"
c:identifier="AS_VIDEO_CONTAINER_KIND_UNKNOWN"
glib:nick="unknown"
glib:name="AS_VIDEO_CONTAINER_KIND_UNKNOWN">
<doc xml:space="preserve"
filename="src/as-video.h"
line="64">Unknown video container</doc>
</member>
<member name="mkv"
value="1"
c:identifier="AS_VIDEO_CONTAINER_KIND_MKV"
glib:nick="mkv"
glib:name="AS_VIDEO_CONTAINER_KIND_MKV">
<doc xml:space="preserve"
filename="src/as-video.h"
line="65">The Matroska video (MKV) container</doc>
</member>
<member name="webm"
value="2"
c:identifier="AS_VIDEO_CONTAINER_KIND_WEBM"
glib:nick="webm"
glib:name="AS_VIDEO_CONTAINER_KIND_WEBM">
<doc xml:space="preserve"
filename="src/as-video.h"
line="66">The WebM video container</doc>
</member>
<function name="from_string"
c:identifier="as_video_container_kind_from_string">
<doc xml:space="preserve"
filename="src/as-video.c"
line="111">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-video.h" line="81"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-video.c"
line="117">a #AsVideoContainerKind, or %AS_VIDEO_CONTAINER_KIND_UNKNOWN for unknown.</doc>
<type name="VideoContainerKind" c:type="AsVideoContainerKind"/>
</return-value>
<parameters>
<parameter name="str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-video.c"
line="113">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="to_string"
c:identifier="as_video_container_kind_to_string">
<doc xml:space="preserve"
filename="src/as-video.c"
line="132">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-video.h" line="82"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-video.c"
line="138">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-video.c"
line="134">the #AsVideoContainerKind.</doc>
<type name="VideoContainerKind" c:type="AsVideoContainerKind"/>
</parameter>
</parameters>
</function>
</enumeration>
<function name="agreement_kind_from_string"
c:identifier="as_agreement_kind_from_string"
moved-to="AgreementKind.from_string"
version="0.12.1">
<doc xml:space="preserve"
filename="src/as-agreement.c"
line="102">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-agreement.h" line="72"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-agreement.c"
line="108">a #AsAgreementKind or %AS_AGREEMENT_KIND_UNKNOWN for unknown</doc>
<type name="AgreementKind" c:type="AsAgreementKind"/>
</return-value>
<parameters>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-agreement.c"
line="104">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="agreement_kind_to_string"
c:identifier="as_agreement_kind_to_string"
moved-to="AgreementKind.to_string"
version="0.12.1">
<doc xml:space="preserve"
filename="src/as-agreement.c"
line="80">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-agreement.h" line="71"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-agreement.c"
line="86">string version of @value</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-agreement.c"
line="82">the #AsAgreementKind.</doc>
<type name="AgreementKind" c:type="AsAgreementKind"/>
</parameter>
</parameters>
</function>
<function name="artifact_kind_from_string"
c:identifier="as_artifact_kind_from_string"
moved-to="ArtifactKind.from_string">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="88">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-artifact.h" line="85"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="94">a #AsArtifactKind, or %AS_ARTIFACT_KIND_UNKNOWN for unknown.</doc>
<type name="ArtifactKind" c:type="AsArtifactKind"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="90">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="artifact_kind_to_string"
c:identifier="as_artifact_kind_to_string"
moved-to="ArtifactKind.to_string">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="107">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-artifact.h" line="86"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="113">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="109">the #AsArtifactKind.</doc>
<type name="ArtifactKind" c:type="AsArtifactKind"/>
</parameter>
</parameters>
</function>
<docsection name="as-agreement">
<doc xml:space="preserve"
filename="src/as-agreement.c"
line="22">Agreements can be used by components to specify GDPR, EULA or other warnings.
See also: #AsAgreementSection</doc>
</docsection>
<docsection name="as-agreement-section">
<doc xml:space="preserve"
filename="src/as-agreement-section.c"
line="22">Agreements are typically split up into sections.
This class describes one agreement section.
See also: #AsAgreement</doc>
</docsection>
<docsection name="as-artifact">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="21">Describes a artifact artifact
See also: #AsArtifact</doc>
</docsection>
<docsection name="as-branding">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="21">This class provides information contained in an AppStream branding tag.
See https://www.freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-branding
for more information.
See also: #AsComponent</doc>
</docsection>
<docsection name="as-bundle">
<doc xml:space="preserve"
filename="src/as-bundle.c"
line="21">This class provides information contained in an AppStream bundle tag.
See https://www.freedesktop.org/software/appstream/docs/chap-CatalogData.html#tag-ct-bundle
for more information.
See also: #AsComponent</doc>
</docsection>
<docsection name="as-cache">
<doc xml:space="preserve"
filename="src/as-cache.c"
line="21">Caches are used by #AsPool to quickly search for components while not keeping all
component data in memory.
This class is threadsafe.
See also: #AsPool</doc>
</docsection>
<docsection name="as-category">
<doc xml:space="preserve"
filename="src/as-category.c"
line="32">This object represents a XDG category, as defined at:
https://specifications.freedesktop.org/menu-spec/latest/category-registry.html
The #AsCategory object does not support all aspects of a menu. Its main purpose
is to be used in software-centers to group visual components (gui/web applications).
You can use %as_get_default_categories() to get a set of supported default categories.
See also: #AsComponent</doc>
</docsection>
<docsection name="as-checksum">
<doc xml:space="preserve"
filename="src/as-checksum.c"
line="21">A checksum for a file referenced in a release.
See also: #AsRelease</doc>
</docsection>
<docsection name="as-component">
<doc xml:space="preserve"
filename="src/as-component.c"
line="51">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</doc>
</docsection>
<docsection name="as-component-box">
<doc xml:space="preserve"
filename="src/as-component-box.c"
line="21">This class is a container for #AsComponent objects which usually share the same #AsContext
and are manipulated together.
It also provides binding-safe accessor functions to manipulate an array of
components.
See also: #AsComponent</doc>
</docsection>
<docsection name="as-content-rating">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="23">Content ratings are age-specific guidelines for applications.
See also: #AsComponent</doc>
</docsection>
<docsection name="as-context">
<doc xml:space="preserve"
filename="src/as-context.c"
line="21">Contains information about the context of AppStream metadata, from the
root node of the document.
Instances of #AsContext may be shared between #AsComponent instances.
You usually do not want to use this directly, but use the more convenient
#AsMetadata instead.
See also: #AsComponent, #AsMetadata</doc>
</docsection>
<docsection name="as-developer">
<doc xml:space="preserve"
filename="src/as-developer.c"
line="21">Describes the developer of a component.
See also: #AsComponent</doc>
</docsection>
<docsection name="as-distro-extras">
<doc xml:space="preserve"
filename="src/as-distro-extras.c"
line="24">This module mainly contains distribution-specific, non-public helper methods.</doc>
</docsection>
<docsection name="as-file-monitor">
<doc xml:space="preserve"
filename="src/as-file-monitor.c"
line="22">This object will monitor a set of directories for changes.
See also: #AsPool</doc>
</docsection>
<docsection name="as-image">
<doc xml:space="preserve"
filename="src/as-image.c"
line="22">Screenshot may have multiple versions of an image in different resolutions
or aspect ratios. This object allows access to the location and size of a
single image.
See also: #AsScreenshot</doc>
</docsection>
<docsection name="as-issue">
<doc xml:space="preserve"
filename="src/as-issue.c"
line="21">Information about an issue that was resolved in a release.
See also: #AsRelease</doc>
</docsection>
<docsection name="as-launchable">
<doc xml:space="preserve"
filename="src/as-launchable.c"
line="27">Components can provide multiple launch-entries to launch the software they belong to.
This class describes them.
See also: #AsComponent</doc>
</docsection>
<docsection name="as-metadata">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="21">This object parses MetaInfo data, AppStream Catalog metadata
and AppStream release metadata into #AsComponent representations.
It is also able to serialize #AsComponent entities into their
various AppStream XML/YAML representations.
See also: #AsComponent, #AsRelease, #AsPool</doc>
</docsection>
<docsection name="as-news-convert">
<doc xml:space="preserve"
filename="src/as-news-convert.c"
line="22">Read NEWS and other types of release information files and convert them
to AppStream metainfo data.
Also, write NEWS files from #AsRelease release information.
These functions are private/internal.</doc>
</docsection>
<docsection name="as-pool">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="21">This class loads AppStream metadata from various sources and refines it with existing
knowledge about the system (e.g. by setting absolute paths for cached icons).
An #AsPool will use an on-disk cache to store metadata is has read and refined to
speed up the loading time when the same data is requested a second time.
You can find AppStream metadata matching various user-defined criteria, and also add new
metadata to the pool.
The caching behavior can be controlled by the application using #AsCacheFlags.
An AppStream cache object can also be created and read using the appstreamcli(1) utility.
This class is threadsafe.
See also: #AsComponent</doc>
</docsection>
<docsection name="as-provided">
<doc xml:space="preserve"
filename="src/as-provided.c"
line="30">Components can provide various items, like libraries, Python-modules,
firmware, binaries, etc.
Functions to work with these items are provided here.
See also: #AsComponent</doc>
</docsection>
<docsection name="as-reference">
<doc xml:space="preserve"
filename="src/as-reference.c"
line="21">Contains information about external references to the
component this reference is associated with.
See also: #AsComponent</doc>
</docsection>
<docsection name="as-relation">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="34">A component can have recommends- or requires relations on other components, system properties,
hardware and other interfaces.
This class contains a representation of those relations.
See also: #AsComponent</doc>
</docsection>
<docsection name="as-release">
<doc xml:space="preserve"
filename="src/as-release.c"
line="22">This object represents a single upstream release, typically a minor update.
Releases can contain a localized description of paragraph and list elements
and also have a version number and timestamp.
Releases can be automatically generated by parsing upstream ChangeLogs or
.spec files, or can be populated using MetaInfo files.
See also: #AsComponent</doc>
</docsection>
<docsection name="as-release-list">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="21">This class contains multiple #Asrelease entries as well as information
affecting all releases of that grouping.
It can also fetch the required release information on-demand from
a web URL in case it is not available locally.
See also: #AsRelease, #AsRelease</doc>
</docsection>
<docsection name="as-releation-check-result">
<doc xml:space="preserve"
filename="src/as-relation-check-result.c"
line="21">This class contains resulting information from a check for whether an
#AsRelation is satisfied on a specific system configuration.
See also: #AsRelation</doc>
</docsection>
<docsection name="as-review">
<doc xml:space="preserve"
filename="src/as-review.c"
line="23">This object represents a user-submitted software review.</doc>
</docsection>
<docsection name="as-screenshot">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="22">Screenshots have a localized caption and contain either a set of images
of different resolution or a video screencast showcasing the software.
See also: #AsImage, #AsVideo</doc>
</docsection>
<docsection name="as-suggested">
<doc xml:space="preserve"
filename="src/as-suggested.c"
line="22">This class provides a list of other component-ids suggested by a software component, as well
as an origin of the suggestion (manually suggested by the upstream project, or
automatically determined by heuristics).</doc>
</docsection>
<docsection name="as-system-info">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="21">This class reads information about the current operating system and device
that AppStream is running on. It can also be used by GUI toolkits to set
data that we can not automatically determine in a toolkit-independent way,
such as screen dimensions.
AppStream uses this information to verify component relations
(as set in requires/recommends/supports etc. tags).
See also: #AsComponent</doc>
</docsection>
<docsection name="as-tag">
<doc xml:space="preserve"
filename="src/as-tag.c"
line="22">These functions will convert a tag enum such as %AS_TAG_COMPONENT to
it's string form, and also vice-versa.
These helper functions may be useful if implementing an AppStream parser.</doc>
</docsection>
<docsection name="as-translation">
<doc xml:space="preserve"
filename="src/as-translation.c"
line="29">Describes the translation domain and translation system used by the upstream component.
See [the specification](https://www.freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-translation) for
more information on the corresponding XML tag.
See also: #AsComponent</doc>
</docsection>
<docsection name="as-utils">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="52">Functions which are used in libappstream and might be useful for others
as well.</doc>
</docsection>
<docsection name="as-validator">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="21">This object is able to validate AppStream XML metadata (catalog and metainfo)
and to generate a report about issues found with it.
See also: #AsMetadata</doc>
</docsection>
<docsection name="as-validator-issue">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="21">See also: #AsValidator</doc>
</docsection>
<docsection name="as-vercmp">
<doc xml:space="preserve"
filename="src/as-vercmp.c"
line="29">Compare software version numbers.</doc>
</docsection>
<docsection name="as-version">
<doc xml:space="preserve"
filename="src/as-version.c"
line="22">These functions are used in client code to conditionalize compilation
depending on the version of libappstream headers installed.
Also, a function to obtain the AppStream version at runtime is provided.</doc>
</docsection>
<docsection name="as-video">
<doc xml:space="preserve"
filename="src/as-video.c"
line="21">Screenshot may have a video instead of a static image associated with them.
This object allows access to the video and basic information about it.
See also: #AsScreenshot, #AsImage</doc>
</docsection>
<function name="bundle_kind_from_string"
c:identifier="as_bundle_kind_from_string"
moved-to="BundleKind.from_string">
<doc xml:space="preserve"
filename="src/as-bundle.c"
line="78">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-bundle.h" line="77"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-bundle.c"
line="84">a #AsBundleKind or %AS_BUNDLE_KIND_UNKNOWN for unknown</doc>
<type name="BundleKind" c:type="AsBundleKind"/>
</return-value>
<parameters>
<parameter name="bundle_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-bundle.c"
line="80">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="bundle_kind_to_string"
c:identifier="as_bundle_kind_to_string"
moved-to="BundleKind.to_string"
version="0.8.0">
<doc xml:space="preserve"
filename="src/as-bundle.c"
line="44">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-bundle.h" line="76"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-bundle.c"
line="50">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-bundle.c"
line="46">the %AsBundleKind.</doc>
<type name="BundleKind" c:type="AsBundleKind"/>
</parameter>
</parameters>
</function>
<function name="chassis_kind_from_string"
c:identifier="as_chassis_kind_from_string"
moved-to="ChassisKind.from_string"
version="1.0.0">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="138">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-system-info.h" line="89"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="144">a #AsChassisKind or %AS_CHASSIS_KIND_UNKNOWN for unknown</doc>
<type name="ChassisKind" c:type="AsChassisKind"/>
</return-value>
<parameters>
<parameter name="kind_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="140">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="chassis_kind_to_string"
c:identifier="as_chassis_kind_to_string"
moved-to="ChassisKind.to_string"
version="1.0.0">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="111">Converts the enumerated value to a text representation.</doc>
<source-position filename="src/as-system-info.h" line="88"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="117">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="113">the #AsChassisKind.</doc>
<type name="ChassisKind" c:type="AsChassisKind"/>
</parameter>
</parameters>
</function>
<function name="checksum_kind_from_string"
c:identifier="as_checksum_kind_from_string"
moved-to="ChecksumKind.from_string">
<doc xml:space="preserve"
filename="src/as-checksum.c"
line="71">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-checksum.h" line="69"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-checksum.c"
line="77">a #AsChecksumKind or %AS_CHECKSUM_KIND_NONE for unknown</doc>
<type name="ChecksumKind" c:type="AsChecksumKind"/>
</return-value>
<parameters>
<parameter name="kind_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-checksum.c"
line="73">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="checksum_kind_to_string"
c:identifier="as_checksum_kind_to_string"
moved-to="ChecksumKind.to_string">
<doc xml:space="preserve"
filename="src/as-checksum.c"
line="45">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-checksum.h" line="68"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-checksum.c"
line="51">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-checksum.c"
line="47">the %AsChecksumKind.</doc>
<type name="ChecksumKind" c:type="AsChecksumKind"/>
</parameter>
</parameters>
</function>
<function name="color_kind_from_string"
c:identifier="as_color_kind_from_string"
moved-to="ColorKind.from_string"
version="0.15.2">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="105">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-branding.h" line="87"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="111">a #AsColorKind or %AS_COLOR_KIND_UNKNOWN for unknown.</doc>
<type name="ColorKind" c:type="AsColorKind"/>
</return-value>
<parameters>
<parameter name="str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="107">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="color_kind_to_string"
c:identifier="as_color_kind_to_string"
moved-to="ColorKind.to_string"
version="0.15.2">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="87">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-branding.h" line="86"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="93">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="89">the %AsColorKind.</doc>
<type name="ColorKind" c:type="AsColorKind"/>
</parameter>
</parameters>
</function>
<function name="color_scheme_kind_from_string"
c:identifier="as_color_scheme_kind_from_string"
moved-to="ColorSchemeKind.from_string"
version="0.15.2">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="143">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-branding.h" line="90"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="149">a #AsColorKind or %AS_COLOR_SCHEME_KIND_UNKNOWN for unknown.</doc>
<type name="ColorSchemeKind" c:type="AsColorSchemeKind"/>
</return-value>
<parameters>
<parameter name="str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="145">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="color_scheme_kind_to_string"
c:identifier="as_color_scheme_kind_to_string"
moved-to="ColorSchemeKind.to_string"
version="0.15.2">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="123">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-branding.h" line="89"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="129">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-branding.c"
line="125">the %AsColorSchemeKind.</doc>
<type name="ColorSchemeKind" c:type="AsColorSchemeKind"/>
</parameter>
</parameters>
</function>
<function-macro name="component_box_index"
c:identifier="as_component_box_index"
introspectable="0">
<doc xml:space="preserve"
filename="src/as-component-box.c"
line="185">Returns the #AsComponent at the given index of the array.
This does not perform bounds checking on the given @index_,
so you are responsible for checking it against the array length.
Use %as_component_box_len to determine the amount of components
present in the #AsComponentBox.</doc>
<source-position filename="src/as-component-box.h" line="74"/>
<parameters>
<parameter name="cbox">
<doc xml:space="preserve"
filename="src/as-component-box.c"
line="187">a #AsComponentBox</doc>
</parameter>
<parameter name="index_">
<doc xml:space="preserve"
filename="src/as-component-box.c"
line="188">the index of the #AsComponent to return</doc>
</parameter>
</parameters>
</function-macro>
<function-macro name="component_box_len"
c:identifier="as_component_box_len"
introspectable="0">
<doc xml:space="preserve"
filename="src/as-component-box.c"
line="200">Get the amount of components in its box array.</doc>
<source-position filename="src/as-component-box.h" line="76"/>
<parameters>
<parameter name="cbox">
<doc xml:space="preserve"
filename="src/as-component-box.c"
line="202">a #AsComponentBox</doc>
</parameter>
</parameters>
</function-macro>
<function name="component_kind_from_string"
c:identifier="as_component_kind_from_string"
moved-to="ComponentKind.from_string">
<doc xml:space="preserve"
filename="src/as-component.c"
line="200">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-component.h" line="113"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="206">a #AsComponentKind or %AS_COMPONENT_KIND_UNKNOWN for unknown</doc>
<type name="ComponentKind" c:type="AsComponentKind"/>
</return-value>
<parameters>
<parameter name="kind_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="202">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="component_kind_to_string"
c:identifier="as_component_kind_to_string"
moved-to="ComponentKind.to_string">
<doc xml:space="preserve"
filename="src/as-component.c"
line="154">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-component.h" line="112"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="160">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="156">the #AsComponentKind.</doc>
<type name="ComponentKind" c:type="AsComponentKind"/>
</parameter>
</parameters>
</function>
<function name="component_scope_from_string"
c:identifier="as_component_scope_from_string"
moved-to="ComponentScope.from_string">
<doc xml:space="preserve"
filename="src/as-component.c"
line="315">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-component.h" line="154"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="321">a #AsComponentScope or %AS_COMPONENT_SCOPE_UNKNOWN for unknown</doc>
<type name="ComponentScope" c:type="AsComponentScope"/>
</return-value>
<parameters>
<parameter name="scope_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="317">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="component_scope_to_string"
c:identifier="as_component_scope_to_string"
moved-to="ComponentScope.to_string">
<doc xml:space="preserve"
filename="src/as-component.c"
line="297">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-component.h" line="153"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="303">string version of @scope</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="scope" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="299">the #AsComponentScope.</doc>
<type name="ComponentScope" c:type="AsComponentScope"/>
</parameter>
</parameters>
</function>
<function name="content_rating_system_format_age"
c:identifier="as_content_rating_system_format_age"
moved-to="ContentRatingSystem.format_age"
version="0.12.12">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="287">Format @age as a human-readable string in the given rating @system. This is
the way to present system-specific strings in a UI.</doc>
<source-position filename="src/as-content-rating.h" line="120"/>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="295">a newly allocated formatted version of
@age, or %NULL if the given @system has no representation for @age</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<parameter name="system" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="289">an #AsContentRatingSystem</doc>
<type name="ContentRatingSystem" c:type="AsContentRatingSystem"/>
</parameter>
<parameter name="age" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="290">a CSM age to format</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</function>
<function name="content_rating_system_from_locale"
c:identifier="as_content_rating_system_from_locale"
moved-to="ContentRatingSystem.from_locale"
version="0.12.12">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="683">Determine the most appropriate #AsContentRatingSystem for the given @locale.
Content rating systems are selected by territory. If no content rating system
seems suitable, %AS_CONTENT_RATING_SYSTEM_IARC is returned.</doc>
<source-position filename="src/as-content-rating.h" line="122"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="691">the most relevant #AsContentRatingSystem</doc>
<type name="ContentRatingSystem" c:type="AsContentRatingSystem"/>
</return-value>
<parameters>
<parameter name="locale" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="685">a locale, in the format described in `man 3 setlocale`</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="content_rating_system_get_csm_ages"
c:identifier="as_content_rating_system_get_csm_ages"
moved-to="ContentRatingSystem.get_csm_ages"
version="0.12.12">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="580">Get the CSM ages corresponding to the entries returned by
as_content_rating_system_get_formatted_ages() for this @system.</doc>
<source-position filename="src/as-content-rating.h" line="125"/>
<return-value transfer-ownership="container">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="589">an array of CSM ages</doc>
<array length="1" zero-terminated="0" c:type="const guint*">
<type name="guint" c:type="guint"/>
</array>
</return-value>
<parameters>
<parameter name="system" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="582">an #AsContentRatingSystem</doc>
<type name="ContentRatingSystem" c:type="AsContentRatingSystem"/>
</parameter>
<parameter name="length_out"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="583">return location for the length of the
returned array</doc>
<type name="gsize" c:type="gsize*"/>
</parameter>
</parameters>
</function>
<function name="content_rating_system_get_formatted_ages"
c:identifier="as_content_rating_system_get_formatted_ages"
moved-to="ContentRatingSystem.get_formatted_ages"
version="0.12.12">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="520">Get an array of all the possible return values of
as_content_rating_system_format_age() for the given @system. The array is
sorted with youngest CSM age first.</doc>
<source-position filename="src/as-content-rating.h" line="124"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="528">%NULL-terminated array of human-readable age strings</doc>
<array c:type="gchar**">
<type name="utf8"/>
</array>
</return-value>
<parameters>
<parameter name="system" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="522">an #AsContentRatingSystem</doc>
<type name="ContentRatingSystem" c:type="AsContentRatingSystem"/>
</parameter>
</parameters>
</function>
<function name="content_rating_system_to_string"
c:identifier="as_content_rating_system_to_string"
moved-to="ContentRatingSystem.to_string"
version="0.12.12">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="257">Get a human-readable string to identify @system. %NULL will be returned for
%AS_CONTENT_RATING_SYSTEM_UNKNOWN.</doc>
<source-position filename="src/as-content-rating.h" line="119"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="264">a human-readable string for @system, or %NULL if unknown</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="system" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="259">an #AsContentRatingSystem</doc>
<type name="ContentRatingSystem" c:type="AsContentRatingSystem"/>
</parameter>
</parameters>
</function>
<function name="content_rating_value_from_string"
c:identifier="as_content_rating_value_from_string"
moved-to="ContentRatingValue.from_string"
version="0.11.0">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="221">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-content-rating.h" line="113"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="227">a #AsContentRatingValue or %AS_CONTENT_RATING_VALUE_UNKNOWN for unknown</doc>
<type name="ContentRatingValue" c:type="AsContentRatingValue"/>
</return-value>
<parameters>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="223">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="content_rating_value_to_string"
c:identifier="as_content_rating_value_to_string"
moved-to="ContentRatingValue.to_string"
version="0.11.0">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="197">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-content-rating.h" line="112"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="203">string version of @value</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-content-rating.c"
line="199">the #AsContentRatingValue.</doc>
<type name="ContentRatingValue" c:type="AsContentRatingValue"/>
</parameter>
</parameters>
</function>
<function name="control_kind_from_string"
c:identifier="as_control_kind_from_string"
moved-to="ControlKind.from_string"
version="0.12.11">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="328">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-relation.h" line="221"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="334">a #AsControlKind or %AS_CONTROL_KIND_UNKNOWN for unknown</doc>
<type name="ControlKind" c:type="AsControlKind"/>
</return-value>
<parameters>
<parameter name="kind_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="330">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="control_kind_to_string"
c:identifier="as_control_kind_to_string"
moved-to="ControlKind.to_string"
version="0.12.11">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="294">Converts the enumerated value to a text representation.</doc>
<source-position filename="src/as-relation.h" line="220"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="300">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="296">the #AsControlKind.</doc>
<type name="ControlKind" c:type="AsControlKind"/>
</parameter>
</parameters>
</function>
<function name="display_side_kind_from_string"
c:identifier="as_display_side_kind_from_string"
moved-to="DisplaySideKind.from_string"
version="0.12.12">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="382">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-relation.h" line="224"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="388">a #AsDisplaySideKind or %AS_DISPLAY_SIDE_KIND_UNKNOWN for unknown</doc>
<type name="DisplaySideKind" c:type="AsDisplaySideKind"/>
</return-value>
<parameters>
<parameter name="kind_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="384">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="display_side_kind_to_string"
c:identifier="as_display_side_kind_to_string"
moved-to="DisplaySideKind.to_string"
version="0.12.12">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="362">Converts the enumerated value to a text representation.</doc>
<source-position filename="src/as-relation.h" line="223"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="368">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="364">the #AsDisplaySideKind.</doc>
<type name="DisplaySideKind" c:type="AsDisplaySideKind"/>
</parameter>
</parameters>
</function>
<function-macro name="flags_add"
c:identifier="as_flags_add"
introspectable="0">
<source-position filename="src/as-macros.h" line="35"/>
<parameters>
<parameter name="bitfield">
</parameter>
<parameter name="flag">
</parameter>
</parameters>
</function-macro>
<function-macro name="flags_contains"
c:identifier="as_flags_contains"
introspectable="0">
<source-position filename="src/as-macros.h" line="47"/>
<parameters>
<parameter name="bitfield">
</parameter>
<parameter name="flag">
</parameter>
</parameters>
</function-macro>
<function-macro name="flags_invert"
c:identifier="as_flags_invert"
introspectable="0">
<source-position filename="src/as-macros.h" line="43"/>
<parameters>
<parameter name="bitfield">
</parameter>
<parameter name="flag">
</parameter>
</parameters>
</function-macro>
<function-macro name="flags_remove"
c:identifier="as_flags_remove"
introspectable="0">
<source-position filename="src/as-macros.h" line="39"/>
<parameters>
<parameter name="bitfield">
</parameter>
<parameter name="flag">
</parameter>
</parameters>
</function-macro>
<function name="format_kind_from_string"
c:identifier="as_format_kind_from_string"
moved-to="FormatKind.from_string"
version="0.10.0">
<doc xml:space="preserve"
filename="src/as-context.c"
line="122">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-context.h" line="103"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="128">a #AsFormatKind or %AS_FORMAT_KIND_UNKNOWN for unknown</doc>
<type name="FormatKind" c:type="AsFormatKind"/>
</return-value>
<parameters>
<parameter name="kind_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="124">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="format_kind_to_string"
c:identifier="as_format_kind_to_string"
moved-to="FormatKind.to_string"
version="0.10.0">
<doc xml:space="preserve"
filename="src/as-context.c"
line="102">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-context.h" line="102"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="108">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="104">the #AsFormatKind.</doc>
<type name="FormatKind" c:type="AsFormatKind"/>
</parameter>
</parameters>
</function>
<function name="format_version_from_string"
c:identifier="as_format_version_from_string"
moved-to="FormatVersion.from_string"
version="0.10.0">
<doc xml:space="preserve"
filename="src/as-context.c"
line="83">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-context.h" line="63"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="89">a #AsFormatVersion. For unknown, the highest version
number is assumed.</doc>
<type name="FormatVersion" c:type="AsFormatVersion"/>
</return-value>
<parameters>
<parameter name="version_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="85">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="format_version_to_string"
c:identifier="as_format_version_to_string"
moved-to="FormatVersion.to_string"
version="0.10.0">
<doc xml:space="preserve"
filename="src/as-context.c"
line="65">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-context.h" line="62"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="71">string version of @version</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="version" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-context.c"
line="67">the #AsFormatKind.</doc>
<type name="FormatVersion" c:type="AsFormatVersion"/>
</parameter>
</parameters>
</function>
<function name="get_current_distro_component_id"
c:identifier="as_get_current_distro_component_id">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="1231">Returns the component-ID of the current distribution based on contents
of the `/etc/os-release` file.
This function is a shorthand for %as_distro_details_get_cid</doc>
<source-position filename="src/as-system-info.h" line="146"/>
<return-value transfer-ownership="full">
<type name="utf8" c:type="gchar*"/>
</return-value>
</function>
<function name="get_default_categories"
c:identifier="as_get_default_categories"
shadowed-by="get_default_categories_gi"
introspectable="0">
<doc xml:space="preserve"
filename="src/as-category.c"
line="778">Get a list of the default Freedesktop and AppStream categories
that software components (especially GUI applications) can be sorted
into in software centers.</doc>
<source-position filename="src/as-category.h" line="72"/>
<return-value transfer-ownership="container">
<doc xml:space="preserve"
filename="src/as-category.c"
line="786">a list of #AsCategory</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="Category"/>
</array>
</return-value>
<parameters>
<parameter name="with_special" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-category.c"
line="780">Include special categories (e.g. "addons", and "all"/"featured" in submenus)</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</function>
<function name="get_default_categories_gi"
c:identifier="as_get_default_categories_gi"
shadows="get_default_categories">
<doc xml:space="preserve"
filename="src/as-category.c"
line="853">Get a list of the default Freedesktop and AppStream categories
that software components (especially GUI applications) can be sorted
into in software centers.
This function fully transfers ownership of the returned container,
to be used in GIR bindings.</doc>
<source-position filename="src/as-category-gi.h" line="31"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-category.c"
line="864">a list of #AsCategory</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="Category"/>
</array>
</return-value>
<parameters>
<parameter name="with_special" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-category.c"
line="855">Include special categories (e.g. "addons", and "all"/"featured" in submenus)</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</function>
<function name="get_license_name"
c:identifier="as_get_license_name"
version="1.0.0">
<doc xml:space="preserve"
filename="src/as-spdx.c"
line="645">Get a translated license name for the given SPDX ID.</doc>
<source-position filename="src/as-spdx.h" line="45"/>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve"
filename="src/as-spdx.c"
line="651">The license name, or %NULL if none found.</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<parameter name="license" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-spdx.c"
line="647">The SPDX license ID.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="get_license_url"
c:identifier="as_get_license_url"
version="0.12.7">
<doc xml:space="preserve"
filename="src/as-spdx.c"
line="682">Get a web URL to the license text and more license information for an SPDX
license identifier.</doc>
<source-position filename="src/as-spdx.h" line="46"/>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve"
filename="src/as-spdx.c"
line="689">The license URL, or %NULL if none available.</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<parameter name="license" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-spdx.c"
line="684">The SPDX license ID.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="gstring_replace" c:identifier="as_gstring_replace">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="884">Replaces the string @find with the string @replace in a #GString up to
@limit times. If the number of instances of @find in the #GString is
less than @limit, all instances are replaced. If @limit is `0`,
all instances of @find are replaced.</doc>
<source-position filename="src/as-utils.h" line="141"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="896">the number of find and replace operations performed.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<parameter name="string" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="886">a #GString</doc>
<type name="GLib.String" c:type="GString*"/>
</parameter>
<parameter name="find" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="887">the string to find in @string</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="replace" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="888">the string to insert in place of @find</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="limit" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="889">the maximum instances of @find to replace with @replace, or `0` for no limit</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</function>
<function name="icon_kind_from_string"
c:identifier="as_icon_kind_from_string"
moved-to="IconKind.from_string">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="67">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-icon.h" line="66"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="73">a #AsIconKind or %AS_ICON_KIND_UNKNOWN for unknown</doc>
<type name="IconKind" c:type="AsIconKind"/>
</return-value>
<parameters>
<parameter name="kind_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="69">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="icon_kind_to_string"
c:identifier="as_icon_kind_to_string"
moved-to="IconKind.to_string">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="45">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-icon.h" line="67"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="51">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-icon.c"
line="47">the %AsIconKind.</doc>
<type name="IconKind" c:type="AsIconKind"/>
</parameter>
</parameters>
</function>
<function name="image_kind_from_string"
c:identifier="as_image_kind_from_string"
moved-to="ImageKind.from_string">
<doc xml:space="preserve"
filename="src/as-image.c"
line="79">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-image.h" line="62"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-image.c"
line="85">a #AsImageKind, or %AS_IMAGE_KIND_UNKNOWN for unknown.</doc>
<type name="ImageKind" c:type="AsImageKind"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-image.c"
line="81">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="image_kind_to_string"
c:identifier="as_image_kind_to_string"
moved-to="ImageKind.to_string">
<doc xml:space="preserve"
filename="src/as-image.c"
line="98">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-image.h" line="63"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-image.c"
line="104">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-image.c"
line="100">the #AsImageKind.</doc>
<type name="ImageKind" c:type="AsImageKind"/>
</parameter>
</parameters>
</function>
<function name="internet_kind_from_string"
c:identifier="as_internet_kind_from_string"
moved-to="InternetKind.from_string"
version="0.15.5">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="404">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-relation.h" line="227"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="410">a #AsInternetKind or %AS_INTERNET_KIND_UNKNOWN for unknown</doc>
<type name="InternetKind" c:type="AsInternetKind"/>
</return-value>
<parameters>
<parameter name="kind_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="406">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="internet_kind_to_string"
c:identifier="as_internet_kind_to_string"
moved-to="InternetKind.to_string"
version="0.15.5">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="426">Converts the enumerated value to a text representation.</doc>
<source-position filename="src/as-relation.h" line="226"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="432">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="428">the #AsInternetKind.</doc>
<type name="InternetKind" c:type="AsInternetKind"/>
</parameter>
</parameters>
</function>
<function name="is_spdx_license_exception_id"
c:identifier="as_is_spdx_license_exception_id"
version="0.12.10">
<doc xml:space="preserve"
filename="src/as-spdx.c"
line="177">Searches the known list of SPDX license exception IDs.</doc>
<source-position filename="src/as-spdx.h" line="33"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-spdx.c"
line="183">%TRUE if the string is a valid SPDX license exception ID</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="exception_id" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-spdx.c"
line="179">a single SPDX license exception ID, e.g. "GCC-exception-3.1"</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="is_spdx_license_expression"
c:identifier="as_is_spdx_license_expression"
version="0.9.8">
<doc xml:space="preserve"
filename="src/as-spdx.c"
line="204">Checks the licence string to check it being a valid licence.
NOTE: SPDX licenses can't typically contain brackets.</doc>
<source-position filename="src/as-spdx.h" line="34"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-spdx.c"
line="211">%TRUE if the icon is a valid "SPDX license"</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="license" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-spdx.c"
line="206">a SPDX license string, e.g. "CC-BY-3.0 and GFDL-1.3"</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="is_spdx_license_id"
c:identifier="as_is_spdx_license_id"
version="0.9.8">
<doc xml:space="preserve"
filename="src/as-spdx.c"
line="146">Searches the known list of SPDX license IDs.</doc>
<source-position filename="src/as-spdx.h" line="32"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-spdx.c"
line="152">%TRUE if the string is a valid SPDX license ID</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="license_id" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-spdx.c"
line="148">a single SPDX license ID, e.g. "GPL-3.0"</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="issue_kind_from_string"
c:identifier="as_issue_kind_from_string"
moved-to="IssueKind.from_string">
<doc xml:space="preserve"
filename="src/as-issue.c"
line="62">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-issue.h" line="63"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-issue.c"
line="68">a #AsIssueKind or %AS_ISSUE_KIND_UNKNOWN for unknown</doc>
<type name="IssueKind" c:type="AsIssueKind"/>
</return-value>
<parameters>
<parameter name="kind_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-issue.c"
line="64">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="issue_kind_to_string"
c:identifier="as_issue_kind_to_string"
moved-to="IssueKind.to_string">
<doc xml:space="preserve"
filename="src/as-issue.c"
line="44">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-issue.h" line="62"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-issue.c"
line="50">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-issue.c"
line="46">the %AsIssueKind.</doc>
<type name="IssueKind" c:type="AsIssueKind"/>
</parameter>
</parameters>
</function>
<function name="issue_severity_from_string"
c:identifier="as_issue_severity_from_string"
moved-to="IssueSeverity.from_string">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="51">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-validator-issue.h" line="66"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="57">a #AsIssueSeverity, or %AS_ISSUE_SEVERITY_UNKNOWN for unknown.</doc>
<type name="IssueSeverity" c:type="AsIssueSeverity"/>
</return-value>
<parameters>
<parameter name="str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="53">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="issue_severity_to_string"
c:identifier="as_issue_severity_to_string"
moved-to="IssueSeverity.to_string">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="74">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-validator-issue.h" line="67"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="80">string version of @severity</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="severity" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator-issue.c"
line="76">the #AsIssueSeverity.</doc>
<type name="IssueSeverity" c:type="AsIssueSeverity"/>
</parameter>
</parameters>
</function>
<function name="launchable_kind_from_string"
c:identifier="as_launchable_kind_from_string"
moved-to="LaunchableKind.from_string"
version="0.11.0">
<doc xml:space="preserve"
filename="src/as-launchable.c"
line="71">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-launchable.h" line="67"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-launchable.c"
line="77">a #AsLaunchableKind or %AS_LAUNCHABLE_KIND_UNKNOWN for unknown</doc>
<type name="LaunchableKind" c:type="AsLaunchableKind"/>
</return-value>
<parameters>
<parameter name="kind_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-launchable.c"
line="73">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="launchable_kind_to_string"
c:identifier="as_launchable_kind_to_string"
moved-to="LaunchableKind.to_string"
version="0.11.0">
<doc xml:space="preserve"
filename="src/as-launchable.c"
line="47">Converts the enumerated value to a text representation.</doc>
<source-position filename="src/as-launchable.h" line="66"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-launchable.c"
line="53">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-launchable.c"
line="49">the #AsLaunchableKind.</doc>
<type name="LaunchableKind" c:type="AsLaunchableKind"/>
</parameter>
</parameters>
</function>
<function name="license_is_free_license"
c:identifier="as_license_is_free_license"
version="0.12.10">
<doc xml:space="preserve"
filename="src/as-spdx.c"
line="753">Check if the given license is for free-as-in-freedom software.
A free software license is either approved by the Free Software Foundation
or the Open Source Initiative.
This function does *not* yet handle complex license expressions with AND and OR.
If the expression contains any of these, it will still simply check if all mentioned
licenses are Free licenses.
Currently, any license exception recognized by SPDX is assumed to not impact the free-ness
status of a software component.
Please note that this function does not give any legal advice. Please read the license texts
to learn more about the individual licenses and their conditions.</doc>
<source-position filename="src/as-spdx.h" line="43"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-spdx.c"
line="770">%TRUE if the license string contains only free-as-in-freedom licenses.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="license" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-spdx.c"
line="755">The SPDX license string to test.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="license_is_metadata_license"
c:identifier="as_license_is_metadata_license">
<doc xml:space="preserve"
filename="src/as-spdx.c"
line="579">Check if the metadata license is suitable for mixing with other
metadata and redistributing the bundled result (this means we
prefer permissive licenses here, to not require people shipping
catalog metadata to perform a full license review).
This method checks against a hardcoded list of permissive licenses
commonly used to license metadata under.</doc>
<source-position filename="src/as-spdx.h" line="42"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-spdx.c"
line="591">%TRUE if the license contains only permissive licenses suitable
as metadata license.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="license" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-spdx.c"
line="581">The SPDX license string to test.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="license_is_metadata_license_id"
c:identifier="as_license_is_metadata_license_id">
<doc xml:space="preserve"
filename="src/as-spdx.c"
line="521">Tests license ID against the vetted list of licenses that
can be used for metainfo metadata.
This function will not work for license expressions, if you need
to test an SPDX license expression for compliance, please
use %as_license_is_metadata_license insread.</doc>
<source-position filename="src/as-spdx.h" line="41"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-spdx.c"
line="531">%TRUE if the string is a valid metadata license ID.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="license_id" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-spdx.c"
line="523">a single SPDX license ID, e.g. "FSFAP"</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="license_to_spdx_id"
c:identifier="as_license_to_spdx_id"
version="0.9.8">
<doc xml:space="preserve"
filename="src/as-spdx.c"
line="412">Converts a non-SPDX license into an SPDX format string where possible.</doc>
<source-position filename="src/as-spdx.h" line="39"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-spdx.c"
line="418">the best-effort SPDX license string</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<parameter name="license" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-spdx.c"
line="414">a not-quite SPDX license string, e.g. "GPLv3+"</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="markup_convert"
c:identifier="as_markup_convert"
throws="1">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="205">Converts XML description markup into other forms of text.</doc>
<source-position filename="src/as-utils.h" line="110"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="213">a newly allocated string, or %NULL on error.</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<parameter name="markup" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="207">the XML markup to transform.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="to_kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="208">The markup style to convert into.</doc>
<type name="MarkupKind" c:type="AsMarkupKind"/>
</parameter>
</parameters>
</function>
<function name="markup_strsplit_words"
c:identifier="as_markup_strsplit_words"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="89">Splits up a long line into an array of smaller strings, each being no longer
than @line_len. Words are not split.</doc>
<source-position filename="src/as-utils.h" line="109"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="97">lines, or %NULL in event of an error</doc>
<array c:type="gchar**">
<type name="utf8"/>
</array>
</return-value>
<parameters>
<parameter name="text" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="91">the text to split.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="line_len" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="92">the maximum length of the output line</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</function>
<function name="merge_kind_from_string"
c:identifier="as_merge_kind_from_string"
moved-to="MergeKind.from_string">
<doc xml:space="preserve"
filename="src/as-component.c"
line="276">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-component.h" line="135"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="282">a #AsMergeKind or %AS_MERGE_KIND_NONE for unknown</doc>
<type name="MergeKind" c:type="AsMergeKind"/>
</return-value>
<parameters>
<parameter name="kind_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="278">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="merge_kind_to_string"
c:identifier="as_merge_kind_to_string"
moved-to="MergeKind.to_string">
<doc xml:space="preserve"
filename="src/as-component.c"
line="253">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-component.h" line="134"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="259">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="255">the #AsMergeKind.</doc>
<type name="MergeKind" c:type="AsMergeKind"/>
</parameter>
</parameters>
</function>
<function name="metadata_error_quark"
c:identifier="as_metadata_error_quark"
moved-to="MetadataError.quark">
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-metadata.c"
line="1761">An error quark.</doc>
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
<function name="pool_error_quark"
c:identifier="as_pool_error_quark"
moved-to="PoolError.quark">
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-pool.c"
line="2663">An error quark.</doc>
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
<function name="provided_kind_from_string"
c:identifier="as_provided_kind_from_string"
moved-to="ProvidedKind.from_string">
<doc xml:space="preserve"
filename="src/as-provided.c"
line="87">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-provided.h" line="81"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-provided.c"
line="93">a #AsProvidedKind or %AS_PROVIDED_KIND_UNKNOWN for unknown</doc>
<type name="ProvidedKind" c:type="AsProvidedKind"/>
</return-value>
<parameters>
<parameter name="kind_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-provided.c"
line="89">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="provided_kind_to_l10n_string"
c:identifier="as_provided_kind_to_l10n_string"
moved-to="ProvidedKind.to_l10n_string">
<doc xml:space="preserve"
filename="src/as-provided.c"
line="123">Converts the enumerated value to a localized text representation,
using the plural forms (e.g. "Libraries" instead of "Library").
This can be useful when displaying provided items in GUI dialogs.</doc>
<source-position filename="src/as-provided.h" line="82"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-provided.c"
line="132">Pluralized, l10n string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-provided.c"
line="125">the #AsProvidedKind.</doc>
<type name="ProvidedKind" c:type="AsProvidedKind"/>
</parameter>
</parameters>
</function>
<function name="provided_kind_to_string"
c:identifier="as_provided_kind_to_string"
moved-to="ProvidedKind.to_string">
<doc xml:space="preserve"
filename="src/as-provided.c"
line="51">Converts the enumerated value to a text representation.</doc>
<source-position filename="src/as-provided.h" line="80"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-provided.c"
line="57">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-provided.c"
line="53">the #AsProvidedKind.</doc>
<type name="ProvidedKind" c:type="AsProvidedKind"/>
</parameter>
</parameters>
</function>
<function name="reference_kind_from_string"
c:identifier="as_reference_kind_from_string"
moved-to="ReferenceKind.from_string">
<doc xml:space="preserve"
filename="src/as-reference.c"
line="70">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-reference.h" line="64"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-reference.c"
line="76">a AsReferenceKind or %AS_REFERENCE_KIND_UNKNOWN for unknown</doc>
<type name="ReferenceKind" c:type="AsReferenceKind"/>
</return-value>
<parameters>
<parameter name="str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-reference.c"
line="72">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="reference_kind_to_string"
c:identifier="as_reference_kind_to_string"
moved-to="ReferenceKind.to_string"
version="1.0.0">
<doc xml:space="preserve"
filename="src/as-reference.c"
line="48">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-reference.h" line="63"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-reference.c"
line="54">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-reference.c"
line="50">the %AsReferenceKind.</doc>
<type name="ReferenceKind" c:type="AsReferenceKind"/>
</parameter>
</parameters>
</function>
<function name="relation_compare_from_string"
c:identifier="as_relation_compare_from_string"
moved-to="RelationCompare.from_string"
version="0.12.0">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="186">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-relation.h" line="216"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="192">a #AsRelationCompare, or %AS_RELATION_COMPARE_UNKNOWN for unknown.</doc>
<type name="RelationCompare" c:type="AsRelationCompare"/>
</return-value>
<parameters>
<parameter name="compare_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="188">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="relation_compare_to_string"
c:identifier="as_relation_compare_to_string"
moved-to="RelationCompare.to_string"
version="0.12.0">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="233">Converts the enumerated value to an text representation.
The enum is converted into a two-letter identifier ("eq", "ge", etc.)
for use in the XML representation.</doc>
<source-position filename="src/as-relation.h" line="217"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="241">string version of @compare</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="compare" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="235">the #AsRelationCompare.</doc>
<type name="RelationCompare" c:type="AsRelationCompare"/>
</parameter>
</parameters>
</function>
<function name="relation_compare_to_symbols_string"
c:identifier="as_relation_compare_to_symbols_string"
moved-to="RelationCompare.to_symbols_string"
version="0.12.0">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="263">Converts the enumerated value to an text representation.
The enum is converted into an identifier consisting of two
mathematical comparison operators ("==", ">=", etc.)
for use in the YAML representation and user interfaces.</doc>
<source-position filename="src/as-relation.h" line="218"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="272">string version of @compare</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="compare" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="265">the #AsRelationCompare.</doc>
<type name="RelationCompare" c:type="AsRelationCompare"/>
</parameter>
</parameters>
</function>
<function name="relation_error_quark"
c:identifier="as_relation_error_quark"
moved-to="RelationError.quark"
version="0.16.0">
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="68">An error quark.</doc>
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
<function name="relation_item_kind_from_string"
c:identifier="as_relation_item_kind_from_string"
moved-to="RelationItemKind.from_string"
version="0.12.0">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="152">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-relation.h" line="214"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="158">a #AsRelationItemKind or %AS_RELATION_ITEM_KIND_UNKNOWN for unknown</doc>
<type name="RelationItemKind" c:type="AsRelationItemKind"/>
</return-value>
<parameters>
<parameter name="kind_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="154">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="relation_item_kind_to_string"
c:identifier="as_relation_item_kind_to_string"
moved-to="RelationItemKind.to_string"
version="0.12.0">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="118">Converts the enumerated value to a text representation.</doc>
<source-position filename="src/as-relation.h" line="213"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="124">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="120">the #AsRelationKind.</doc>
<type name="RelationItemKind" c:type="AsRelationItemKind"/>
</parameter>
</parameters>
</function>
<function name="relation_kind_from_string"
c:identifier="as_relation_kind_from_string"
moved-to="RelationKind.from_string"
version="0.12.0">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="96">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-relation.h" line="211"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="102">a #AsRelationKind or %AS_RELATION_KIND_UNKNOWN for unknown</doc>
<type name="RelationKind" c:type="AsRelationKind"/>
</return-value>
<parameters>
<parameter name="kind_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="98">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="relation_kind_to_string"
c:identifier="as_relation_kind_to_string"
moved-to="RelationKind.to_string"
version="0.12.0">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="74">Converts the enumerated value to a text representation.</doc>
<source-position filename="src/as-relation.h" line="210"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="80">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-relation.c"
line="76">the #AsRelationKind.</doc>
<type name="RelationKind" c:type="AsRelationKind"/>
</parameter>
</parameters>
</function>
<function name="release_kind_from_string"
c:identifier="as_release_kind_from_string"
moved-to="ReleaseKind.from_string"
version="0.12.0">
<doc xml:space="preserve"
filename="src/as-release.c"
line="92">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-release.h" line="70"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="98">an #AsReleaseKind or %AS_RELEASE_KIND_UNKNOWN for unknown</doc>
<type name="ReleaseKind" c:type="AsReleaseKind"/>
</return-value>
<parameters>
<parameter name="kind_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="94">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="release_kind_to_string"
c:identifier="as_release_kind_to_string"
moved-to="ReleaseKind.to_string"
version="0.12.0">
<doc xml:space="preserve"
filename="src/as-release.c"
line="70">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-release.h" line="69"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="76">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="72">the #AsReleaseKind.</doc>
<type name="ReleaseKind" c:type="AsReleaseKind"/>
</parameter>
</parameters>
</function>
<function-macro name="release_list_index"
c:identifier="as_release_list_index"
introspectable="0">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="144">Returns the #AsRelease at the given index of the array.
This does not perform bounds checking on the given @index_,
so you are responsible for checking it against the array length.
Use %as_release_list_len to determine the amount of releases
present in the #AsReleaseList container.</doc>
<source-position filename="src/as-release-list.h" line="82"/>
<parameters>
<parameter name="rels">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="146">a #AsReleaseList</doc>
</parameter>
<parameter name="index_">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="147">the index of the #AsRelease to return</doc>
</parameter>
</parameters>
</function-macro>
<function name="release_list_kind_from_string"
c:identifier="as_release_list_kind_from_string"
moved-to="ReleaseListKind.from_string"
version="0.16.0">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="74">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-release-list.h" line="78"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="80">an #AsReleaseKind or %AS_RELEASE_KIND_UNKNOWN for unknown</doc>
<type name="ReleaseListKind" c:type="AsReleaseListKind"/>
</return-value>
<parameters>
<parameter name="kind_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="76">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="release_list_kind_to_string"
c:identifier="as_release_list_kind_to_string"
moved-to="ReleaseListKind.to_string"
version="0.16.0">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="54">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-release-list.h" line="77"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="60">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="56">the #AsReleaseKind.</doc>
<type name="ReleaseListKind" c:type="AsReleaseListKind"/>
</parameter>
</parameters>
</function>
<function-macro name="release_list_len"
c:identifier="as_release_list_len"
introspectable="0">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="159">Get the amount of release entries present.</doc>
<source-position filename="src/as-release-list.h" line="84"/>
<parameters>
<parameter name="rels">
<doc xml:space="preserve"
filename="src/as-release-list.c"
line="161">a #AsReleaseList</doc>
</parameter>
</parameters>
</function-macro>
<function name="release_url_kind_from_string"
c:identifier="as_release_url_kind_from_string"
moved-to="ReleaseUrlKind.from_string"
version="0.12.5">
<doc xml:space="preserve"
filename="src/as-release.c"
line="180">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-release.h" line="112"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="186">an #AsReleaseUrlKind or %AS_RELEASE_URL_KIND_UNKNOWN for unknown</doc>
<type name="ReleaseUrlKind" c:type="AsReleaseUrlKind"/>
</return-value>
<parameters>
<parameter name="kind_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="182">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="release_url_kind_to_string"
c:identifier="as_release_url_kind_to_string"
moved-to="ReleaseUrlKind.to_string"
version="0.12.5">
<doc xml:space="preserve"
filename="src/as-release.c"
line="162">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-release.h" line="111"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="168">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="164">the #AsReleaseUrlKind.</doc>
<type name="ReleaseUrlKind" c:type="AsReleaseUrlKind"/>
</parameter>
</parameters>
</function>
<function name="screenshot_kind_from_string"
c:identifier="as_screenshot_kind_from_string"
moved-to="ScreenshotKind.from_string">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="111">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-screenshot.h" line="83"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="117">a %AsScreenshotKind, or %AS_SCREENSHOT_KIND_UNKNOWN if not known.</doc>
<type name="ScreenshotKind" c:type="AsScreenshotKind"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="113">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="screenshot_kind_to_string"
c:identifier="as_screenshot_kind_to_string"
moved-to="ScreenshotKind.to_string">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="131">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-screenshot.h" line="84"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="137">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-screenshot.c"
line="133">the #AsScreenshotKind.</doc>
<type name="ScreenshotKind" c:type="AsScreenshotKind"/>
</parameter>
</parameters>
</function>
<function name="size_kind_from_string"
c:identifier="as_size_kind_from_string"
moved-to="SizeKind.from_string">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="70">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-artifact.h" line="67"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="76">an #AsSizeKind or %AS_SIZE_KIND_UNKNOWN for unknown</doc>
<type name="SizeKind" c:type="AsSizeKind"/>
</return-value>
<parameters>
<parameter name="size_kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="72">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="size_kind_to_string"
c:identifier="as_size_kind_to_string"
moved-to="SizeKind.to_string">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="52">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-artifact.h" line="66"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="58">string version of @size_kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="size_kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-artifact.c"
line="54">the #AsSizeKind.</doc>
<type name="SizeKind" c:type="AsSizeKind"/>
</parameter>
</parameters>
</function>
<function name="spdx_license_detokenize"
c:identifier="as_spdx_license_detokenize"
version="0.9.8">
<doc xml:space="preserve"
filename="src/as-spdx.c"
line="364">De-tokenizes the SPDX licenses into a string.</doc>
<source-position filename="src/as-spdx.h" line="37"/>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve"
filename="src/as-spdx.c"
line="370">string, or %NULL for invalid</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<parameter name="license_tokens" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-spdx.c"
line="366">license tokens, typically from as_spdx_license_tokenize()</doc>
<type name="utf8" c:type="gchar**"/>
</parameter>
</parameters>
</function>
<function name="spdx_license_tokenize"
c:identifier="as_spdx_license_tokenize"
version="0.9.8">
<doc xml:space="preserve"
filename="src/as-spdx.c"
line="304">Tokenizes the SPDX license string (or any simarly formatted string)
into parts. Any license parts of the string e.g. "LGPL-2.0+" are prefexed
with "@", the conjunctive replaced with "&", the disjunctive replaced
with "|" and the WITH operator for license exceptions replaced with "^".
Brackets are added as indervidual tokens and other strings are
appended into single tokens where possible.</doc>
<source-position filename="src/as-spdx.h" line="36"/>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve"
filename="src/as-spdx.c"
line="315">array of strings, or %NULL for invalid</doc>
<array c:type="gchar**">
<type name="utf8"/>
</array>
</return-value>
<parameters>
<parameter name="license" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-spdx.c"
line="306">a license string, e.g. "LGPLv2+ and (QPL or GPLv2) and MIT"</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="suggested_kind_from_string"
c:identifier="as_suggested_kind_from_string"
moved-to="SuggestedKind.from_string">
<doc xml:space="preserve"
filename="src/as-suggested.c"
line="64">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-suggested.h" line="63"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-suggested.c"
line="70">a #AsSuggestedKind or %AS_SUGGESTED_KIND_UNKNOWN for unknown</doc>
<type name="SuggestedKind" c:type="AsSuggestedKind"/>
</return-value>
<parameters>
<parameter name="kind_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-suggested.c"
line="66">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="suggested_kind_to_string"
c:identifier="as_suggested_kind_to_string"
moved-to="SuggestedKind.to_string">
<doc xml:space="preserve"
filename="src/as-suggested.c"
line="45">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-suggested.h" line="64"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-suggested.c"
line="51">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-suggested.c"
line="47">the %AsSuggestedKind.</doc>
<type name="SuggestedKind" c:type="AsSuggestedKind"/>
</parameter>
</parameters>
</function>
<function name="system_info_error_quark"
c:identifier="as_system_info_error_quark"
moved-to="SystemInfoError.quark"
version="0.16.0">
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-system-info.c"
line="105">An error quark.</doc>
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
<function name="translation_kind_from_string"
c:identifier="as_translation_kind_from_string"
moved-to="TranslationKind.from_string">
<doc xml:space="preserve"
filename="src/as-translation.c"
line="68">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-translation.h" line="63"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-translation.c"
line="74">a #AsTranslationKind or %AS_TRANSLATION_KIND_UNKNOWN for unknown</doc>
<type name="TranslationKind" c:type="AsTranslationKind"/>
</return-value>
<parameters>
<parameter name="kind_str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-translation.c"
line="70">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="translation_kind_to_string"
c:identifier="as_translation_kind_to_string"
moved-to="TranslationKind.to_string">
<doc xml:space="preserve"
filename="src/as-translation.c"
line="50">Converts the enumerated value to a text representation.</doc>
<source-position filename="src/as-translation.h" line="62"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-translation.c"
line="56">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-translation.c"
line="52">the #AsTranslationKind.</doc>
<type name="TranslationKind" c:type="AsTranslationKind"/>
</parameter>
</parameters>
</function>
<function name="urgency_kind_from_string"
c:identifier="as_urgency_kind_from_string"
moved-to="UrgencyKind.from_string"
version="0.6.5">
<doc xml:space="preserve"
filename="src/as-release.c"
line="138">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-release.h" line="93"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="144">a %AsUrgencyKind or %AS_URGENCY_KIND_UNKNOWN for unknown</doc>
<type name="UrgencyKind" c:type="AsUrgencyKind"/>
</return-value>
<parameters>
<parameter name="urgency_kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="140">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="urgency_kind_to_string"
c:identifier="as_urgency_kind_to_string"
moved-to="UrgencyKind.to_string"
version="0.6.5">
<doc xml:space="preserve"
filename="src/as-release.c"
line="114">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-release.h" line="92"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="120">string version of @urgency_kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="urgency_kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-release.c"
line="116">the %AsUrgencyKind.</doc>
<type name="UrgencyKind" c:type="AsUrgencyKind"/>
</parameter>
</parameters>
</function>
<function name="url_kind_from_string"
c:identifier="as_url_kind_from_string"
moved-to="UrlKind.from_string">
<doc xml:space="preserve"
filename="src/as-component.c"
line="365">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-component.h" line="187"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="371">a #AsUrlKind or %AS_URL_KIND_UNKNOWN for unknown</doc>
<type name="UrlKind" c:type="AsUrlKind"/>
</return-value>
<parameters>
<parameter name="url_kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="367">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="url_kind_to_string"
c:identifier="as_url_kind_to_string"
moved-to="UrlKind.to_string">
<doc xml:space="preserve"
filename="src/as-component.c"
line="333">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-component.h" line="186"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="339">string version of @url_kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="url_kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-component.c"
line="335">the %AsUrlKind.</doc>
<type name="UrlKind" c:type="AsUrlKind"/>
</parameter>
</parameters>
</function>
<function name="utils_build_data_id"
c:identifier="as_utils_build_data_id"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1764">Builds an identifier string unique to the individual dataset using the supplied information.</doc>
<source-position filename="src/as-utils.h" line="127"/>
<return-value transfer-ownership="full">
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<parameter name="scope" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1766">Scope of the metadata as #AsComponentScope e.g. %AS_COMPONENT_SCOPE_SYSTEM</doc>
<type name="ComponentScope" c:type="AsComponentScope"/>
</parameter>
<parameter name="bundle_kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1767">Bundling system providing this data, e.g. 'package' or 'flatpak'</doc>
<type name="BundleKind" c:type="AsBundleKind"/>
</parameter>
<parameter name="origin" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1768">Origin string, e.g. 'os' or 'gnome-apps-nightly'</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="cid" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1769">AppStream component ID, e.g. 'org.freedesktop.appstream.cli'</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="branch" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1770">Branch, e.g. '3-20' or 'master'</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="utils_data_id_equal"
c:identifier="as_utils_data_id_equal"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1920">Checks two component data IDs for equality allowing globs to match.</doc>
<source-position filename="src/as-utils.h" line="138"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1927">%TRUE if the ID's should be considered equal.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="data_id1" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1922">a data ID</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="data_id2" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1923">another data ID</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="utils_data_id_get_cid"
c:identifier="as_utils_data_id_get_cid">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1831">Get the component-id part of the data-id.</doc>
<source-position filename="src/as-utils.h" line="133"/>
<return-value transfer-ownership="full">
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<parameter name="data_id" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1833">The data-id.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="utils_data_id_hash"
c:identifier="as_utils_data_id_hash"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1942">Converts a data-id to a hash value.
This function implements the widely used DJB hash on the ID subset of the
data-id string.
It can be passed to g_hash_table_new() as the hash_func parameter,
when using non-NULL strings or unique_ids as keys in a GHashTable.</doc>
<source-position filename="src/as-utils.h" line="139"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1954">a hash value corresponding to the key</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<parameter name="data_id" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1944">a data ID</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="utils_data_id_match"
c:identifier="as_utils_data_id_match"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1863">Checks two data IDs for equality allowing globs to match, whilst also
allowing clients to whitelist sections that have to match.</doc>
<source-position filename="src/as-utils.h" line="135"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1872">%TRUE if the IDs should be considered equal.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="data_id1" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1865">a data ID</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="data_id2" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1866">another data ID</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="match_flags" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1867">a #AsDataIdMatchFlags bitfield, e.g. %AS_DATA_ID_MATCH_FLAG_ID</doc>
<type name="DataIdMatchFlags" c:type="AsDataIdMatchFlags"/>
</parameter>
</parameters>
</function>
<function name="utils_data_id_valid"
c:identifier="as_utils_data_id_valid"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1806">Checks if a data ID is valid i.e. has the correct number of
sections.</doc>
<source-position filename="src/as-utils.h" line="132"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1813">%TRUE if the ID is valid</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="data_id" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1808">a component data ID</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="utils_error_quark"
c:identifier="as_utils_error_quark"
moved-to="UtilsError.quark"
version="0.14.0">
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="64">An error quark.</doc>
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
<function name="utils_get_desktop_environment_name"
c:identifier="as_utils_get_desktop_environment_name"
version="1.0.0">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1428">Get a human-readable, translated name of the desktop environment
represented by the given ID.</doc>
<source-position filename="src/as-utils.h" line="119"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1435">A localized name of the DE, or %NULL if none available.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="de_id" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1430">a desktop environment id.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="utils_get_gui_environment_style_name"
c:identifier="as_utils_get_gui_environment_style_name"
version="1.0.0">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1479">Get a human-readable, translated name of the combination
of GUI environment and style. E.g. "plasma:dark" becomes "Plasma (Dark)".</doc>
<source-position filename="src/as-utils.h" line="121"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1486">A localized name of the environment style, or %NULL if none available.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="env_style" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1481">a GUI environment style ID, e.g. "pantheon:dark"</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="utils_get_tag_search_weight"
c:identifier="as_utils_get_tag_search_weight">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="2945">Retrieve the raw search token weight for the given tag name that AppStream uses
internally for searching.
This can be used to implement separate, but compatible search logic.</doc>
<source-position filename="src/as-utils.h" line="153"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="2953">The tag weight used in (fulltext) searches. 0 for lowest weight/unused.</doc>
<type name="guint16" c:type="guint16"/>
</return-value>
<parameters>
<parameter name="tag_name" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="2947">A tag name in a component element, e.g. "name" or "summary" or "keyword"</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="utils_guess_scope_from_path"
c:identifier="as_utils_guess_scope_from_path"
version="0.15.0">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="2912">Guess the #AsComponentScope that applies to a given path.</doc>
<source-position filename="src/as-utils.h" line="151"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="2918">the #AsComponentScope</doc>
<type name="ComponentScope" c:type="AsComponentScope"/>
</return-value>
<parameters>
<parameter name="path" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="2914">The filename to test.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="utils_install_metadata_file"
c:identifier="as_utils_install_metadata_file"
version="0.14.0"
throws="1">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="2534">Installs an AppStream MetaInfo, AppStream Metadata Catalog or AppStream Icon tarball file
to the right place on the filesystem.
Please note that this function does almost no validation and may guess missing values such
as icon sizes and origin names.
Ensure your metadata is good before installing it.</doc>
<source-position filename="src/as-utils.h" line="145"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="2548">%TRUE for success, %FALSE if error is set</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="location" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="2536">the #AsMetadataLocation, e.g. %AS_METADATA_LOCATION_CACHE</doc>
<type name="MetadataLocation" c:type="AsMetadataLocation"/>
</parameter>
<parameter name="filename" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="2537">the full path of the file to install</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="origin" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="2538">the origin to use for the installation, or %NULL</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="destdir" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="2539">the destdir to use, or %NULL</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="utils_is_category_name"
c:identifier="as_utils_is_category_name"
version="0.9.7">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1281">Searches the known list of registered XDG category names.
See https://specifications.freedesktop.org/menu-spec/latest/category-registry.html
for a reference.</doc>
<source-position filename="src/as-utils.h" line="115"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1289">%TRUE if the category name is valid</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="category_name" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1283">a XDG category name, e.g. "ProjectManagement"</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="utils_is_desktop_environment"
c:identifier="as_utils_is_desktop_environment"
version="0.10.0">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1402">Checks if the submitted desktop environment ID is
known and valid.</doc>
<source-position filename="src/as-utils.h" line="118"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1409">%TRUE if the desktop-id is valid</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="de_id" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1404">a desktop environment id.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="utils_is_gui_environment_style"
c:identifier="as_utils_is_gui_environment_style"
version="1.0.0">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1454">Checks if the given identifier is a valid, known GUI environment style.</doc>
<source-position filename="src/as-utils.h" line="120"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1460">%TRUE if the environment-style ID is is valid</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="env_style" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1456">a GUI environment style ID, e.g. "pantheon:dark"</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="utils_is_platform_triplet"
c:identifier="as_utils_is_platform_triplet"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1631">Test if the given string is a valid platform triplet recognized by
AppStream.</doc>
<source-position filename="src/as-utils.h" line="143"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1638">%TRUE if triplet is valid.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="triplet" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1633">a platform triplet.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="utils_is_tld"
c:identifier="as_utils_is_tld"
version="0.9.8">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1369">Searches the known list of TLDs we allow for AppStream IDs.
This excludes internationalized names.</doc>
<source-position filename="src/as-utils.h" line="116"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1376">%TRUE if the TLD is valid</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="tld" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1371">a top-level domain without dot, e.g. "de", "org", "name"</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="utils_locale_is_compatible"
c:identifier="as_utils_locale_is_compatible"
version="0.9.5">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1214">Calculates if one locale is compatible with another.
When doing the calculation the locale and language code is taken into
account if possible.</doc>
<source-position filename="src/as-utils.h" line="112"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1223">%TRUE if the locale is compatible.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="locale1"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1216">a BCP47 or POSIX locale string, or %NULL</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="locale2"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1217">a BCP47 or POSIX locale string, or %NULL</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="utils_posix_locale_to_bcp47"
c:identifier="as_utils_posix_locale_to_bcp47">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="723">Converts a POSIX locale string to the corresponding IETF BCP47 format.
If the given locale is already in BCP47 format, no change will be done.</doc>
<source-position filename="src/as-utils.h" line="113"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="729">A locale string, free with g_free()</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<parameter name="locale" transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="utils_sort_components_into_categories"
c:identifier="as_utils_sort_components_into_categories">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1700">Sorts all components in @cpts into the #AsCategory categories listed in @categories.</doc>
<source-position filename="src/as-utils.h" line="123"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="cpts" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1702">List of components.</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="Component"/>
</array>
</parameter>
<parameter name="categories" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1703">List of categories to sort components into.</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="Category"/>
</array>
</parameter>
<parameter name="check_duplicates" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-utils.c"
line="1704">Whether to check for duplicates.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</function>
<function name="validator_error_quark"
c:identifier="as_validator_error_quark"
moved-to="ValidatorError.quark"
version="0.15.4">
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-validator.c"
line="77">An error quark.</doc>
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
<function name="vercmp" c:identifier="as_vercmp">
<doc xml:space="preserve"
filename="src/as-vercmp.c"
line="144">Compare alpha and numeric segments of two software versions,
considering @flags.</doc>
<source-position filename="src/as-vercmp.h" line="45"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-vercmp.c"
line="153">an integer > 0 if a is newer than b;
0 if a and b are the same version;
< 0 if b is newer than a</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<parameter name="a" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-vercmp.c"
line="146">First version number</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="b" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-vercmp.c"
line="147">Second version number</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-vercmp.c"
line="148">Flags, e.g. %AS_VERCMP_FLAG_NONE</doc>
<type name="VercmpFlags" c:type="AsVercmpFlags"/>
</parameter>
</parameters>
</function>
<function name="vercmp_simple" c:identifier="as_vercmp_simple">
<doc xml:space="preserve"
filename="src/as-vercmp.c"
line="208">Compare alpha and numeric segments of two software versions.</doc>
<source-position filename="src/as-vercmp.h" line="46"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-vercmp.c"
line="215">an integer > 0 if a is newer than b;
0 if a and b are the same version;
< 0 if b is newer than a</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<parameter name="a" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-vercmp.c"
line="210">First version number</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="b" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-vercmp.c"
line="211">Second version number</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="vercmp_test_match"
c:identifier="as_vercmp_test_match"
version="0.16.0">
<doc xml:space="preserve"
filename="src/as-vercmp.c"
line="225">Compare two version numbers and check if the given version comparator matches.</doc>
<source-position filename="src/as-vercmp.h" line="48"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-vercmp.c"
line="234">%TRUE if the version comparison matches, %FALSE otherwise.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="ver1" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-vercmp.c"
line="227">first version number</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="compare" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-vercmp.c"
line="228">the comparison operator</doc>
<type name="RelationCompare" c:type="AsRelationCompare"/>
</parameter>
<parameter name="ver2" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-vercmp.c"
line="229">second version number</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-vercmp.c"
line="230">the #AsVercmpFlags to use</doc>
<type name="VercmpFlags" c:type="AsVercmpFlags"/>
</parameter>
</parameters>
</function>
<function name="version_string"
c:identifier="as_version_string"
version="0.14.0">
<doc xml:space="preserve"
filename="src/as-version.c"
line="40">Get the version of the AppStream library that is currently used
at runtime as a string.</doc>
<source-position filename="src/as-version.h" line="47"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-version.c"
line="46">a version number, e.g. "0.14.2"</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
</function>
<function name="video_codec_kind_from_string"
c:identifier="as_video_codec_kind_from_string"
moved-to="VideoCodecKind.from_string">
<doc xml:space="preserve"
filename="src/as-video.c"
line="73">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-video.h" line="78"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-video.c"
line="79">a #AsVideoCodecKind, or %AS_VIDEO_CODEC_KIND_UNKNOWN for unknown.</doc>
<type name="VideoCodecKind" c:type="AsVideoCodecKind"/>
</return-value>
<parameters>
<parameter name="str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-video.c"
line="75">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="video_codec_kind_to_string"
c:identifier="as_video_codec_kind_to_string"
moved-to="VideoCodecKind.to_string">
<doc xml:space="preserve"
filename="src/as-video.c"
line="92">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-video.h" line="79"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-video.c"
line="98">string version of @codec</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-video.c"
line="94">the #AsVideoCodecKind.</doc>
<type name="VideoCodecKind" c:type="AsVideoCodecKind"/>
</parameter>
</parameters>
</function>
<function name="video_container_kind_from_string"
c:identifier="as_video_container_kind_from_string"
moved-to="VideoContainerKind.from_string">
<doc xml:space="preserve"
filename="src/as-video.c"
line="111">Converts the text representation to an enumerated value.</doc>
<source-position filename="src/as-video.h" line="81"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/as-video.c"
line="117">a #AsVideoContainerKind, or %AS_VIDEO_CONTAINER_KIND_UNKNOWN for unknown.</doc>
<type name="VideoContainerKind" c:type="AsVideoContainerKind"/>
</return-value>
<parameters>
<parameter name="str" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-video.c"
line="113">the string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="video_container_kind_to_string"
c:identifier="as_video_container_kind_to_string"
moved-to="VideoContainerKind.to_string">
<doc xml:space="preserve"
filename="src/as-video.c"
line="132">Converts the enumerated value to an text representation.</doc>
<source-position filename="src/as-video.h" line="82"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-video.c"
line="138">string version of @kind</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="kind" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/as-video.c"
line="134">the #AsVideoContainerKind.</doc>
<type name="VideoContainerKind" c:type="AsVideoContainerKind"/>
</parameter>
</parameters>
</function>
</namespace>
</repository>