<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
]>
<refentry id="appstream-as-enums">
<refmeta>
<refentrytitle role="top_of_page" id="appstream-as-enums.top_of_page">as-enums</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>APPSTREAM Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>as-enums</refname>
<refpurpose>Some enums used by various other modules</refpurpose>
</refnamediv>

<refsect1 id="appstream-as-enums.functions" role="functions_proto">
<title role="functions_proto.title">Functions</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="functions_return" colwidth="150px"/>
<colspec colname="functions_name"/>
<tbody>
<row><entry role="function_type">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="as-url-kind-to-string">as_url_kind_to_string</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="AsUrlKind"><returnvalue>AsUrlKind</returnvalue></link>
</entry><entry role="function_name"><link linkend="as-url-kind-from-string">as_url_kind_from_string</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="as-bundle-kind-to-string">as_bundle_kind_to_string</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="AsBundleKind"><returnvalue>AsBundleKind</returnvalue></link>
</entry><entry role="function_name"><link linkend="as-bundle-kind-from-string">as_bundle_kind_from_string</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="as-urgency-kind-to-string">as_urgency_kind_to_string</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="AsUrgencyKind"><returnvalue>AsUrgencyKind</returnvalue></link>
</entry><entry role="function_name"><link linkend="as-urgency-kind-from-string">as_urgency_kind_from_string</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="appstream-as-enums.other" role="other_proto">
<title role="other_proto.title">Types and Values</title>
<informaltable role="enum_members_table" pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="name" colwidth="150px"/>
<colspec colname="description"/>
<tbody>
<row><entry role="datatype_keyword">enum</entry><entry role="function_name"><link linkend="AsUrlKind">AsUrlKind</link></entry></row>
<row><entry role="datatype_keyword">enum</entry><entry role="function_name"><link linkend="AsBundleKind">AsBundleKind</link></entry></row>
<row><entry role="datatype_keyword">enum</entry><entry role="function_name"><link linkend="AsUrgencyKind">AsUrgencyKind</link></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>

<refsect1 id="appstream-as-enums.includes"><title>Includes</title><synopsis>#include &lt;appstream.h&gt;
</synopsis></refsect1>

<refsect1 id="appstream-as-enums.description" role="desc">
<title role="desc.title">Description</title>

</refsect1>
<refsect1 id="appstream-as-enums.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="as-url-kind-to-string" role="function">
<title>as_url_kind_to_string&#160;()</title>
<indexterm zone="as-url-kind-to-string"><primary>as_url_kind_to_string</primary></indexterm>
<programlisting language="C">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
as_url_kind_to_string (<parameter><link linkend="AsUrlKind"><type>AsUrlKind</type></link> url_kind</parameter>);</programlisting>
<para>Converts the enumerated value to an text representation.</para>
<refsect3 role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>url_kind</para></entry>
<entry role="parameter_description"><para>the <link linkend="AsUrlKind"><literal>AsUrlKind</literal></link>.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 role="returns">
<title>Returns</title>
<para> string version of <parameter>url_kind</parameter>
</para>
</refsect3></refsect2>
<refsect2 id="as-url-kind-from-string" role="function">
<title>as_url_kind_from_string&#160;()</title>
<indexterm zone="as-url-kind-from-string"><primary>as_url_kind_from_string</primary></indexterm>
<programlisting language="C"><link linkend="AsUrlKind"><returnvalue>AsUrlKind</returnvalue></link>
as_url_kind_from_string (<parameter>const <link linkend="gchar"><type>gchar</type></link> *url_kind</parameter>);</programlisting>
<para>Converts the text representation to an enumerated value.</para>
<refsect3 role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>url_kind</para></entry>
<entry role="parameter_description"><para>the string.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 role="returns">
<title>Returns</title>
<para> a <link linkend="AsUrlKind"><type>AsUrlKind</type></link> or <link linkend="AS-URL-KIND-UNKNOWN:CAPS"><literal>AS_URL_KIND_UNKNOWN</literal></link> for unknown</para>
</refsect3></refsect2>
<refsect2 id="as-bundle-kind-to-string" role="function" condition="since:0.8.0">
<title>as_bundle_kind_to_string&#160;()</title>
<indexterm zone="as-bundle-kind-to-string" role="0.8.0"><primary>as_bundle_kind_to_string</primary></indexterm>
<programlisting language="C">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
as_bundle_kind_to_string (<parameter><link linkend="AsBundleKind"><type>AsBundleKind</type></link> bundle_kind</parameter>);</programlisting>
<para>Converts the enumerated value to an text representation.</para>
<refsect3 role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>bundle_kind</para></entry>
<entry role="parameter_description"><para>the <link linkend="AsBundleKind"><literal>AsBundleKind</literal></link>.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 role="returns">
<title>Returns</title>
<para> string version of <parameter>bundle_kind</parameter>
</para>
</refsect3><para role="since">Since: <link linkend="api-index-0.8.0">0.8.0</link></para></refsect2>
<refsect2 id="as-bundle-kind-from-string" role="function">
<title>as_bundle_kind_from_string&#160;()</title>
<indexterm zone="as-bundle-kind-from-string"><primary>as_bundle_kind_from_string</primary></indexterm>
<programlisting language="C"><link linkend="AsBundleKind"><returnvalue>AsBundleKind</returnvalue></link>
as_bundle_kind_from_string (<parameter>const <link linkend="gchar"><type>gchar</type></link> *bundle_kind</parameter>);</programlisting>
<para>Converts the text representation to an enumerated value.</para>
<refsect3 role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>bundle_kind</para></entry>
<entry role="parameter_description"><para>the string.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 role="returns">
<title>Returns</title>
<para> a <link linkend="AsBundleKind"><type>AsBundleKind</type></link> or <link linkend="AS-BUNDLE-KIND-UNKNOWN:CAPS"><literal>AS_BUNDLE_KIND_UNKNOWN</literal></link> for unknown</para>
</refsect3></refsect2>
<refsect2 id="as-urgency-kind-to-string" role="function" condition="since:0.6.5">
<title>as_urgency_kind_to_string&#160;()</title>
<indexterm zone="as-urgency-kind-to-string" role="0.6.5"><primary>as_urgency_kind_to_string</primary></indexterm>
<programlisting language="C">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
as_urgency_kind_to_string (<parameter><link linkend="AsUrgencyKind"><type>AsUrgencyKind</type></link> urgency_kind</parameter>);</programlisting>
<para>Converts the enumerated value to an text representation.</para>
<refsect3 role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>urgency_kind</para></entry>
<entry role="parameter_description"><para>the <link linkend="AsUrgencyKind"><literal>AsUrgencyKind</literal></link>.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 role="returns">
<title>Returns</title>
<para> string version of <parameter>urgency_kind</parameter>
</para>
</refsect3><para role="since">Since: <link linkend="api-index-0.6.5">0.6.5</link></para></refsect2>
<refsect2 id="as-urgency-kind-from-string" role="function" condition="since:0.6.5">
<title>as_urgency_kind_from_string&#160;()</title>
<indexterm zone="as-urgency-kind-from-string" role="0.6.5"><primary>as_urgency_kind_from_string</primary></indexterm>
<programlisting language="C"><link linkend="AsUrgencyKind"><returnvalue>AsUrgencyKind</returnvalue></link>
as_urgency_kind_from_string (<parameter>const <link linkend="gchar"><type>gchar</type></link> *urgency_kind</parameter>);</programlisting>
<para>Converts the text representation to an enumerated value.</para>
<refsect3 role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>urgency_kind</para></entry>
<entry role="parameter_description"><para>the string.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 role="returns">
<title>Returns</title>
<para> a <link linkend="AsUrgencyKind"><literal>AsUrgencyKind</literal></link> or <link linkend="AS-URGENCY-KIND-UNKNOWN:CAPS"><literal>AS_URGENCY_KIND_UNKNOWN</literal></link> for unknown</para>
</refsect3><para role="since">Since: <link linkend="api-index-0.6.5">0.6.5</link></para></refsect2>

</refsect1>
<refsect1 id="appstream-as-enums.other_details" role="details">
<title role="details.title">Types and Values</title>
<refsect2 id="AsUrlKind" role="enum">
<title>enum AsUrlKind</title>
<indexterm zone="AsUrlKind"><primary>AsUrlKind</primary></indexterm>
<para>The URL type.</para>
<refsect3 role="enum_members">
<title>Members</title>
<informaltable role="enum_members_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="enum_members_name" colwidth="300px"/>
<colspec colname="enum_members_description"/>
<colspec colname="enum_members_annotations" colwidth="200px"/>
<tbody>
<row role="constant"><entry role="enum_member_name"><para id="AS-URL-KIND-UNKNOWN:CAPS">AS_URL_KIND_UNKNOWN</para></entry>
<entry role="enum_member_description"><para>Type invalid or not known</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="AS-URL-KIND-HOMEPAGE:CAPS">AS_URL_KIND_HOMEPAGE</para></entry>
<entry role="enum_member_description"><para>Project homepage</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="AS-URL-KIND-BUGTRACKER:CAPS">AS_URL_KIND_BUGTRACKER</para></entry>
<entry role="enum_member_description"><para>Bugtracker</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="AS-URL-KIND-FAQ:CAPS">AS_URL_KIND_FAQ</para></entry>
<entry role="enum_member_description"><para>FAQ page</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="AS-URL-KIND-HELP:CAPS">AS_URL_KIND_HELP</para></entry>
<entry role="enum_member_description"><para>Help manual</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="AS-URL-KIND-DONATION:CAPS">AS_URL_KIND_DONATION</para></entry>
<entry role="enum_member_description"><para>Page with information about how to donate to the project</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="AsBundleKind" role="enum">
<title>enum AsBundleKind</title>
<indexterm zone="AsBundleKind"><primary>AsBundleKind</primary></indexterm>
<para>The bundle type.</para>
<refsect3 role="enum_members">
<title>Members</title>
<informaltable role="enum_members_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="enum_members_name" colwidth="300px"/>
<colspec colname="enum_members_description"/>
<colspec colname="enum_members_annotations" colwidth="200px"/>
<tbody>
<row role="constant"><entry role="enum_member_name"><para id="AS-BUNDLE-KIND-UNKNOWN:CAPS">AS_BUNDLE_KIND_UNKNOWN</para></entry>
<entry role="enum_member_description"><para>Type invalid or not known</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="AS-BUNDLE-KIND-LIMBA:CAPS">AS_BUNDLE_KIND_LIMBA</para></entry>
<entry role="enum_member_description"><para>A Limba bundle</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="AS-BUNDLE-KIND-XDG-APP:CAPS">AS_BUNDLE_KIND_XDG_APP</para></entry>
<entry role="enum_member_description"><para>An xdg-app bundle</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="AsUrgencyKind" role="enum">
<title>enum AsUrgencyKind</title>
<indexterm zone="AsUrgencyKind"><primary>AsUrgencyKind</primary></indexterm>
<para>The urgency of an <link linkend="AsRelease"><type>AsRelease</type></link></para>
<refsect3 role="enum_members">
<title>Members</title>
<informaltable role="enum_members_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="enum_members_name" colwidth="300px"/>
<colspec colname="enum_members_description"/>
<colspec colname="enum_members_annotations" colwidth="200px"/>
<tbody>
<row role="constant"><entry role="enum_member_name"><para id="AS-URGENCY-KIND-UNKNOWN:CAPS">AS_URGENCY_KIND_UNKNOWN</para></entry>
<entry role="enum_member_description"><para>Urgency is unknown or not set</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="AS-URGENCY-KIND-LOW:CAPS">AS_URGENCY_KIND_LOW</para></entry>
<entry role="enum_member_description"><para>Low urgency</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="AS-URGENCY-KIND-MEDIUM:CAPS">AS_URGENCY_KIND_MEDIUM</para></entry>
<entry role="enum_member_description"><para>Medium urgency</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="AS-URGENCY-KIND-HIGH:CAPS">AS_URGENCY_KIND_HIGH</para></entry>
<entry role="enum_member_description"><para>High urgency</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="AS-URGENCY-KIND-CRITICAL:CAPS">AS_URGENCY_KIND_CRITICAL</para></entry>
<entry role="enum_member_description"><para>Critical urgency</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>

</refsect1>

</refentry>
