Locale
Localização do pedido, países, idiomas, moedas, continentes e códigos de telefone.
Classe Locale: 8 métodos (8 no @owbase/web, 8 no @owbase/node). Os exemplos usam a forma de objeto dos parâmetros; troque os valores entre < e > pelos seus.
Obter localidade do usuário
SDK: @owbase/web e @owbase/node
Obtém a localização do usuário atual pelo IP. Devolve um objeto com o código e o nome do país, o nome e o código do continente, o endereço IP e a moeda sugerida. Use o header locale para receber os dados num idioma aceito.
Sem parâmetros.
Acesso: chave de API com o escopo locale.read ou sem chave nem sessão: basta o ID do projeto.
import { Client, Locale } from '@owbase/web';
const client = new Client() .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API .setProject('<YOUR_PROJECT_ID>'); // ID do projeto
const locale = new Locale(client);
const result = await locale.get();
console.log(result);import { Client, Locale } from '@owbase/node';
const client = new Client() .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API .setProject('<YOUR_PROJECT_ID>') // ID do projeto .setSession(''); // sessão do usuário
const locale = new Locale(client);
const result = await locale.get();listCodes
Seção intitulada “listCodes”Listar códigos de localidade
SDK: @owbase/web e @owbase/node
Lista todos os códigos de localidade no padrão ISO 639-1.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
total |
boolean |
não | Com false, o total não é calculado e volta como 0. |
Acesso: chave de API com o escopo locale.read ou sem chave nem sessão: basta o ID do projeto.
import { Client, Locale } from '@owbase/web';
const client = new Client() .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API .setProject('<YOUR_PROJECT_ID>'); // ID do projeto
const locale = new Locale(client);
const result = await locale.listCodes({ total: false, // opcional});
console.log(result);import { Client, Locale } from '@owbase/node';
const client = new Client() .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API .setProject('<YOUR_PROJECT_ID>') // ID do projeto .setSession(''); // sessão do usuário
const locale = new Locale(client);
const result = await locale.listCodes({ total: false, // opcional});listContinents
Seção intitulada “listContinents”Listar continentes
SDK: @owbase/web e @owbase/node
Lista todos os continentes. Use o header locale para receber os dados num idioma aceito.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
total |
boolean |
não | Com false, o total não é calculado e volta como 0. |
Acesso: chave de API com o escopo locale.read ou sem chave nem sessão: basta o ID do projeto.
import { Client, Locale } from '@owbase/web';
const client = new Client() .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API .setProject('<YOUR_PROJECT_ID>'); // ID do projeto
const locale = new Locale(client);
const result = await locale.listContinents({ total: false, // opcional});
console.log(result);import { Client, Locale } from '@owbase/node';
const client = new Client() .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API .setProject('<YOUR_PROJECT_ID>') // ID do projeto .setSession(''); // sessão do usuário
const locale = new Locale(client);
const result = await locale.listContinents({ total: false, // opcional});listCountries
Seção intitulada “listCountries”Listar países
SDK: @owbase/web e @owbase/node
Lista todos os países. Use o header locale para receber os dados num idioma aceito.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
total |
boolean |
não | Com false, o total não é calculado e volta como 0. |
Acesso: chave de API com o escopo locale.read ou sem chave nem sessão: basta o ID do projeto.
import { Client, Locale } from '@owbase/web';
const client = new Client() .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API .setProject('<YOUR_PROJECT_ID>'); // ID do projeto
const locale = new Locale(client);
const result = await locale.listCountries({ total: false, // opcional});
console.log(result);import { Client, Locale } from '@owbase/node';
const client = new Client() .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API .setProject('<YOUR_PROJECT_ID>') // ID do projeto .setSession(''); // sessão do usuário
const locale = new Locale(client);
const result = await locale.listCountries({ total: false, // opcional});listCountriesEU
Seção intitulada “listCountriesEU”Listar países da UE
SDK: @owbase/web e @owbase/node
Lista todos os países que hoje fazem parte da União Europeia. Use o header locale para receber os dados num idioma aceito.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
total |
boolean |
não | Com false, o total não é calculado e volta como 0. |
Acesso: chave de API com o escopo locale.read ou sem chave nem sessão: basta o ID do projeto.
import { Client, Locale } from '@owbase/web';
const client = new Client() .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API .setProject('<YOUR_PROJECT_ID>'); // ID do projeto
const locale = new Locale(client);
const result = await locale.listCountriesEU({ total: false, // opcional});
console.log(result);import { Client, Locale } from '@owbase/node';
const client = new Client() .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API .setProject('<YOUR_PROJECT_ID>') // ID do projeto .setSession(''); // sessão do usuário
const locale = new Locale(client);
const result = await locale.listCountriesEU({ total: false, // opcional});listCountriesPhones
Seção intitulada “listCountriesPhones”Listar códigos telefônicos dos países
SDK: @owbase/web e @owbase/node
Lista os códigos telefônicos de todos os países. Use o header locale para receber os dados num idioma aceito.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
total |
boolean |
não | Com false, o total não é calculado e volta como 0. |
Acesso: chave de API com o escopo locale.read ou sem chave nem sessão: basta o ID do projeto.
import { Client, Locale } from '@owbase/web';
const client = new Client() .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API .setProject('<YOUR_PROJECT_ID>'); // ID do projeto
const locale = new Locale(client);
const result = await locale.listCountriesPhones({ total: false, // opcional});
console.log(result);import { Client, Locale } from '@owbase/node';
const client = new Client() .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API .setProject('<YOUR_PROJECT_ID>') // ID do projeto .setSession(''); // sessão do usuário
const locale = new Locale(client);
const result = await locale.listCountriesPhones({ total: false, // opcional});listCurrencies
Seção intitulada “listCurrencies”Listar moedas
SDK: @owbase/web e @owbase/node
Lista todas as moedas, com símbolo, nome, plural e casas decimais de todas as moedas principais e secundárias. Use o header locale para receber os dados num idioma aceito.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
total |
boolean |
não | Com false, o total não é calculado e volta como 0. |
Acesso: chave de API com o escopo locale.read ou sem chave nem sessão: basta o ID do projeto.
import { Client, Locale } from '@owbase/web';
const client = new Client() .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API .setProject('<YOUR_PROJECT_ID>'); // ID do projeto
const locale = new Locale(client);
const result = await locale.listCurrencies({ total: false, // opcional});
console.log(result);import { Client, Locale } from '@owbase/node';
const client = new Client() .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API .setProject('<YOUR_PROJECT_ID>') // ID do projeto .setSession(''); // sessão do usuário
const locale = new Locale(client);
const result = await locale.listCurrencies({ total: false, // opcional});listLanguages
Seção intitulada “listLanguages”Listar idiomas
SDK: @owbase/web e @owbase/node
Lista todos os idiomas classificados pela ISO 639-1, com o código de 2 letras, o nome em inglês e o nome no próprio idioma.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
total |
boolean |
não | Com false, o total não é calculado e volta como 0. |
Acesso: chave de API com o escopo locale.read ou sem chave nem sessão: basta o ID do projeto.
import { Client, Locale } from '@owbase/web';
const client = new Client() .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API .setProject('<YOUR_PROJECT_ID>'); // ID do projeto
const locale = new Locale(client);
const result = await locale.listLanguages({ total: false, // opcional});
console.log(result);import { Client, Locale } from '@owbase/node';
const client = new Client() .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API .setProject('<YOUR_PROJECT_ID>') // ID do projeto .setSession(''); // sessão do usuário
const locale = new Locale(client);
const result = await locale.listLanguages({ total: false, // opcional});As descrições desta página são traduções das que vêm da especificação da API do servidor (licença BSD-3-Clause), e os exemplos vêm do gerador de SDKs (licença MIT). Os avisos completos estão no arquivo NOTICE dos pacotes @owbase/web e @owbase/node.