getChildUserGroupsByMarker

Obteniendo los grupos hijos de un grupo de usuarios.

Descripción

Este método recupera los grupos hijos de un grupo de usuarios por el marcador del padre. La anidación se recorre con este método en lugar de a través de parentId. Un grupo sin hijos devuelve un array vacío. Devuelve una Promesa que se resuelve en un array de objetos IUserGroupEntity.

UserGroups.getChildUserGroupsByMarker(marker, langCode);

Parámetros

marker: string
Identificador de texto del grupo de usuarios padre.
ejemplo: "guest"

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

Ejemplos

Ejemplo mínimo

const response = await UserGroups.getChildUserGroupsByMarker('guest');

Ejemplo de respuesta

[]

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

---