View Source Appwrite.Services.Locale (appwrite v0.2.1)

The Locale service allows you to customize your app based on your users' location.

Using this service, you can get your users' location, IP address, list of countries and continents names, phone codes, currencies, and more.

The locale service supports multiple locales. This feature allows you to fetch countries and continents information in your app's language.

Summary

Functions

get()

Get the current user's locale.

list_codes()

List all locale codes classified by ISO 639-1.

list_continents()

List all continents.

list_countries()

List all countries.

list_countries_eu()

List all countries in the European Union.

list_countries_phones()

List all countries' phone dial codes.

list_currencies()

List all currencies.

list_languages()

List all languages classified by ISO 639-1.

Functions

get()

@spec get() ::
  {:ok, Appwrite.Types.Locale.t()}
  | {:error, Appwrite.Exceptions.AppwriteException.t()}

Get the current user's locale.

Retrieves the location based on the request IP. Returns country code, country name, continent name, continent code, IP address, and suggested currency.

Returns

{:ok, Locale.t()} on success.
{:error, AppwriteException.t()} on failure.

list_codes()

@spec list_codes() ::
  {:ok, Appwrite.Types.LocaleCodeList.t()}
  | {:error, Appwrite.Exceptions.AppwriteException.t()}

List all locale codes classified by ISO 639-1.

Returns

{:ok, LocaleCodeList.t()} on success.
{:error, AppwriteException.t()} on failure.

list_continents()

@spec list_continents() ::
  {:ok, Appwrite.Types.ContinentList.t()}
  | {:error, Appwrite.Exceptions.AppwriteException.t()}

List all continents.

Returns

{:ok, ContinentList.t()} on success.
{:error, AppwriteException.t()} on failure.

list_countries()

@spec list_countries() ::
  {:ok, Appwrite.Types.CountryList.t()}
  | {:error, Appwrite.Exceptions.AppwriteException.t()}

List all countries.

Returns

{:ok, CountryList.t()} on success.
{:error, AppwriteException.t()} on failure.

list_countries_eu()

@spec list_countries_eu() ::
  {:ok, Appwrite.Types.CountryList.t()}
  | {:error, Appwrite.Exceptions.AppwriteException.t()}

List all countries in the European Union.

Returns

{:ok, CountryList.t()} on success.
{:error, AppwriteException.t()} on failure.

list_countries_phones()

@spec list_countries_phones() ::
  {:ok, Appwrite.Types.PhoneList.t()}
  | {:error, Appwrite.Exceptions.AppwriteException.t()}

List all countries' phone dial codes.

Returns

{:ok, PhoneList.t()} on success.
{:error, AppwriteException.t()} on failure.

list_currencies()

@spec list_currencies() ::
  {:ok, Appwrite.Types.CurrencyList.t()}
  | {:error, Appwrite.Exceptions.AppwriteException.t()}

List all currencies.

Returns

{:ok, CurrencyList.t()} on success.
{:error, AppwriteException.t()} on failure.

list_languages()

@spec list_languages() ::
  {:ok, Appwrite.Types.LanguageList.t()}
  | {:error, Appwrite.Exceptions.AppwriteException.t()}

List all languages classified by ISO 639-1.

Returns

{:ok, LanguageList.t()} on success.
{:error, AppwriteException.t()} on failure.