Pular para o conteúdo principal

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": {},
"localizeInfos": {
"title": "Texto dos Admins"
},
"additionalFields": []
}

Esquema de resposta

Esquema: IAttributesSetsEntity

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

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

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[] | Record<string, any>
Array de valores (com dados estendidos) para atributos de lista e radioButton.
exemplo:

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

validators: Record<string, any>
Conjunto de validadores para validação.
exemplo:

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

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

{
"title": "Meu atributo"
}

additionalFields: Record<string, any>
Campos adicionais para o atributo (opcional).

settings: Record<string, any>
Configurações adicionais do atributo (opcional).