<?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="AsBundle">
<refmeta>
<refentrytitle role="top_of_page" id="AsBundle.top_of_page">AsBundle</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>APPSTREAM Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>AsBundle</refname>
<refpurpose>Description of bundles the <link linkend="AsComponent"><type>AsComponent</type></link> is shipped with.</refpurpose>
</refnamediv>

<refsect1 id="AsBundle.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-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"><link linkend="AsBundle"><returnvalue>AsBundle</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="as-bundle-new">as_bundle_new</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-get-kind">as_bundle_get_kind</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="as-bundle-set-kind">as_bundle_set_kind</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-get-id">as_bundle_get_id</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="as-bundle-set-id">as_bundle_set_id</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="AsBundle.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="define_keyword">#define</entry><entry role="function_name"><link linkend="AS-TYPE-BUNDLE:CAPS">AS_TYPE_BUNDLE</link></entry></row>
<row><entry role="datatype_keyword">struct</entry><entry role="function_name"><link linkend="AsBundleClass">AsBundleClass</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"></entry><entry role="function_name"><link linkend="AsBundle-struct">AsBundle</link></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="AsBundle.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<screen>    <link linkend="GObject">GObject</link>
    <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> AsBundle
</screen>
</refsect1>

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

<refsect1 id="AsBundle.description" role="desc">
<title role="desc.title">Description</title>
<para>This class provides information contained in an AppStream bundle tag.
See https://www.freedesktop.org/software/appstream/docs/chap-CollectionData.html<link linkend="tag-ct-bundle"><type>tag-ct-bundle</type></link>
for more information.</para>
<para>See also: <link linkend="AsComponent"><type>AsComponent</type></link></para>

</refsect1>
<refsect1 id="AsBundle.functions_details" role="details">
<title role="details.title">Functions</title>
<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> kind</parameter>);</programlisting>
<para>Converts the enumerated value to an text representation.</para>
<refsect3 id="as-bundle-kind-to-string.parameters" 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>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 id="as-bundle-kind-to-string.returns" role="returns">
<title>Returns</title>
<para> string version of <parameter>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_str</parameter>);</programlisting>
<para>Converts the text representation to an enumerated value.</para>
<refsect3 id="as-bundle-kind-from-string.parameters" 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_str</para></entry>
<entry role="parameter_description"><para>the string.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="as-bundle-kind-from-string.returns" 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-bundle-new" role="function" condition="since:0.10">
<title>as_bundle_new&#160;()</title>
<indexterm zone="as-bundle-new" role="0.10"><primary>as_bundle_new</primary></indexterm>
<programlisting language="C"><link linkend="AsBundle"><returnvalue>AsBundle</returnvalue></link>&#160;*
as_bundle_new (<parameter><type>void</type></parameter>);</programlisting>
<para>Creates a new <link linkend="AsBundle"><type>AsBundle</type></link>.</para>
<refsect3 id="as-bundle-new.returns" role="returns">
<title>Returns</title>
<para> a <link linkend="AsBundle"><type>AsBundle</type></link>. </para>
<para><emphasis role="annotation">[<acronym>transfer full</acronym>]</emphasis></para>
</refsect3><para role="since">Since: <link linkend="api-index-0.10">0.10</link></para></refsect2>
<refsect2 id="as-bundle-get-kind" role="function" condition="since:0.10">
<title>as_bundle_get_kind&#160;()</title>
<indexterm zone="as-bundle-get-kind" role="0.10"><primary>as_bundle_get_kind</primary></indexterm>
<programlisting language="C"><link linkend="AsBundleKind"><returnvalue>AsBundleKind</returnvalue></link>
as_bundle_get_kind (<parameter><link linkend="AsBundle"><type>AsBundle</type></link> *bundle</parameter>);</programlisting>
<para>Gets the bundle kind.</para>
<refsect3 id="as-bundle-get-kind.parameters" 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</para></entry>
<entry role="parameter_description"><para>an <link linkend="AsBundle"><type>AsBundle</type></link> instance.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="as-bundle-get-kind.returns" role="returns">
<title>Returns</title>
<para> the <link linkend="AsBundleKind"><type>AsBundleKind</type></link></para>
</refsect3><para role="since">Since: <link linkend="api-index-0.10">0.10</link></para></refsect2>
<refsect2 id="as-bundle-set-kind" role="function" condition="since:0.10">
<title>as_bundle_set_kind&#160;()</title>
<indexterm zone="as-bundle-set-kind" role="0.10"><primary>as_bundle_set_kind</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
as_bundle_set_kind (<parameter><link linkend="AsBundle"><type>AsBundle</type></link> *bundle</parameter>,
                    <parameter><link linkend="AsBundleKind"><type>AsBundleKind</type></link> kind</parameter>);</programlisting>
<para>Sets the bundle kind.</para>
<refsect3 id="as-bundle-set-kind.parameters" 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</para></entry>
<entry role="parameter_description"><para>an <link linkend="AsBundle"><type>AsBundle</type></link> instance.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>kind</para></entry>
<entry role="parameter_description"><para>the <link linkend="AsBundleKind"><type>AsBundleKind</type></link>, e.g. <link linkend="AS-BUNDLE-KIND-LIMBA:CAPS"><literal>AS_BUNDLE_KIND_LIMBA</literal></link>.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><para role="since">Since: <link linkend="api-index-0.10">0.10</link></para></refsect2>
<refsect2 id="as-bundle-get-id" role="function" condition="since:0.10">
<title>as_bundle_get_id&#160;()</title>
<indexterm zone="as-bundle-get-id" role="0.10"><primary>as_bundle_get_id</primary></indexterm>
<programlisting language="C">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
as_bundle_get_id (<parameter><link linkend="AsBundle"><type>AsBundle</type></link> *bundle</parameter>);</programlisting>
<para>Gets the ID for this bundle.</para>
<refsect3 id="as-bundle-get-id.parameters" 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</para></entry>
<entry role="parameter_description"><para>an <link linkend="AsBundle"><type>AsBundle</type></link> instance.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="as-bundle-get-id.returns" role="returns">
<title>Returns</title>
<para> ID, e.g. "foobar-1.0.2"</para>
</refsect3><para role="since">Since: <link linkend="api-index-0.10">0.10</link></para></refsect2>
<refsect2 id="as-bundle-set-id" role="function" condition="since:0.10">
<title>as_bundle_set_id&#160;()</title>
<indexterm zone="as-bundle-set-id" role="0.10"><primary>as_bundle_set_id</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
as_bundle_set_id (<parameter><link linkend="AsBundle"><type>AsBundle</type></link> *bundle</parameter>,
                  <parameter>const <link linkend="gchar"><type>gchar</type></link> *id</parameter>);</programlisting>
<para>Sets the ID for this bundle.</para>
<refsect3 id="as-bundle-set-id.parameters" 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</para></entry>
<entry role="parameter_description"><para>an <link linkend="AsBundle"><type>AsBundle</type></link> instance.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>id</para></entry>
<entry role="parameter_description"><para>the URL.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><para role="since">Since: <link linkend="api-index-0.10">0.10</link></para></refsect2>

</refsect1>
<refsect1 id="AsBundle.other_details" role="details">
<title role="details.title">Types and Values</title>
<refsect2 id="AS-TYPE-BUNDLE:CAPS" role="macro">
<title>AS_TYPE_BUNDLE</title>
<indexterm zone="AS-TYPE-BUNDLE:CAPS"><primary>AS_TYPE_BUNDLE</primary></indexterm>
<programlisting language="C">#define AS_TYPE_BUNDLE (as_bundle_get_type ())
</programlisting>
<para>
</para>
</refsect2>
<refsect2 id="AsBundleClass" role="struct">
<title>struct AsBundleClass</title>
<indexterm zone="AsBundleClass"><primary>AsBundleClass</primary></indexterm>
<programlisting language="C">struct AsBundleClass {
	GObjectClass parent_class;
};
</programlisting>
<para>
</para>
</refsect2>
<refsect2 id="AsBundleKind" role="enum">
<title>enum AsBundleKind</title>
<indexterm zone="AsBundleKind"><primary>AsBundleKind</primary></indexterm>
<para>The bundle type.</para>
<refsect3 id="AsBundleKind.members" 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-PACKAGE:CAPS">AS_BUNDLE_KIND_PACKAGE</para></entry>
<entry role="enum_member_description"><para>A native package (currently not used)</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-FLATPAK:CAPS">AS_BUNDLE_KIND_FLATPAK</para></entry>
<entry role="enum_member_description"><para>A Flatpak bundle</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="AS-BUNDLE-KIND-APPIMAGE:CAPS">AS_BUNDLE_KIND_APPIMAGE</para></entry>
<entry role="enum_member_description"><para>An AppImageKit bundle</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="AsBundle-struct" role="struct">
<title>AsBundle</title>
<indexterm zone="AsBundle-struct"><primary>AsBundle</primary></indexterm>
<programlisting language="C">typedef struct _AsBundle AsBundle;</programlisting>
<para>
</para>
</refsect2>

</refsect1>

</refentry>
