/usr/share/gtk-doc/html/evolution-data-server/evolution-data-server-ESourceAlarms.html is in evolution-data-server-doc 3.28.1-1ubuntu1.
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 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ESourceAlarms: Evolution-Data-Server Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Reference Manual">
<link rel="up" href="ch02.html" title="Data Source Extensions">
<link rel="prev" href="evolution-data-server-ESourceAddressBook.html" title="ESourceAddressBook">
<link rel="next" href="evolution-data-server-ESourceAuthentication.html" title="ESourceAuthentication">
<meta name="generator" content="GTK-Doc V1.27 (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="#evolution-data-server-ESourceAlarms.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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="evolution-data-server-ESourceAddressBook.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="evolution-data-server-ESourceAuthentication.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="evolution-data-server-ESourceAlarms"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="evolution-data-server-ESourceAlarms.top_of_page"></a>ESourceAlarms</span></h2>
<p>ESourceAlarms — <a class="link" href="evolution-data-server-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> extension for alarm state</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="evolution-data-server-ESourceAlarms.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 href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-ESourceAlarms.html#e-source-alarms-get-include-me" title="e_source_alarms_get_include_me ()">e_source_alarms_get_include_me</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="evolution-data-server-ESourceAlarms.html#e-source-alarms-set-include-me" title="e_source_alarms_set_include_me ()">e_source_alarms_set_include_me</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-ESourceAlarms.html#e-source-alarms-get-last-notified" title="e_source_alarms_get_last_notified ()">e_source_alarms_get_last_notified</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-ESourceAlarms.html#e-source-alarms-dup-last-notified" title="e_source_alarms_dup_last_notified ()">e_source_alarms_dup_last_notified</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="evolution-data-server-ESourceAlarms.html#e-source-alarms-set-last-notified" title="e_source_alarms_set_last_notified ()">e_source_alarms_set_last_notified</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="evolution-data-server-ESourceAlarms.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="evolution-data-server-ESourceAlarms.html#E-SOURCE-EXTENSION-ALARMS:CAPS" title="E_SOURCE_EXTENSION_ALARMS">E_SOURCE_EXTENSION_ALARMS</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="evolution-data-server-ESourceAlarms.html#ESourceAlarms" title="struct ESourceAlarms">ESourceAlarms</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="evolution-data-server-ESourceAlarms.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libedataserver/libedataserver.h>
</pre>
</div>
<div class="refsect1">
<a name="evolution-data-server-ESourceAlarms.description"></a><h2>Description</h2>
<p>The <a class="link" href="evolution-data-server-ESourceAlarms.html#ESourceAlarms" title="struct ESourceAlarms"><span class="type">ESourceAlarms</span></a> extension tracks alarm state for a calendar.</p>
<p>Access the extension as follows:</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="gtkdoc ppc">#include <libedataserver/libedataserver.h></span>
ESourceAlarms <span class="gtkdoc opt">*</span>extension<span class="gtkdoc opt">;</span>
extension <span class="gtkdoc opt">=</span> <span class="function"><a href="../html/evolution-data-server-ESource.html#e-source-get-extension">e_source_get_extension</a></span> <span class="gtkdoc opt">(</span>source<span class="gtkdoc opt">,</span> E_SOURCE_EXTENSION_ALARMS<span class="gtkdoc opt">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
</div>
<div class="refsect1">
<a name="evolution-data-server-ESourceAlarms.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-source-alarms-get-include-me"></a><h3>e_source_alarms_get_include_me ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_source_alarms_get_include_me (<em class="parameter"><code><a class="link" href="evolution-data-server-ESourceAlarms.html#ESourceAlarms" title="struct ESourceAlarms"><span class="type">ESourceAlarms</span></a> *extension</code></em>);</pre>
<p>Returns whether the user should be alerted about upcoming appointments
in the calendar described by the <a class="link" href="evolution-data-server-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> to which <em class="parameter"><code>extension</code></em>
belongs.</p>
<p>Alarm daemons such as evolution-alarm-notify can use this property to
decide which calendars to query for upcoming appointments.</p>
<div class="refsect3">
<a name="e-source-alarms-get-include-me.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>extension</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-data-server-ESourceAlarms.html#ESourceAlarms" title="struct ESourceAlarms"><span class="type">ESourceAlarms</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-source-alarms-get-include-me.returns"></a><h4>Returns</h4>
<p> whether to show alarms for upcoming appointments</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-6.html#api-index-3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-alarms-set-include-me"></a><h3>e_source_alarms_set_include_me ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_source_alarms_set_include_me (<em class="parameter"><code><a class="link" href="evolution-data-server-ESourceAlarms.html#ESourceAlarms" title="struct ESourceAlarms"><span class="type">ESourceAlarms</span></a> *extension</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> include_me</code></em>);</pre>
<p>Sets whether the user should be alerted about upcoming appointments in
the calendar described by the <a class="link" href="evolution-data-server-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> to which <em class="parameter"><code>extension</code></em>
belongs.</p>
<p>Alarm daemons such as evolution-alarm-notify can use this property to
decide which calendars to query for upcoming appointments.</p>
<div class="refsect3">
<a name="e-source-alarms-set-include-me.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>extension</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-data-server-ESourceAlarms.html#ESourceAlarms" title="struct ESourceAlarms"><span class="type">ESourceAlarms</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>include_me</p></td>
<td class="parameter_description"><p>whether to show alarms for upcoming appointments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-6.html#api-index-3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-alarms-get-last-notified"></a><h3>e_source_alarms_get_last_notified ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
e_source_alarms_get_last_notified (<em class="parameter"><code><a class="link" href="evolution-data-server-ESourceAlarms.html#ESourceAlarms" title="struct ESourceAlarms"><span class="type">ESourceAlarms</span></a> *extension</code></em>);</pre>
<p>Returns an ISO 8601 formatted timestamp of when the user was last
alerted about an upcoming appointment in the calendar described by
the <a class="link" href="evolution-data-server-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> to which <em class="parameter"><code>extension</code></em>
belongs. If no valid timestamp
has been set, the function will return <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
<div class="refsect3">
<a name="e-source-alarms-get-last-notified.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>extension</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-data-server-ESourceAlarms.html#ESourceAlarms" title="struct ESourceAlarms"><span class="type">ESourceAlarms</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-source-alarms-get-last-notified.returns"></a><h4>Returns</h4>
<p>an ISO 8601 timestamp, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p>
<p><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></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-6.html#api-index-3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-alarms-dup-last-notified"></a><h3>e_source_alarms_dup_last_notified ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
e_source_alarms_dup_last_notified (<em class="parameter"><code><a class="link" href="evolution-data-server-ESourceAlarms.html#ESourceAlarms" title="struct ESourceAlarms"><span class="type">ESourceAlarms</span></a> *extension</code></em>);</pre>
<p>Thread-safe variation of <a class="link" href="evolution-data-server-ESourceAlarms.html#e-source-alarms-get-last-notified" title="e_source_alarms_get_last_notified ()"><code class="function">e_source_alarms_get_last_notified()</code></a>.
Use this function when accessing <em class="parameter"><code>extension</code></em>
from multiple threads.</p>
<p>The returned string should be freed with <a href="../glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when no longer needed.</p>
<div class="refsect3">
<a name="e-source-alarms-dup-last-notified.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>extension</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-data-server-ESourceAlarms.html#ESourceAlarms" title="struct ESourceAlarms"><span class="type">ESourceAlarms</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-source-alarms-dup-last-notified.returns"></a><h4>Returns</h4>
<p>a newly-allocated copy of <span class="type">“last-notified”</span>. </p>
<p><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></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-6.html#api-index-3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-alarms-set-last-notified"></a><h3>e_source_alarms_set_last_notified ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_source_alarms_set_last_notified (<em class="parameter"><code><a class="link" href="evolution-data-server-ESourceAlarms.html#ESourceAlarms" title="struct ESourceAlarms"><span class="type">ESourceAlarms</span></a> *extension</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *last_notified</code></em>);</pre>
<p>Sets an ISO 8601 formatted timestamp of when the user was last
alerted about an upcoming appointment in the calendar described
by the <a class="link" href="evolution-data-server-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> to which <em class="parameter"><code>extension</code></em>
belongs.</p>
<p>If <em class="parameter"><code>last_notified</code></em>
is non-<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the function will validate the
timestamp before setting the <span class="type">“last-notified”</span> property.
Invalid timestamps are discarded with a runtime warning.</p>
<p>Generally, this function should only be called by an alarm daemon
such as evolution-alarm-notify.</p>
<div class="refsect3">
<a name="e-source-alarms-set-last-notified.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>extension</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-data-server-ESourceAlarms.html#ESourceAlarms" title="struct ESourceAlarms"><span class="type">ESourceAlarms</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>last_notified</p></td>
<td class="parameter_description"><p>an ISO 8601 timestamp, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-6.html#api-index-3.6">3.6</a></p>
</div>
</div>
<div class="refsect1">
<a name="evolution-data-server-ESourceAlarms.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="E-SOURCE-EXTENSION-ALARMS:CAPS"></a><h3>E_SOURCE_EXTENSION_ALARMS</h3>
<pre class="programlisting">#define E_SOURCE_EXTENSION_ALARMS "Alarms"
</pre>
<p>Pass this extension name to <a class="link" href="evolution-data-server-ESource.html#e-source-get-extension" title="e_source_get_extension ()"><code class="function">e_source_get_extension()</code></a> to access
<a class="link" href="evolution-data-server-ESourceAlarms.html#ESourceAlarms" title="struct ESourceAlarms"><span class="type">ESourceAlarms</span></a>. This is also used as a group name in key files.</p>
<p class="since">Since: <a class="link" href="api-index-3-6.html#api-index-3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ESourceAlarms"></a><h3>struct ESourceAlarms</h3>
<pre class="programlisting">struct ESourceAlarms {
};
</pre>
<p>Contains only private data that should be read and manipulated using the
functions below.</p>
<p class="since">Since: <a class="link" href="api-index-3-6.html#api-index-3.6">3.6</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|