/usr/share/gtk-doc/html/eds/eds-EDataBookDirect.html is in evolution-data-server-doc 3.18.5-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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EDataBookDirect: 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="ch08.html" title="Addressbook Backend Classes">
<link rel="prev" href="eds-EDataBook.html" title="EDataBook">
<link rel="next" href="eds-EDataBookCursor.html" title="EDataBookCursor">
<meta name="generator" content="GTK-Doc V1.24 (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="#eds-EDataBookDirect.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="ch08.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="eds-EDataBook.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="eds-EDataBookCursor.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="eds-EDataBookDirect"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="eds-EDataBookDirect.top_of_page"></a>EDataBookDirect</span></h2>
<p>EDataBookDirect — An interface for implementing Direct Read Access</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="eds-EDataBookDirect.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="eds-EDataBookDirect.html#EDataBookDirect" title="struct EDataBookDirect"><span class="returnvalue">EDataBookDirect</span></a> *
</td>
<td class="function_name">
<a class="link" href="eds-EDataBookDirect.html#e-data-book-direct-new" title="e_data_book_direct_new ()">e_data_book_direct_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<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="eds-EDataBookDirect.html#e-data-book-direct-register-gdbus-object" title="e_data_book_direct_register_gdbus_object ()">e_data_book_direct_register_gdbus_object</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="eds-EDataBookDirect.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="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="eds-EDataBookDirect.html#EDataBookDirect" title="struct EDataBookDirect">EDataBookDirect</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="eds-EDataBookDirect.html#EDataBookDirectClass" title="struct EDataBookDirectClass">EDataBookDirectClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="eds-EDataBookDirect.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libedata-book/libedata-book.h>
</pre>
</div>
<div class="refsect1">
<a name="eds-EDataBookDirect.description"></a><h2>Description</h2>
<p>This class should be created by an <a class="link" href="eds-EBookBackend.html#EBookBackendClass.get-direct-book"><code class="function">EBookBackendClass.get_direct_book()</code></a>
implementation of a backend which supports direct read access.</p>
<p>This will only be asked of the backend when instantiated on the server
side. If the server side instance of an <a class="link" href="eds-EBookBackend.html#EBookBackend" title="struct EBookBackend"><span class="type">EBookBackend</span></a> does return
an <a class="link" href="eds-EDataBookDirect.html#EDataBookDirect" title="struct EDataBookDirect"><span class="type">EDataBookDirect</span></a>, then a client side instance of the same backend
will be created and <a class="link" href="eds-EBookBackend.html#EBookBackendClass.configure-direct"><code class="function">EBookBackendClass.configure_direct()</code></a> will be
called on the corresponding client side instance.</p>
</div>
<div class="refsect1">
<a name="eds-EDataBookDirect.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-data-book-direct-new"></a><h3>e_data_book_direct_new ()</h3>
<pre class="programlisting"><a class="link" href="eds-EDataBookDirect.html#EDataBookDirect" title="struct EDataBookDirect"><span class="returnvalue">EDataBookDirect</span></a> *
e_data_book_direct_new (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *backend_path</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *backend_factory_name</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *config</code></em>);</pre>
<p>Creates a <a class="link" href="eds-EDataBookDirect.html#EDataBookDirect" title="struct EDataBookDirect"><span class="type">EDataBookDirect</span></a> to report configuration data needed for direct
read access.</p>
<p>This is returned by <a class="link" href="eds-EBookBackend.html#e-book-backend-get-direct-book" title="e_book_backend_get_direct_book ()"><code class="function">e_book_backend_get_direct_book()</code></a> for backends
which support direct read access mode.</p>
<div class="refsect3">
<a name="id-1.4.4.7.7.2.6"></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>backend_path</p></td>
<td class="parameter_description"><p>Full path to the installed backend shared library</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>backend_factory_name</p></td>
<td class="parameter_description"><p>Type name of the EBookBackendFactory implemented by the library</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>config</p></td>
<td class="parameter_description"><p>A backend specific configuration string</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.7.7.2.7"></a><h4>Returns</h4>
<p> A newly created <a class="link" href="eds-EDataBookDirect.html#EDataBookDirect" title="struct EDataBookDirect"><span class="type">EDataBookDirect</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>
<p class="since">Since: <a class="link" href="api-index-3.8.html" title="Index of new symbols in 3.8">3.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-data-book-direct-register-gdbus-object"></a><h3>e_data_book_direct_register_gdbus_object ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_data_book_direct_register_gdbus_object
(<em class="parameter"><code><a class="link" href="eds-EDataBookDirect.html#EDataBookDirect" title="struct EDataBookDirect"><span class="type">EDataBookDirect</span></a> *direct</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GDBusConnection.html"><span class="type">GDBusConnection</span></a> *connection</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Places <em class="parameter"><code>direct</code></em>
on the <em class="parameter"><code>connection</code></em>
at <em class="parameter"><code>object_path</code></em>
</p>
<div class="refsect3">
<a name="id-1.4.4.7.7.3.5"></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>direct</p></td>
<td class="parameter_description"><p>An <a class="link" href="eds-EDataBookDirect.html#EDataBookDirect" title="struct EDataBookDirect"><span class="type">EDataBookDirect</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>connection</p></td>
<td class="parameter_description"><p>The <a href="/usr/share/gtk-doc/html/gio/GDBusConnection.html"><span class="type">GDBusConnection</span></a> to register with</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>object_path</p></td>
<td class="parameter_description"><p>The object path to place the direct access configuration data</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>A location to store any error which might occur while registering</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3.8.html" title="Index of new symbols in 3.8">3.8</a></p>
</div>
</div>
<div class="refsect1">
<a name="eds-EDataBookDirect.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="EDataBookDirect"></a><h3>struct EDataBookDirect</h3>
<pre class="programlisting">struct EDataBookDirect {
GObject parent;
EDataBookDirectPrivate *priv;
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="EDataBookDirectClass"></a><h3>struct EDataBookDirectClass</h3>
<pre class="programlisting">struct EDataBookDirectClass {
GObjectClass parent;
};
</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|