diff options
Diffstat (limited to 'reference/html/FlatpakRemote.html')
| -rw-r--r-- | reference/html/FlatpakRemote.html | 86 |
1 files changed, 47 insertions, 39 deletions
diff --git a/reference/html/FlatpakRemote.html b/reference/html/FlatpakRemote.html index 2b787971..41ee3254 100644 --- a/reference/html/FlatpakRemote.html +++ b/reference/html/FlatpakRemote.html @@ -6,9 +6,9 @@ <meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"> <link rel="home" href="index.html" title="Flatpak Library Reference Manual"> <link rel="up" href="ch01.html" title="Flatpak"> -<link rel="prev" href="FlatpakRemoteRef.html" title="FlatpakRemoteRef"> -<link rel="next" href="flatpak-flatpak-bundle-ref.html" title="flatpak-bundle-ref"> -<meta name="generator" content="GTK-Doc V1.27 (XML mode)"> +<link rel="prev" href="FlatpakInstallation.html" title="FlatpakInstallation"> +<link rel="next" href="FlatpakTransactionOperation.html" title="FlatpakTransactionOperation"> +<meta name="generator" content="GTK-Doc V1.28 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,8 +21,8 @@ </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="FlatpakRemoteRef.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="flatpak-flatpak-bundle-ref.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +<td><a accesskey="p" href="FlatpakInstallation.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="FlatpakTransactionOperation.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> </tr></table> <div class="refentry"> <a name="FlatpakRemote"></a><div class="titlepage"></div> @@ -58,7 +58,7 @@ </tr> <tr> <td class="function_type"> -<span class="returnvalue">GFile</span> * +<a href="/usr/share/gtk-doc/html/gio/GFile.html#GFile-struct"><span class="returnvalue">GFile</span></a> * </td> <td class="function_name"> <a class="link" href="FlatpakRemote.html#flatpak-remote-get-appstream-dir" title="flatpak_remote_get_appstream_dir ()">flatpak_remote_get_appstream_dir</a> <span class="c_punctuation">()</span> @@ -66,7 +66,7 @@ </tr> <tr> <td class="function_type"> -<span class="returnvalue">GFile</span> * +<a href="/usr/share/gtk-doc/html/gio/GFile.html#GFile-struct"><span class="returnvalue">GFile</span></a> * </td> <td class="function_name"> <a class="link" href="FlatpakRemote.html#flatpak-remote-get-appstream-timestamp" title="flatpak_remote_get_appstream_timestamp ()">flatpak_remote_get_appstream_timestamp</a> <span class="c_punctuation">()</span> @@ -106,7 +106,7 @@ </tr> <tr> <td class="function_type"> -<span class="returnvalue">gboolean</span> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> </td> <td class="function_name"> <a class="link" href="FlatpakRemote.html#flatpak-remote-get-gpg-verify" title="flatpak_remote_get_gpg_verify ()">flatpak_remote_get_gpg_verify</a> <span class="c_punctuation">()</span> @@ -130,7 +130,7 @@ </tr> <tr> <td class="function_type"> -<span class="returnvalue">gboolean</span> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> </td> <td class="function_name"> <a class="link" href="FlatpakRemote.html#flatpak-remote-get-nodeps" title="flatpak_remote_get_nodeps ()">flatpak_remote_get_nodeps</a> <span class="c_punctuation">()</span> @@ -146,7 +146,7 @@ </tr> <tr> <td class="function_type"> -<span class="returnvalue">gboolean</span> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> </td> <td class="function_name"> <a class="link" href="FlatpakRemote.html#flatpak-remote-get-noenumerate" title="flatpak_remote_get_noenumerate ()">flatpak_remote_get_noenumerate</a> <span class="c_punctuation">()</span> @@ -218,7 +218,7 @@ </tr> <tr> <td class="function_type"> -<span class="returnvalue">gboolean</span> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> </td> <td class="function_name"> <a class="link" href="FlatpakRemote.html#flatpak-remote-get-disabled" title="flatpak_remote_get_disabled ()">flatpak_remote_get_disabled</a> <span class="c_punctuation">()</span> @@ -246,7 +246,7 @@ <tbody> <tr> <td class="property_type"> -<span class="type">gchar</span> *</td> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> <td class="property_name"><a class="link" href="FlatpakRemote.html#FlatpakRemote--name" title="The “name” property">name</a></td> <td class="property_flags">Read / Write</td> </tr> @@ -279,7 +279,7 @@ </div> <div class="refsect1"> <a name="FlatpakRemote.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> GObject +<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> <span class="lineart">╰──</span> FlatpakRemote </pre> </div> @@ -357,7 +357,7 @@ flatpak_remote_get_name (<em class="parameter"><code><a class="link" href="Flatp <hr> <div class="refsect2"> <a name="flatpak-remote-get-appstream-dir"></a><h3>flatpak_remote_get_appstream_dir ()</h3> -<pre class="programlisting"><span class="returnvalue">GFile</span> * +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gio/GFile.html#GFile-struct"><span class="returnvalue">GFile</span></a> * flatpak_remote_get_appstream_dir (<em class="parameter"><code><a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a> *self</code></em>, <em class="parameter"><code>const <span class="type">char</span> *arch</code></em>);</pre> <p>Returns the directory where this remote will store locally cached @@ -387,14 +387,14 @@ appstream information for the specified <em class="parameter"><code>arch</code>< </div> <div class="refsect3"> <a name="flatpak-remote-get-appstream-dir.returns"></a><h4>Returns</h4> -<p>a <span class="type">GFile</span>. </p> +<p>a <a href="/usr/share/gtk-doc/html/gio/GFile.html#GFile-struct"><span class="type">GFile</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="flatpak-remote-get-appstream-timestamp"></a><h3>flatpak_remote_get_appstream_timestamp ()</h3> -<pre class="programlisting"><span class="returnvalue">GFile</span> * +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gio/GFile.html#GFile-struct"><span class="returnvalue">GFile</span></a> * flatpak_remote_get_appstream_timestamp (<em class="parameter"><code><a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a> *self</code></em>, <em class="parameter"><code>const <span class="type">char</span> *arch</code></em>);</pre> @@ -425,7 +425,7 @@ has been updated (or tried to update) for the specified <em class="parameter"><c </div> <div class="refsect3"> <a name="flatpak-remote-get-appstream-timestamp.returns"></a><h4>Returns</h4> -<p>a <span class="type">GFile</span>. </p> +<p>a <a href="/usr/share/gtk-doc/html/gio/GFile.html#GFile-struct"><span class="type">GFile</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> @@ -452,7 +452,7 @@ flatpak_remote_get_collection_id (<em class="parameter"><code><a class="link" hr </div> <div class="refsect3"> <a name="flatpak-remote-get-collection-id.returns"></a><h4>Returns</h4> -<p>the collection ID, or <code class="literal">NULL</code> if unset. </p> +<p>the collection ID, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if unset. </p> <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> </div> </div> @@ -482,7 +482,7 @@ effect.</p> </tr> <tr> <td class="parameter_name"><p>collection_id</p></td> -<td class="parameter_description"><p>The new collection ID, or <code class="literal">NULL</code> to unset. </p></td> +<td class="parameter_description"><p>The new collection ID, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to unset. </p></td> <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> </tr> </tbody> @@ -512,7 +512,7 @@ flatpak_remote_get_default_branch (<em class="parameter"><code><a class="link" h </div> <div class="refsect3"> <a name="flatpak-remote-get-default-branch.returns"></a><h4>Returns</h4> -<p>the default branch, or <code class="literal">NULL</code>. </p> +<p>the default branch, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></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> <p class="since">Since: 0.6.12</p> @@ -554,7 +554,7 @@ effect.</p> <hr> <div class="refsect2"> <a name="flatpak-remote-get-gpg-verify"></a><h3>flatpak_remote_get_gpg_verify ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> flatpak_remote_get_gpg_verify (<em class="parameter"><code><a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a> *self</code></em>);</pre> <p>Returns whether GPG verification is enabled for the remote.</p> <div class="refsect3"> @@ -582,7 +582,7 @@ flatpak_remote_get_gpg_verify (<em class="parameter"><code><a class="link" href= <a name="flatpak-remote-set-gpg-verify"></a><h3>flatpak_remote_set_gpg_verify ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> flatpak_remote_set_gpg_verify (<em class="parameter"><code><a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a> *self</code></em>, - <em class="parameter"><code><span class="type">gboolean</span> gpg_verify</code></em>);</pre> + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> gpg_verify</code></em>);</pre> <p>Sets the gpg_verify config of this remote. See <a class="link" href="FlatpakRemote.html#flatpak-remote-get-gpg-verify" title="flatpak_remote_get_gpg_verify ()"><code class="function">flatpak_remote_get_gpg_verify()</code></a>.</p> <p>Note: This is a local modification of this object, you must commit changes using <a class="link" href="FlatpakInstallation.html#flatpak-installation-modify-remote" title="flatpak_installation_modify_remote ()"><code class="function">flatpak_installation_modify_remote()</code></a> for the changes to take @@ -615,7 +615,7 @@ effect.</p> <a name="flatpak-remote-set-gpg-key"></a><h3>flatpak_remote_set_gpg_key ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> flatpak_remote_set_gpg_key (<em class="parameter"><code><a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a> *self</code></em>, - <em class="parameter"><code><span class="type">GBytes</span> *gpg_key</code></em>);</pre> + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Byte-Arrays.html#GBytes"><span class="type">GBytes</span></a> *gpg_key</code></em>);</pre> <p>Sets the trusted gpg key for this remote.</p> <p>Note: This is a local modification of this object, you must commit changes using <a class="link" href="FlatpakInstallation.html#flatpak-installation-modify-remote" title="flatpak_installation_modify_remote ()"><code class="function">flatpak_installation_modify_remote()</code></a> for the changes to take @@ -636,7 +636,7 @@ effect.</p> </tr> <tr> <td class="parameter_name"><p>gpg_key</p></td> -<td class="parameter_description"><p>a <span class="type">GBytes</span> with gpg binary key data</p></td> +<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/glib/glib-Byte-Arrays.html#GBytes"><span class="type">GBytes</span></a> with gpg binary key data</p></td> <td class="parameter_annotations"> </td> </tr> </tbody> @@ -646,7 +646,7 @@ effect.</p> <hr> <div class="refsect2"> <a name="flatpak-remote-get-nodeps"></a><h3>flatpak_remote_get_nodeps ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> flatpak_remote_get_nodeps (<em class="parameter"><code><a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a> *self</code></em>);</pre> <p>Returns whether this remote should be used to find dependencies.</p> <div class="refsect3"> @@ -674,7 +674,7 @@ flatpak_remote_get_nodeps (<em class="parameter"><code><a class="link" href="Fla <a name="flatpak-remote-set-nodeps"></a><h3>flatpak_remote_set_nodeps ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> flatpak_remote_set_nodeps (<em class="parameter"><code><a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a> *self</code></em>, - <em class="parameter"><code><span class="type">gboolean</span> nodeps</code></em>);</pre> + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> nodeps</code></em>);</pre> <p>Sets the nodeps config of this remote. See <a class="link" href="FlatpakRemote.html#flatpak-remote-get-nodeps" title="flatpak_remote_get_nodeps ()"><code class="function">flatpak_remote_get_nodeps()</code></a>.</p> <p>Note: This is a local modification of this object, you must commit changes using <a class="link" href="FlatpakInstallation.html#flatpak-installation-modify-remote" title="flatpak_installation_modify_remote ()"><code class="function">flatpak_installation_modify_remote()</code></a> for the changes to take @@ -705,7 +705,7 @@ effect.</p> <hr> <div class="refsect2"> <a name="flatpak-remote-get-noenumerate"></a><h3>flatpak_remote_get_noenumerate ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> flatpak_remote_get_noenumerate (<em class="parameter"><code><a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a> *self</code></em>);</pre> <p>Returns whether this remote should be used to list applications.</p> <div class="refsect3"> @@ -733,7 +733,7 @@ flatpak_remote_get_noenumerate (<em class="parameter"><code><a class="link" href <a name="flatpak-remote-set-noenumerate"></a><h3>flatpak_remote_set_noenumerate ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> flatpak_remote_set_noenumerate (<em class="parameter"><code><a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a> *self</code></em>, - <em class="parameter"><code><span class="type">gboolean</span> noenumerate</code></em>);</pre> + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> noenumerate</code></em>);</pre> <p>Sets the noenumeration config of this remote. See <a class="link" href="FlatpakRemote.html#flatpak-remote-get-noenumerate" title="flatpak_remote_get_noenumerate ()"><code class="function">flatpak_remote_get_noenumerate()</code></a>.</p> <p>Note: This is a local modification of this object, you must commit changes using <a class="link" href="FlatpakInstallation.html#flatpak-installation-modify-remote" title="flatpak_installation_modify_remote ()"><code class="function">flatpak_installation_modify_remote()</code></a> for the changes to take @@ -970,7 +970,7 @@ effect.</p> <hr> <div class="refsect2"> <a name="flatpak-remote-get-disabled"></a><h3>flatpak_remote_get_disabled ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> flatpak_remote_get_disabled (<em class="parameter"><code><a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a> *self</code></em>);</pre> <p>Returns whether this remote is disabled.</p> <div class="refsect3"> @@ -990,7 +990,7 @@ flatpak_remote_get_disabled (<em class="parameter"><code><a class="link" href="F </div> <div class="refsect3"> <a name="flatpak-remote-get-disabled.returns"></a><h4>Returns</h4> -<p> whether the remote is marked as "don't enumerate"</p> +<p> whether the remote is marked as disabled</p> </div> </div> <hr> @@ -998,7 +998,7 @@ flatpak_remote_get_disabled (<em class="parameter"><code><a class="link" href="F <a name="flatpak-remote-set-disabled"></a><h3>flatpak_remote_set_disabled ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> flatpak_remote_set_disabled (<em class="parameter"><code><a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a> *self</code></em>, - <em class="parameter"><code><span class="type">gboolean</span> disabled</code></em>);</pre> + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> disabled</code></em>);</pre> <p>Sets the disabled config of this remote. See <a class="link" href="FlatpakRemote.html#flatpak-remote-get-disabled" title="flatpak_remote_get_disabled ()"><code class="function">flatpak_remote_get_disabled()</code></a>.</p> <p>Note: This is a local modification of this object, you must commit changes using <a class="link" href="FlatpakInstallation.html#flatpak-installation-modify-remote" title="flatpak_installation_modify_remote ()"><code class="function">flatpak_installation_modify_remote()</code></a> for the changes to take @@ -1036,6 +1036,8 @@ effect.</p> <hr> <div class="refsect2"> <a name="FlatpakRemoteType"></a><h3>enum FlatpakRemoteType</h3> +<p>Different types of <em class="parameter"><code>FlatpakRemote</code></em> +.</p> <div class="refsect3"> <a name="FlatpakRemoteType.members"></a><h4>Members</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> @@ -1047,18 +1049,24 @@ effect.</p> <tbody> <tr> <td class="enum_member_name"><p><a name="FLATPAK-REMOTE-TYPE-STATIC:CAPS"></a>FLATPAK_REMOTE_TYPE_STATIC</p></td> -<td> </td> -<td> </td> +<td class="enum_member_description"> +<p>Statically configured remote</p> +</td> +<td class="enum_member_annotations"> </td> </tr> <tr> <td class="enum_member_name"><p><a name="FLATPAK-REMOTE-TYPE-USB:CAPS"></a>FLATPAK_REMOTE_TYPE_USB</p></td> -<td> </td> -<td> </td> +<td class="enum_member_description"> +<p>Dynamically detected local pathname remote</p> +</td> +<td class="enum_member_annotations"> </td> </tr> <tr> <td class="enum_member_name"><p><a name="FLATPAK-REMOTE-TYPE-LAN:CAPS"></a>FLATPAK_REMOTE_TYPE_LAN</p></td> -<td> </td> -<td> </td> +<td class="enum_member_description"> +<p>Dynamically detected network remote</p> +</td> +<td class="enum_member_annotations"> </td> </tr> </tbody> </table></div> @@ -1069,7 +1077,7 @@ effect.</p> <a name="FlatpakRemote.property-details"></a><h2>Property Details</h2> <div class="refsect2"> <a name="FlatpakRemote--name"></a><h3>The <code class="literal">“name”</code> property</h3> -<pre class="programlisting"> “name” <span class="type">gchar</span> *</pre> +<pre class="programlisting"> “name” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> <p>Name of the remote, as used in configuration files and when interfacing with OSTree. This is typically human readable, but could be generated, and must conform to <a href="/usr/share/gtk-doc/html/ostree/ostree-Core-repository-independent-functions.html#ostree-validate-remote-name"><code class="function">ostree_validate_remote_name()</code></a>. It should typically not be @@ -1096,6 +1104,6 @@ time.</p> </div> </div> <div class="footer"> -<hr>Generated by GTK-Doc V1.27</div> +<hr>Generated by GTK-Doc V1.28</div> </body> </html>
\ No newline at end of file |