/usr/share/gtk-doc/html/geocode-glib/GeocodeNominatim.html is in libgeocode-glib-doc 3.25.4.1-4.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GeocodeNominatim: geocode-glib Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="geocode-glib Reference Manual">
<link rel="up" href="ch01.html" title="Geocode-glib">
<link rel="prev" href="geocode-glib-geocode-mock-backend.html" title="geocode-mock-backend">
<link rel="next" href="GeocodePlace.html" title="GeocodePlace">
<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="#GeocodeNominatim.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GeocodeNominatim.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#GeocodeNominatim.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#GeocodeNominatim.properties" class="shortcut">Properties</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="geocode-glib-geocode-mock-backend.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GeocodePlace.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GeocodeNominatim"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GeocodeNominatim.top_of_page"></a>GeocodeNominatim</span></h2>
<p>GeocodeNominatim — Geocoding resolver using a Nominatim web service</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GeocodeNominatim.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="GeocodeNominatim.html" title="GeocodeNominatim"><span class="returnvalue">GeocodeNominatim</span></a> *
</td>
<td class="function_name">
<a class="link" href="GeocodeNominatim.html#geocode-nominatim-new" title="geocode_nominatim_new ()">geocode_nominatim_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GeocodeNominatim.html" title="GeocodeNominatim"><span class="returnvalue">GeocodeNominatim</span></a> *
</td>
<td class="function_name">
<a class="link" href="GeocodeNominatim.html#geocode-nominatim-get-gnome" title="geocode_nominatim_get_gnome ()">geocode_nominatim_get_gnome</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GeocodeNominatim.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="GeocodeNominatim.html#GeocodeNominatim--base-url" title="The “base-url” property">base-url</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="GeocodeNominatim.html#GeocodeNominatim--maintainer-email-address" title="The “maintainer-email-address” property">maintainer-email-address</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="GeocodeNominatim.html#GeocodeNominatim--user-agent" title="The “user-agent” property">user-agent</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GeocodeNominatim.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="GeocodeNominatim.html#GEOCODE-TYPE-NOMINATIM:CAPS" title="GEOCODE_TYPE_NOMINATIM">GEOCODE_TYPE_NOMINATIM</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GeocodeNominatim.html#GeocodeNominatimClass" title="struct GeocodeNominatimClass">GeocodeNominatimClass</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GeocodeNominatim.html#GeocodeNominatim-struct" title="GeocodeNominatim">GeocodeNominatim</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GeocodeNominatim.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> GeocodeNominatim
</pre>
</div>
<div class="refsect1">
<a name="GeocodeNominatim.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GeocodeNominatim implements
<a class="link" href="GeocodeBackend.html" title="GeocodeBackend">GeocodeBackend</a>.</p>
</div>
<div class="refsect1">
<a name="GeocodeNominatim.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <geocode-glib/geocode-glib.h>
</pre>
</div>
<div class="refsect1">
<a name="GeocodeNominatim.description"></a><h2>Description</h2>
<p>Contains functions for geocoding using the
<a class="ulink" href="http://wiki.openstreetmap.org/wiki/Nominatim" target="_top">OSM Nominatim APIs</a> exposed
by a Nominatim server at a given URI. By default, the GNOME Nominatim server
is used, but other server details may be given when constructing a
<a class="link" href="GeocodeNominatim.html" title="GeocodeNominatim"><span class="type">GeocodeNominatim</span></a>.</p>
</div>
<div class="refsect1">
<a name="GeocodeNominatim.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="geocode-nominatim-new"></a><h3>geocode_nominatim_new ()</h3>
<pre class="programlisting"><a class="link" href="GeocodeNominatim.html" title="GeocodeNominatim"><span class="returnvalue">GeocodeNominatim</span></a> *
geocode_nominatim_new (<em class="parameter"><code>const <span class="type">gchar</span> *base_url</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *maintainer_email_address</code></em>);</pre>
<p>Creates a new backend implementation for an online Nominatim server. See
the documentation for <a class="link" href="GeocodeNominatim.html#GeocodeNominatim--base-url" title="The “base-url” property"><span class="type">“base-url”</span></a> and
<a class="link" href="GeocodeNominatim.html#GeocodeNominatim--maintainer-email-address" title="The “maintainer-email-address” property"><span class="type">“maintainer-email-address”</span></a>.</p>
<div class="refsect3">
<a name="geocode-nominatim-new.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>base_url</p></td>
<td class="parameter_description"><p>a the base URL of the Nominatim server.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>maintainer_email_address</p></td>
<td class="parameter_description"><p>the email address of the software maintainer.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="geocode-nominatim-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="GeocodeNominatim.html" title="GeocodeNominatim"><span class="type">GeocodeNominatim</span></a>. Use <code class="function">g_object_unref()</code> when done. </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-full.html#api-index-3.23.1">3.23.1</a></p>
</div>
<hr>
<div class="refsect2">
<a name="geocode-nominatim-get-gnome"></a><h3>geocode_nominatim_get_gnome ()</h3>
<pre class="programlisting"><a class="link" href="GeocodeNominatim.html" title="GeocodeNominatim"><span class="returnvalue">GeocodeNominatim</span></a> *
geocode_nominatim_get_gnome (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Gets a reference to the default Nominatim server on nominatim.gnome.org.</p>
<p>This function is thread-safe.</p>
<div class="refsect3">
<a name="geocode-nominatim-get-gnome.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="GeocodeNominatim.html" title="GeocodeNominatim"><span class="type">GeocodeNominatim</span></a>. Use <code class="function">g_object_unref()</code> when done. </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-full.html#api-index-3.23.1">3.23.1</a></p>
</div>
</div>
<div class="refsect1">
<a name="GeocodeNominatim.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GEOCODE-TYPE-NOMINATIM:CAPS"></a><h3>GEOCODE_TYPE_NOMINATIM</h3>
<pre class="programlisting">#define GEOCODE_TYPE_NOMINATIM (geocode_nominatim_get_type ())
</pre>
<p>See <a class="link" href="GeocodeNominatim.html" title="GeocodeNominatim"><span class="type">GeocodeNominatim</span></a>.</p>
<p class="since">Since: <a class="link" href="api-index-full.html#api-index-3.23.1">3.23.1</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GeocodeNominatimClass"></a><h3>struct GeocodeNominatimClass</h3>
<pre class="programlisting">struct GeocodeNominatimClass {
GObjectClass parent_class;
gchar *(*query) (GeocodeNominatim *self,
const gchar *uri,
GCancellable *cancellable,
GError **error);
void (*query_async) (GeocodeNominatim *self,
const gchar *uri,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
gchar *(*query_finish) (GeocodeNominatim *self,
GAsyncResult *res,
GError **error);
};
</pre>
<p><a class="link" href="GeocodeNominatim.html" title="GeocodeNominatim"><span class="type">GeocodeNominatim</span></a> allows derived classes to override its query functions,
which are called for each network request the Nominatim client makes. All
network requests are <code class="literal">GET</code>s with no request body; just a URI. The default
implementation makes the requests internally, but derived classes may want
to override these queries to check the URIs for testing, for example.</p>
<p>Applications should not normally have to derive <a class="link" href="GeocodeNominatim.html" title="GeocodeNominatim"><span class="type">GeocodeNominatim</span></a>; these
virtual methods are mainly intended for testing.</p>
<div class="refsect3">
<a name="GeocodeNominatimClass.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GeocodeNominatimClass.query"></a>query</code></em> ()</p></td>
<td class="struct_member_description"><p>synchronous query function to override network <code class="literal">GET</code> requests.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GeocodeNominatimClass.query-async"></a>query_async</code></em> ()</p></td>
<td class="struct_member_description"><p>asynchronous version of <em class="parameter"><code>query</code></em>
.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GeocodeNominatimClass.query-finish"></a>query_finish</code></em> ()</p></td>
<td class="struct_member_description"><p>asynchronous finish function for <em class="parameter"><code>query_async</code></em>
.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-full.html#api-index-3.23.1">3.23.1</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GeocodeNominatim-struct"></a><h3>GeocodeNominatim</h3>
<pre class="programlisting">typedef struct _GeocodeNominatim GeocodeNominatim;</pre>
<p>All the fields in the <a class="link" href="GeocodeNominatim.html" title="GeocodeNominatim"><span class="type">GeocodeNominatim</span></a> structure are private and should
never be accessed directly.</p>
<p class="since">Since: <a class="link" href="api-index-full.html#api-index-3.23.1">3.23.1</a></p>
</div>
</div>
<div class="refsect1">
<a name="GeocodeNominatim.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GeocodeNominatim--base-url"></a><h3>The <code class="literal">“base-url”</code> property</h3>
<pre class="programlisting"> “base-url” <span class="type">gchar</span> *</pre>
<p>The base URL of the Nominatim service, for example
<code class="literal">https://nominatim.example.org</code>.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: NULL</p>
<p class="since">Since: <a class="link" href="api-index-full.html#api-index-3.23.1">3.23.1</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GeocodeNominatim--maintainer-email-address"></a><h3>The <code class="literal">“maintainer-email-address”</code> property</h3>
<pre class="programlisting"> “maintainer-email-address” <span class="type">gchar</span> *</pre>
<p>E-mail address of the maintainer of the software making the
geocoding requests to the Nominatim server. This is used to contact
them in the event of a problem with their usage. See
<a class="ulink" href="http://wiki.openstreetmap.org/wiki/Nominatim" target="_top">the Nominatim API</a>.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: NULL</p>
<p class="since">Since: <a class="link" href="api-index-full.html#api-index-3.23.1">3.23.1</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GeocodeNominatim--user-agent"></a><h3>The <code class="literal">“user-agent”</code> property</h3>
<pre class="programlisting"> “user-agent” <span class="type">gchar</span> *</pre>
<p>User-Agent string to send with HTTP(S) requests, or <code class="literal">NULL</code> to use the
default user agent, which is derived from the geocode-glib version
and <span class="type">“id”</span>, for example: <code class="literal">geocode-glib/3.20 (MyAppId)</code>.</p>
<p>As per the
<a class="ulink" href="http://wiki.openstreetmap.org/wiki/Nominatim_usage_policy" target="_top">Nominatim usage policy</a>,
it should be set to a string which identifies the application which
is using geocode-glib, and must be a valid
<a class="ulink" href="https://tools.ietf.org/html/rfc7231#section-5.5.3" target="_top">user agent</a>
string.</p>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
<p class="since">Since: <a class="link" href="api-index-full.html#api-index-3.23.1">3.23.1</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|