getUserGroupByMarker

Obter um único grupo de usuários pelo seu marcador.

Descrição

Busca um grupo de usuários pelo marcador (identificador textual) e resolve para um IUserGroupEntity. Se nenhum grupo tiver esse marcador, resolve para um IError com statusCode: 404 ("Group not found").

.getUserGroupByMarker(

,

);

Esquema de parâmetros

Schema

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

langCode: string
Código do idioma. Padrão: o langCode passado para defineOneEntry ("en_US" se nenhum for passado).
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
ID do grupo de usuários.
exemplo: 1

depth: number
Nível do grupo na árvore: 0 para um grupo de nível superior; para um filho, o depth do pai mais 1.
exemplo: 0

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

localizeInfos: ILocalizeInfo
Título localizado do grupo.

isVisible: boolean
Se o grupo está visível.
exemplo: true

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

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

isSync: boolean
Se o índice de atributos do grupo está construído para o idioma solicitado. Quando false, um attributeValues vazio significa que os valores ainda não foram indexados, e não que não existam.
exemplo: false

attributeValues: IAttributeValues
Valores de atributos do grupo.

version: number
Número da versão do grupo. Retornado apenas por getUserGroupById() e getUserGroupByMarker(); os métodos de listagem (getUserGroups(), getRootUserGroups(), getChildUserGroupsByMarker()) o omitem.

---