getSingleAttributeByMarkerSet

Obtendo um atributo com dados do conjunto de atributos.

Descrição

Este método retorna um único atributo com dados dos conjuntos de atributos. Ele retorna uma Promise que resolve para um objeto IAttributesSetsEntity.

AttributesSets.getSingleAttributeByMarkerSet(

setMarker*, attributeMarker*, langCode

);

Esquema de parâmetros

Esquema

setMarker(obrigatório): string
Identificador de texto (marcador) do conjunto de atributos
exemplo: "productAttributes"

attributeMarker(obrigatório): string
Identificador de texto (marcador) do atributo no conjunto
exemplo: "color"

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

Exemplos

Exemplo mínimo

const response = await AttributesSets.getSingleAttributeByMarkerSet('list1', 'list1');

Exemplo com atributo langCode

const response = await AttributesSets.getSingleAttributeByMarkerSet('list1', 'list1', 'en_US');

Exemplo de resposta

{
  "type": "string",
  "value": {},
  "marker": "admin-text",
  "position": 1,
  "listTitles": [],
  "validators": {},
  "initialValue": null,
  "localizeInfos": {
    "title": "Admins text"
  },
  "additionalFields": {}
}

Esquema de resposta

Esquema: IAttributesSetsEntity

type: AttributeType
Tipo de atributo.
exemplo: "string", "text", "integer", "etc"

value: unknown
Valor do atributo, que pode ser de qualquer tipo.

initialValue: unknown
Valor inicial do atributo.

marker: string
Identificador textual do atributo (marcador).
exemplo: "color", "size", "etc"

position: number
Número da posição para ordenação.
exemplo: 1

listTitles: IListTitle[]
Array de valores (com dados estendidos) para atributos de lista e radioButton; array vazio para tipos não listados.
exemplo:

[
  {
    "title": "red",
    "value": 1,
    "position": 1,
    "extendedValue": null,
    "extendedValueType": null
  },
  {
    "title": "yellow",
    "value": 2,
    "position": 2,
    "extendedValue": null,
    "extendedValueType": null
  }
]

listTitles.title: string
O título ou nome associado ao item da lista.
exemplo: "Nome do Item"

listTitles.value: number | string
O valor do item da lista, que pode ser um número ou uma string dependendo do contexto.
exemplo: 42

listTitles.position: string | number | null
A posição do item da lista, que pode ser representada como uma string, número ou null se não aplicável.
exemplo: 1

listTitles.extended: object
Um objeto contendo propriedades ou metadados adicionais relacionados ao item da lista. Isso pode incluir quaisquer detalhes extras que ampliem as informações básicas.

listTitles.extended.value: string | null
O valor estendido, que pode ser uma string ou null.
exemplo: "extra_value"

listTitles.extended.type: string | null
O tipo do valor estendido, que pode ser uma string ou null.
exemplo: "color"

validators: IAttributeValidators
Conjunto de validadores para validação; objeto vazio quando nenhum validador está configurado.
exemplo:

{
  "requiredValidator": {
    "strict": true
  },
  "defaultValueValidator": {
    "fieldDefaultValue": 11
  }
}

validators.requiredValidator: object
Marca o campo como obrigatório. Forma: { strict: boolean }.
exemplo: { strict: true }

validators.stringInspectionValidator: object
Restrições de comprimento para campos de string. Forma: { stringMin: number; stringMax: number; stringLength: number }.

validators.emailInspectionValidator: boolean
Alternar para validação de formato de e-mail.

validators.defaultValueValidator: object
Configuração de valor padrão com texto de erro personalizado opcional. Forma: { customErrorText?: string; fieldDefaultValue?: unknown; fieldDefaultValue2?: unknown }.

localizeInfos: IAttributeLocalizeInfo
O nome do template, levando em consideração a localização.
exemplo:

{
  "title": "My attribute"
}

additionalFields: Record<string, IAttributesSetsEntity>
Atributos sub-nested indexados por marcador; objeto vazio quando nenhum.

---