View Source Mobilizon.Service.Geospatial.Provider behaviour (Mobilizon v5.0.0-beta.1)

Provider Behaviour for Geospatial stuff.

Supported backends

:lang Lang in which to prefer results. Used as a request parameter or through an Accept-Language HTTP header. Defaults to "en".
:country_code An ISO 3166 country code. String or nil
:limit Maximum limit for the number of results returned by the backend. Defaults to 10
:api_key Allows to override the API key (if the backend requires one) set inside the configuration.
:endpoint Allows to override the endpoint set inside the configuration.

Get an address from longitude and latitude coordinates.

Search for an address

Returns a Geo.Point for given coordinates

timezone(point)

Returns the timezone for a Geo.Point

@callback geocode(longitude :: number(), latitude :: number(), options :: keyword()) :: [
  Mobilizon.Addresses.Address.t()
]

Get an address from longitude and latitude coordinates.

In addition to the shared options, geocode/3 also accepts the following options:

iex> geocode(48.11, -1.77)
%Address{}

@callback search(address :: String.t(), options :: keyword()) :: [
  Mobilizon.Addresses.Address.t()
]

Search for an address

In addition to the shared options, search/2 also accepts the following options:

coords Map of coordinates (ex: %{lon: 48.11, lat: -1.77}) allowing to give a geographic priority to the search. Defaults to nil.
type Filter by type of results. Allowed values:
- :administrative (cities, regions)

iex> search("10 rue Jangot")
%Address{}

@spec coordinates([number() | String.t()]) :: Geo.Point.t() | nil

Returns a Geo.Point for given coordinates

@spec endpoint(atom()) :: String.t()

@spec timezone(nil | Geo.Point.t()) :: nil | String.t()

Returns the timezone for a Geo.Point