getTemplatePreviews

Obtendo todos os objetos de template.

Descrição

Este método recupera todos os objetos de template da API. Ele retorna uma Promise que se resolve em um array de objetos de template do tipo ITemplatesPreviewEntity.

TemplatePreviews.getTemplatePreviews(

langCode

);

Esquema de parâmetros

Esquema

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

Exemplos

Exemplo mínimo

const response = await TemplatePreviews.getTemplatePreviews();

Exemplo com atributos

const response = await TemplatePreviews.getTemplatePreviews('en_US');

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 de resposta

Esquema: ITemplatesPreviewEntity[]

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
Objeto que contém informações sobre as proporções da pré-visualização do template.
exemplo:

{
  "default": {
    "horizontal": {
      "width": 234,
      "height": 324,
      "alignmentType": "middleBottom"
    },
    "vertical": {
      "width": 2,
      "height": 3,
      "alignmentType": "leftTop"
    },
    "square": {
      "side": 3,
      "alignmentType": "leftTop"
    }
  }
}

proportions.horizontal: IProportion | null
Proporção horizontal da pré-visualização do template.
exemplo:

{
  "width": 234,
  "height": 324,
  "alignmentType": "middleBottom"
}

proportions.horizontal.width: string | number | null
largura da pré-visualização do template.
exemplo: 100

proportions.horizontal.height: string | number | null
altura da pré-visualização do template.
exemplo: 200

proportions.horizontal.alignmentType: string
tipo de alinhamento da pré-visualização do template.
exemplo: "center"

proportions.vertical: IProportion | null
Proporção vertical da pré-visualização do template.
exemplo:

{
  "width": 2,
  "height": 3,
  "alignmentType": "leftTop"
}

proportions.vertical.width: string | number | null
largura da pré-visualização do template.
exemplo: 100

proportions.vertical.height: string | number | null
altura da pré-visualização do template.
exemplo: 200

proportions.vertical.alignmentType: string
tipo de alinhamento da pré-visualização do template.
exemplo: "center"

proportions.square: ISquare
Proporção quadrada da pré-visualização do template.
exemplo:

{
  "side": 3,
  "alignmentType": "leftTop"
}

proportions.square.side: number | string
Comprimento do lado da pré-visualização do template quadrado, pode ser um número ou string.
exemplo: 100

proportions.square.alignmentType: string
Tipo de alinhamento da pré-visualização do template quadrado.
exemplo: "center"

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"

---