/usr/share/gtk-doc/html/camel/CamelDiscoStore.html is in libcamel1.2-dev 3.2.3-0ubuntu6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CamelDiscoStore</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Camel Reference Manual">
<link rel="up" href="Deprecated.html" title="Deprecated Objects">
<link rel="prev" href="CamelDiscoFolder.html" title="CamelDiscoFolder">
<link rel="next" href="api-index-full.html" title="Index">
<meta name="generator" content="GTK-Doc V1.18 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="CamelDiscoFolder.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="Deprecated.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Camel Reference Manual</th>
<td><a accesskey="n" href="api-index-full.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#CamelDiscoStore.synopsis" class="shortcut">Top</a>
|
<a href="#CamelDiscoStore.description" class="shortcut">Description</a>
|
<a href="#CamelDiscoStore.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="CamelDiscoStore"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="CamelDiscoStore.top_of_page"></a>CamelDiscoStore</span></h2>
<p>CamelDiscoStore</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="CamelDiscoStore.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="CamelDiscoStore.html#CamelDiscoStore-struct" title="struct CamelDiscoStore">CamelDiscoStore</a>;
enum <a class="link" href="CamelDiscoStore.html#CamelDiscoStoreStatus" title="enum CamelDiscoStoreStatus">CamelDiscoStoreStatus</a>;
<a class="link" href="CamelDiscoStore.html#CamelDiscoStoreStatus" title="enum CamelDiscoStoreStatus"><span class="returnvalue">CamelDiscoStoreStatus</span></a> <a class="link" href="CamelDiscoStore.html#camel-disco-store-status" title="camel_disco_store_status ()">camel_disco_store_status</a> (<em class="parameter"><code><a class="link" href="CamelDiscoStore.html" title="CamelDiscoStore"><span class="type">CamelDiscoStore</span></a> *store</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="CamelDiscoStore.html#camel-disco-store-set-status" title="camel_disco_store_set_status ()">camel_disco_store_set_status</a> (<em class="parameter"><code><a class="link" href="CamelDiscoStore.html" title="CamelDiscoStore"><span class="type">CamelDiscoStore</span></a> *store</code></em>,
<em class="parameter"><code><a class="link" href="CamelDiscoStore.html#CamelDiscoStoreStatus" title="enum CamelDiscoStoreStatus"><span class="type">CamelDiscoStoreStatus</span></a> status</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="CamelDiscoStore.html#camel-disco-store-can-work-offline" title="camel_disco_store_can_work_offline ()">camel_disco_store_can_work_offline</a> (<em class="parameter"><code><a class="link" href="CamelDiscoStore.html" title="CamelDiscoStore"><span class="type">CamelDiscoStore</span></a> *store</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="CamelDiscoStore.html#camel-disco-store-check-online" title="camel_disco_store_check_online ()">camel_disco_store_check_online</a> (<em class="parameter"><code><a class="link" href="CamelDiscoStore.html" title="CamelDiscoStore"><span class="type">CamelDiscoStore</span></a> *store</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelDiscoStore.html#camel-disco-store-prepare-for-offline" title="camel_disco_store_prepare_for_offline ()">camel_disco_store_prepare_for_offline</a>
(<em class="parameter"><code><a class="link" href="CamelDiscoStore.html" title="CamelDiscoStore"><span class="type">CamelDiscoStore</span></a> *store</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="CamelDiscoStore.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----<a class="link" href="CamelObject.html" title="CamelObject">CamelObject</a>
+----<a class="link" href="CamelService.html" title="CamelService">CamelService</a>
+----<a class="link" href="CamelStore.html" title="CamelStore">CamelStore</a>
+----CamelDiscoStore
</pre>
</div>
<div class="refsect1">
<a name="CamelDiscoStore.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="CamelDiscoStore.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="CamelDiscoStore-struct"></a><h3>struct CamelDiscoStore</h3>
<pre class="programlisting">struct CamelDiscoStore;</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">CamelDiscoStore</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CamelDiscoStoreStatus"></a><h3>enum CamelDiscoStoreStatus</h3>
<pre class="programlisting">typedef enum {
CAMEL_DISCO_STORE_ONLINE,
CAMEL_DISCO_STORE_OFFLINE,
CAMEL_DISCO_STORE_RESYNCING
} CamelDiscoStoreStatus;
</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">CamelDiscoStoreStatus</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-disco-store-status"></a><h3>camel_disco_store_status ()</h3>
<pre class="programlisting"><a class="link" href="CamelDiscoStore.html#CamelDiscoStoreStatus" title="enum CamelDiscoStoreStatus"><span class="returnvalue">CamelDiscoStoreStatus</span></a> camel_disco_store_status (<em class="parameter"><code><a class="link" href="CamelDiscoStore.html" title="CamelDiscoStore"><span class="type">CamelDiscoStore</span></a> *store</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">camel_disco_store_status</code> is deprecated and should not be used in newly-written code.</p>
</div>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>store</code></em> :</span></p></td>
<td>a disconnectable store</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the current online/offline status of <em class="parameter"><code>store</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-disco-store-set-status"></a><h3>camel_disco_store_set_status ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> camel_disco_store_set_status (<em class="parameter"><code><a class="link" href="CamelDiscoStore.html" title="CamelDiscoStore"><span class="type">CamelDiscoStore</span></a> *store</code></em>,
<em class="parameter"><code><a class="link" href="CamelDiscoStore.html#CamelDiscoStoreStatus" title="enum CamelDiscoStoreStatus"><span class="type">CamelDiscoStoreStatus</span></a> status</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">camel_disco_store_set_status</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Sets <em class="parameter"><code>store</code></em> to <em class="parameter"><code>status</code></em>. If an error occurrs and the status cannot
be set to <em class="parameter"><code>status</code></em>, <em class="parameter"><code>error</code></em> will be set.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>store</code></em> :</span></p></td>
<td>a disconnectable store</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>status</code></em> :</span></p></td>
<td>the new status</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>optional <span class="type">GCancellable</span> method, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-disco-store-can-work-offline"></a><h3>camel_disco_store_can_work_offline ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> camel_disco_store_can_work_offline (<em class="parameter"><code><a class="link" href="CamelDiscoStore.html" title="CamelDiscoStore"><span class="type">CamelDiscoStore</span></a> *store</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">camel_disco_store_can_work_offline</code> is deprecated and should not be used in newly-written code.</p>
</div>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>store</code></em> :</span></p></td>
<td>a disconnectable store</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>whether or not <em class="parameter"><code>store</code></em> can be used offline. (Will be
<code class="literal">FALSE</code> if the store is not caching data to local disk, for example.)</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-disco-store-check-online"></a><h3>camel_disco_store_check_online ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> camel_disco_store_check_online (<em class="parameter"><code><a class="link" href="CamelDiscoStore.html" title="CamelDiscoStore"><span class="type">CamelDiscoStore</span></a> *store</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">camel_disco_store_check_online</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
This checks that <em class="parameter"><code>store</code></em> is online, and sets <em class="parameter"><code>ex</code></em> if it is not. This
can be used as a simple way to set a generic error message in <em class="parameter"><code>ex</code></em>
for operations that won't work offline.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>store</code></em> :</span></p></td>
<td>a disconnectable store</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>whether or not <em class="parameter"><code>store</code></em> is online.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-disco-store-prepare-for-offline"></a><h3>camel_disco_store_prepare_for_offline ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_disco_store_prepare_for_offline
(<em class="parameter"><code><a class="link" href="CamelDiscoStore.html" title="CamelDiscoStore"><span class="type">CamelDiscoStore</span></a> *store</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">camel_disco_store_prepare_for_offline</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|