<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AsValidator: AppStream Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="AppStream Library Reference Manual">
<link rel="up" href="ch01.html" title="AppStream API Reference">
<link rel="prev" href="appstream-AsCategory.html" title="AsCategory">
<link rel="next" href="appstream-AsValidatorIssue.html" title="AsValidatorIssue">
<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#appstream-AsValidator.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="appstream-AsCategory.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="appstream-AsValidatorIssue.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="appstream-AsValidator"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="appstream-AsValidator.top_of_page"></a>AsValidator</span></h2>
<p>AsValidator — Validator and report-generator about AppStream XML metadata</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="appstream-AsValidator.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="appstream-AsValidator.html#AsValidator" title="AsValidator"><span class="returnvalue">AsValidator</span></a> *
</td>
<td class="function_name">
<a class="link" href="appstream-AsValidator.html#as-validator-new" title="as_validator_new ()">as_validator_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="appstream-AsValidator.html#as-validator-clear-issues" title="as_validator_clear_issues ()">as_validator_clear_issues</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="appstream-AsValidator.html#as-validator-validate-file" title="as_validator_validate_file ()">as_validator_validate_file</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="appstream-AsValidator.html#as-validator-validate-data" title="as_validator_validate_data ()">as_validator_validate_data</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="appstream-AsValidator.html#as-validator-validate-tree" title="as_validator_validate_tree ()">as_validator_validate_tree</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
</td>
<td class="function_name">
<a class="link" href="appstream-AsValidator.html#as-validator-get-issues" title="as_validator_get_issues ()">as_validator_get_issues</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="appstream-AsValidator.html#as-validator-get-check-urls" title="as_validator_get_check_urls ()">as_validator_get_check_urls</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="appstream-AsValidator.html#as-validator-set-check-urls" title="as_validator_set_check_urls ()">as_validator_set_check_urls</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="appstream-AsValidator.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="appstream-AsValidator.html#AS-TYPE-VALIDATOR:CAPS" title="AS_TYPE_VALIDATOR">AS_TYPE_VALIDATOR</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="appstream-AsValidator.html#AsValidatorClass" title="struct AsValidatorClass">AsValidatorClass</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="appstream-AsValidator.html#AsValidator" title="AsValidator">AsValidator</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="appstream-AsValidator.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <appstream.h>
</pre>
</div>
<div class="refsect1">
<a name="appstream-AsValidator.description"></a><h2>Description</h2>
<p>This object is able to validate AppStream XML metadata (collection and metainfo)
and to generate a report about issues found with it.</p>
<p>See also: <a class="link" href="appstream-AsMetadata.html#AsMetadata" title="AsMetadata"><span class="type">AsMetadata</span></a></p>
</div>
<div class="refsect1">
<a name="appstream-AsValidator.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="as-validator-new"></a><h3>as_validator_new ()</h3>
<pre class="programlisting"><a class="link" href="appstream-AsValidator.html#AsValidator" title="AsValidator"><span class="returnvalue">AsValidator</span></a> *
as_validator_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="appstream-AsValidator.html#AsValidator" title="AsValidator"><span class="type">AsValidator</span></a>.</p>
<div class="refsect3">
<a name="as-validator-new.returns"></a><h4>Returns</h4>
<p> an <a class="link" href="appstream-AsValidator.html#AsValidator" title="AsValidator"><span class="type">AsValidator</span></a>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="as-validator-clear-issues"></a><h3>as_validator_clear_issues ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
as_validator_clear_issues (<em class="parameter"><code><a class="link" href="appstream-AsValidator.html#AsValidator" title="AsValidator"><span class="type">AsValidator</span></a> *validator</code></em>);</pre>
<p>Clears the list of issues</p>
<div class="refsect3">
<a name="as-validator-clear-issues.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>validator</p></td>
<td class="parameter_description"><p>An instance of <a class="link" href="appstream-AsValidator.html#AsValidator" title="AsValidator"><span class="type">AsValidator</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="as-validator-validate-file"></a><h3>as_validator_validate_file ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
as_validator_validate_file (<em class="parameter"><code><a class="link" href="appstream-AsValidator.html#AsValidator" title="AsValidator"><span class="type">AsValidator</span></a> *validator</code></em>,
<em class="parameter"><code><a href="../gio/GFile.html#GFile-struct"><span class="type">GFile</span></a> *metadata_file</code></em>);</pre>
<p>Validate an AppStream XML file</p>
<div class="refsect3">
<a name="as-validator-validate-file.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>validator</p></td>
<td class="parameter_description"><p>An instance of <a class="link" href="appstream-AsValidator.html#AsValidator" title="AsValidator"><span class="type">AsValidator</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>metadata_file</p></td>
<td class="parameter_description"><p>An AppStream XML file.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="as-validator-validate-data"></a><h3>as_validator_validate_data ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
as_validator_validate_data (<em class="parameter"><code><a class="link" href="appstream-AsValidator.html#AsValidator" title="AsValidator"><span class="type">AsValidator</span></a> *validator</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *metadata</code></em>);</pre>
<p>Validate AppStream XML data</p>
<div class="refsect3">
<a name="as-validator-validate-data.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>validator</p></td>
<td class="parameter_description"><p>An instance of <a class="link" href="appstream-AsValidator.html#AsValidator" title="AsValidator"><span class="type">AsValidator</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>metadata</p></td>
<td class="parameter_description"><p>XML metadata.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="as-validator-validate-tree"></a><h3>as_validator_validate_tree ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
as_validator_validate_tree (<em class="parameter"><code><a class="link" href="appstream-AsValidator.html#AsValidator" title="AsValidator"><span class="type">AsValidator</span></a> *validator</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *root_dir</code></em>);</pre>
<p>Validate a full directory tree for issues in AppStream metadata.</p>
<div class="refsect3">
<a name="as-validator-validate-tree.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>validator</p></td>
<td class="parameter_description"><p>An instance of <a class="link" href="appstream-AsValidator.html#AsValidator" title="AsValidator"><span class="type">AsValidator</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>root_dir</p></td>
<td class="parameter_description"><p>The root directory of the filesystem tree that should be validated.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="as-validator-get-issues"></a><h3>as_validator_get_issues ()</h3>
<pre class="programlisting"><a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
as_validator_get_issues (<em class="parameter"><code><a class="link" href="appstream-AsValidator.html#AsValidator" title="AsValidator"><span class="type">AsValidator</span></a> *validator</code></em>);</pre>
<p>Get a list of found metadata format issues.</p>
<div class="refsect3">
<a name="as-validator-get-issues.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>validator</p></td>
<td class="parameter_description"><p>An instance of <a class="link" href="appstream-AsValidator.html#AsValidator" title="AsValidator"><span class="type">AsValidator</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="as-validator-get-issues.returns"></a><h4>Returns</h4>
<p> a list of <a class="link" href="appstream-AsValidatorIssue.html#AsValidatorIssue" title="AsValidatorIssue"><span class="type">AsValidatorIssue</span></a> instances, free with <a href="../glib/glib-Doubly-Linked-Lists.html#g-list-free"><code class="function">g_list_free()</code></a>. </p>
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> AsValidatorIssue][<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="as-validator-get-check-urls"></a><h3>as_validator_get_check_urls ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
as_validator_get_check_urls (<em class="parameter"><code><a class="link" href="appstream-AsValidator.html#AsValidator" title="AsValidator"><span class="type">AsValidator</span></a> *validator</code></em>);</pre>
<div class="refsect3">
<a name="as-validator-get-check-urls.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>validator</p></td>
<td class="parameter_description"><p>a <a class="link" href="appstream-AsValidator.html#AsValidator" title="AsValidator"><span class="type">AsValidator</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="as-validator-get-check-urls.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> in case we check if remote URLs exist.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="as-validator-set-check-urls"></a><h3>as_validator_set_check_urls ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
as_validator_set_check_urls (<em class="parameter"><code><a class="link" href="appstream-AsValidator.html#AsValidator" title="AsValidator"><span class="type">AsValidator</span></a> *validator</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> value</code></em>);</pre>
<p>Set this value to make the <a class="link" href="appstream-AsValidator.html#AsValidator" title="AsValidator"><span class="type">AsValidator</span></a> check whether remote URLs
actually exist.</p>
<div class="refsect3">
<a name="as-validator-set-check-urls.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>validator</p></td>
<td class="parameter_description"><p>a <a class="link" href="appstream-AsValidator.html#AsValidator" title="AsValidator"><span class="type">AsValidator</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="appstream-AsValidator.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="AS-TYPE-VALIDATOR:CAPS"></a><h3>AS_TYPE_VALIDATOR</h3>
<pre class="programlisting">#define AS_TYPE_VALIDATOR (as_validator_get_type ())
</pre>
</div>
<hr>
<div class="refsect2">
<a name="AsValidatorClass"></a><h3>struct AsValidatorClass</h3>
<pre class="programlisting">struct AsValidatorClass {
GObjectClass parent_class;
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="AsValidator"></a><h3>AsValidator</h3>
<pre class="programlisting">typedef struct _AsValidator AsValidator;</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
