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

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 user service supports multiple locales. This feature allows you to fetch countries and continents information in your app language.

Summary

Functions

get()

Get user locale.

list_codes()

List locale codes.

list_continents()

List continents.

list_countries()

List countries.

list_countries_eu()

List EU countries.

list_countries_phones()

List phone codes.

list_currencies()

List currencies.

list_languages()

List languages.

Functions

get()

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

Get user locale.

Retrieves the current user's location based on their IP. Returns an object containing country code, country name, continent name, continent code, IP address, and suggested currency.

Examples

iex> Appwrite.Locale.get()
{:ok, %Appwrite.Types.Locale{}}

Params

Returns

{:ok, %Appwrite.Types.Locale{}} on success.
{:error, %Appwrite.Exceptions.AppwriteException{}} on failure.

list_codes()

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

List locale codes.

Fetches all locale codes classified by ISO 639-1.

Examples

iex> Appwrite.Locale.list_codes()
{:ok, %Appwrite.Types.LocaleCodeList{}}

Params

Returns

{:ok, %Appwrite.Types.LocaleCodeList{}} on success.
{:error, %Appwrite.Exceptions.AppwriteException{}} on failure.

list_continents()

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

List continents.

Fetches a list of all continents.

Examples

iex> Appwrite.Locale.list_continents()
{:ok, %Appwrite.Types.ContinentList{}}

Params

Returns

{:ok, %Appwrite.Types.ContinentList{}} on success.
{:error, %Appwrite.Exceptions.AppwriteException{}} on failure.

list_countries()

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

List countries.

Fetches a list of all countries.

Examples

iex> Appwrite.Locale.list_countries()
{:ok, %Appwrite.Types.CountryList{}}

Params

Returns

{:ok, %Appwrite.Types.CountryList{}} on success.
{:error, %Appwrite.Exceptions.AppwriteException{}} on failure.

list_countries_eu()

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

List EU countries.

Fetches a list of all countries in the European Union.

Examples

iex> Appwrite.Locale.list_countries_eu()
{:ok, %Appwrite.Types.CountryList{}}

Params

Returns

{:ok, %Appwrite.Types.CountryList{}} on success.
{:error, %Appwrite.Exceptions.AppwriteException{}} on failure.

list_countries_phones()

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

List phone codes.

Fetches a list of all countries' phone codes.

Examples

iex> Appwrite.Locale.list_countries_phones()
{:ok, %Appwrite.Types.PhoneList{}}

Params

Returns

{:ok, %Appwrite.Types.PhoneList{}} on success.
{:error, %Appwrite.Exceptions.AppwriteException{}} on failure.

list_currencies()

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

List currencies.

Fetches a list of all currencies.

Examples

iex> Appwrite.Locale.list_currencies()
{:ok, %Appwrite.Types.CurrencyList{}}

Params

Returns

{:ok, %Appwrite.Types.CurrencyList{}} on success.
{:error, %Appwrite.Exceptions.AppwriteException{}} on failure.

list_languages()

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

List languages.

Fetches a list of all languages classified by ISO 639-1.

Examples

iex> Appwrite.Locale.list_languages()
{:ok, %Appwrite.Types.LanguageList{}}

Params

Returns

{:ok, %Appwrite.Types.LanguageList{}} on success.
{:error, %Appwrite.Exceptions.AppwriteException{}} on failure.