Pular para o conteúdo principal

getTemplatePreviews

Obtendo todos os objetos de template.

TemplatePreviews?.getTemplatePreviews( langCode? );

Exemplo mínimo

const value = await TemplatePreviews.getTemplatePreviews()
Esquema

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

Este método recupera todos os objetos de template da API. Ele retorna uma Promise que resolve para um array de objetos de template TemplatePreviewsEntity.

Exemplo de resposta

[
{
"id": 3,
"title": "Modelos de Pré-visualização",
"proportions": {
"default": {
"horizontal": {
"width": 234,
"height": 324,
"alignmentType": "middleBottom"
},
"vertical": {
"width": 2,
"height": 3,
"alignmentType": "leftTop"
},
"square": {
"side": 3,
"alignmentType": "leftTop"
}
}
},
"identifier": "preview-templates",
"version": 0,
"attributeValues": {},
"position": 1,
"isUsed": false
}
]
Esquema

id: number
O identificador único da posição.
exemplo: 3

title: string
O nome da pré-visualização do template.
exemplo: "Modelo de Produto".

proportions: object
O objeto contém informações sobre as proporções da pré-visualização do template.

identifier: string
O identificador textual para o campo do registro.
exemplo: "preview-templates"

version: number
O número da versão do objeto.
exemplo: 1

attributeValues: AttributeType
Valores de atributos do índice.
exemplo:

{}

position: number
A posição do objeto.
exemplo: 1

attributeSetIdentifier: string | null
Identificador textual usado para um conjunto de atributos.
exemplo: "attribute_set_1".