getUserGroupByMarker

Obtendo um único objeto de grupo de usuário pelo seu marcador.

Descrição

Este método recupera um único objeto de grupo de usuário pelo seu identificador de texto (marcador). Ele retorna uma Promise que resolve para um objeto IUserGroupEntity.

UserGroups.getUserGroupByMarker(marker, langCode);

Parâmetros

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

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

Exemplos

Exemplo mínimo

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

Exemplo de resposta

{
  "id": 1,
  "depth": 0,
  "parentId": null,
  "localizeInfos": {
    "title": "Guest"
  },
  "isVisible": true,
  "childrenCount": "0",
  "identifier": "guest",
  "isSync": false,
  "attributeValues": {},
  "version": 0
}

Esquema de resposta

Esquema: IUserGroupEntity

id: number
Identificador do grupo de usuário.
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 está presente em todos os stands.
exemplo: NaN

---