getUserGroups

Obteniendo todos los objetos de grupos de usuarios.

Descripción

Este método recupera cada grupo de usuarios del proyecto como un array plano, sin importar la anidación. Devuelve una Promesa que se resuelve en un array de objetos IUserGroupEntity.

UserGroups.getUserGroups(langCode);

Parámetros

langCode: string (opcional)
Código de idioma. Predeterminado: "en_US".
ejemplo: "en_US"

Ejemplos

Ejemplo mínimo

const response = await UserGroups.getUserGroups();

Con un código de idioma

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

Ejemplo de respuesta

[
  {
    "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 respuesta

Esquema: IUserGroupEntity[]

id: number
Identificador del grupo de usuarios.
ejemplo: 1

depth: number
Profundidad de anidación relativa al padre.
ejemplo: 0

parentId: number | null
Identificador del grupo padre, null para un grupo de nivel superior.
ejemplo: null

localizeInfos: ILocalizeInfo
Título del grupo, teniendo en cuenta la localización.

isVisible: boolean
Indicador de visibilidad.
ejemplo: true

childrenCount: string
Número de grupos hijos. La API lo envía como una cadena, no como un número.
ejemplo: "0"

identifier: string
Identificador de texto (marcador) del grupo.
ejemplo: "guest"

isSync: boolean
Indicador de sincronización.
ejemplo: false

attributeValues: IAttributeValues
Valores de atributos del grupo.

version: number
Versión del objeto. No presente en cada stand.
ejemplo: NaN

---