getChildUserGroupsByMarker

Obtendo os grupos filhos de um grupo de usuários.

Descrição

Este método recupera os grupos filhos de um grupo de usuários pelo marcador do pai. A aninhamento é percorrida com este método em vez de através do parentId. Um grupo sem filhos retorna um array vazio. Ele retorna uma Promise que resolve para um array de objetos IUserGroupEntity.

UserGroups.getChildUserGroupsByMarker(marker, langCode);

Parâmetros

marker: string
Identificador de texto do grupo de usuários pai.
exemplo: "guest"

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

Exemplos

Exemplo mínimo

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

Exemplo de resposta

[]

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 stands.
exemplo: NaN

---