geocode_nominatim_new ()

GeocodeNominatim *
geocode_nominatim_new (const gchar *base_url,
                       const gchar *maintainer_email_address);

Creates a new backend implementation for an online Nominatim server. See the documentation for “base-url” and “maintainer-email-address”.

Since: 3.23.1

geocode_nominatim_get_gnome ()

GeocodeNominatim *
geocode_nominatim_get_gnome (void);

Gets a reference to the default Nominatim server on nominatim.gnome.org.

This function is thread-safe.

Since: 3.23.1

GEOCODE_TYPE_NOMINATIM

#define GEOCODE_TYPE_NOMINATIM (geocode_nominatim_get_type ())

See GeocodeNominatim.

Since: 3.23.1

struct GeocodeNominatimClass

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);
};

GeocodeNominatim allows derived classes to override its query functions, which are called for each network request the Nominatim client makes. All network requests are GETs 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.

Applications should not normally have to derive GeocodeNominatim; these virtual methods are mainly intended for testing.

Since: 3.23.1

GeocodeNominatim

typedef struct _GeocodeNominatim GeocodeNominatim;

All the fields in the GeocodeNominatim structure are private and should never be accessed directly.

Since: 3.23.1

The “base-url” property

  “base-url”                 gchar *

The base URL of the Nominatim service, for example https://nominatim.example.org.

Flags: Read / Write / Construct Only

Default value: NULL

Since: 3.23.1

The “maintainer-email-address” property

  “maintainer-email-address” gchar *

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 the Nominatim API.

Flags: Read / Write / Construct Only

Default value: NULL

Since: 3.23.1

The “user-agent” property

  “user-agent”               gchar *

User-Agent string to send with HTTP(S) requests, or NULL to use the default user agent, which is derived from the geocode-glib version and “id”, for example: geocode-glib/3.20 (MyAppId).

As per the Nominatim usage policy, it should be set to a string which identifies the application which is using geocode-glib, and must be a valid user agent string.

Flags: Read / Write

Default value: NULL

Since: 3.23.1