getRootUserGroups

Obtendo todos os objetos de grupos de usuários de nível superior.

Descrição

Este método recupera os grupos de usuários de nível superior - aqueles sem um pai. Ele retorna uma Promise que resolve para um array de objetos IUserGroupEntity.

UserGroups.getRootUserGroups(langCode);

Parâmetros

langCode: string (opcional)
Código do idioma. Padrão: "en_US".
exemplo: "en_US"

Exemplos

Exemplo mínimo

const response = await UserGroups.getRootUserGroups();

Resposta de exemplo

[
  {
    "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
Identificador do grupo de usuários.
exemplo: 1

depth: number
Profundidade de aninhamento em relação ao pai.
exemplo: 0

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

localizeInfos: ILocalizeInfo
Título do grupo, levando em conta a localização.

isVisible: boolean
Flag de visibilidade.
exemplo: true

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

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

isSync: boolean
Flag de sincronização.
exemplo: false

attributeValues: IAttributeValues
Valores de atributos do grupo.

version: number
Versão do objeto. Não presente em todos os casos.
exemplo: NaN

---