Pular para o conteúdo principal

getUserGroups

Obter todos os grupos de usuários.

Descrição​

Busca todos os grupos de usuários do projeto em um array plano, independentemente do aninhamento. Resolve para um array de objetos IUserGroupEntity.

.getUserGroups(

);

Esquema de parâmetros​

Schema

langCode: string
Código do idioma. Padrão: o langCode passado para defineOneEntry ("en_US" se nenhum for passado).
exemplo: "en_US"

Exemplos​

Exemplo mínimo​

const response = await UserGroups.getUserGroups();

Com código de idioma​

const response = await UserGroups.getUserGroups('en_US');

Exemplo de resposta​

[
  {
    "id": 1,
    "depth": 0,
    "parentId": null,
    "localizeInfos": {
      "title": "Guest"
    },
    "isVisible": true,
    "childrenCount": "0",
    "identifier": "guest",
    "isSync": false,
    "attributeValues": {}
  },
  {
    "id": 2,
    "depth": 0,
    "parentId": null,
    "localizeInfos": {
      "title": "sd"
    },
    "isVisible": true,
    "childrenCount": "0",
    "identifier": "wewe",
    "isSync": false,
    "attributeValues": {}
  }
]

Esquema de resposta​

Esquema: IUserGroupEntity[]

id: number
ID do grupo de usuários.
exemplo: 1

depth: number
Nível do grupo na árvore: 0 para um grupo de nível superior; para um filho, o depth do pai mais 1.
exemplo: 0

parentId: number | null
Identificador do grupo pai, null para um grupo de nível superior.
exemplo: null

localizeInfos: ILocalizeInfo
Título localizado do grupo.

isVisible: boolean
Se o grupo está visível.
exemplo: true

childrenCount: string
Número de grupos filhos. A API o envia como string, não como número.
exemplo: "0"

identifier: string
Identificador textual (marcador) do grupo.
exemplo: "guest"

isSync: boolean
Se o índice de atributos do grupo está construído para o idioma solicitado. Quando false, um attributeValues vazio significa que os valores ainda não foram indexados, e não que não existam.
exemplo: false

attributeValues: IAttributeValues
Valores de atributos do grupo.

version: number
Número da versão do grupo. Retornado apenas por getUserGroupById() e getUserGroupByMarker(); os métodos de listagem (getUserGroups(), getRootUserGroups(), getChildUserGroupsByMarker()) o omitem.