Pular para o conteúdo principal

getLocales

Obter todas as localidades ativas.

Descrição​

Busca as localidades ativas do projeto e resolve para um array de objetos ILocalEntity.

.getLocales();

Exemplos​

Exemplo mínimo​

const response = await Locales.getLocales();

Exemplo de resposta​

[
  {
    "id": 146,
    "shortCode": "en",
    "code": "en_US",
    "name": "English (USA)",
    "nativeName": "English (USA)",
    "isActive": true,
    "image": null,
    "position": 1
  },
  {
    "id": 48,
    "shortCode": "ru",
    "code": "ru_RU",
    "name": "Russian",
    "nativeName": "русский язык",
    "isActive": true,
    "image": null,
    "position": 2
  }
]

Esquema de resposta​

Esquema: ILocalEntity[]

id: número
ID do idioma.
exemplo: 1

shortCode: string
Código curto do idioma, por exemplo "en".
exemplo: "en"

code: string
Código completo do idioma, como en_US.
exemplo: "en_US"

name: string
Nome do idioma.
exemplo: "Inglês"

nativeName: string
Nome do idioma no próprio idioma.
exemplo: "Inglês"

isActive: boolean
Se o idioma está ativo.
exemplo: true

image: string | null
Imagem associada ao idioma.
exemplo: "https://example.com/images/en.png"

position: número
Posição do idioma na lista.
exemplo: 1