getBlocks

Obtendo todos os objetos de bloco

Blocks.getBlocks(type, langCode, offset, limit)

const value = await Blocks.getBlocks('forTextBlock')

Esquema

type:* BlockType
Valores disponíveis: forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, forOrder, service
exemplo: forTextBlock

langCode: string
Códigos de idioma
exemplo: en_US

offset: number
Parâmetro para paginação. Padrão 0
exemplo: 0

limit: number
Parâmetro para paginação. Padrão 30
exemplo: 30

Este método retorna um array de todos os objetos de bloco e o total.

Exemplo de retorno:

{
  "total": 100,
  "items": [
    {
      "id": 1,
      "localizeInfos": {
        "title": "Bloco"
      },
      "version": 0,
      "position": 1,
      "identifier": "block",
      "type": "forTextBlock",
      "templateIdentifier": null,
      "isVisible": true,
      "attributeValues": {}
    }
  ]
}

Esquema

total: number
número total de registros encontrados
exemplo: 100

id: number
identificador do objeto
exemplo: 1764

attributeSetId: number
identificador do conjunto de atributos utilizado
exemplo: 7

localizeInfos: CommonLocalizeInfos
nome do bloco com localização
exemplo:

{
  "en_US": {
    "title": "Meu bloco"
  }
}

customSettings: BlockCustomSettings
configurações personalizadas para diferentes tipos de bloco
exemplo:

{
  "sliderDelay": 0,
  "sliderDelayType": "",
  "productQuantity": 4,
  "productSortType": "By_ID",
  "productSortOrder": "Descending",
  "productCountElementsPerRow": 10,
  "similarProductRules": [
    {
      "property": "Descending",
      "includes": "",
      "keywords": "",
      "strict": ""
    }
  ]
}

version: number
número da versão do objeto
exemplo: 10

identifier: string
identificador textual para o registro do campo
exemplo: catalog
padrão: marker

position: number
número da posição (para ordenação)
exemplo: 192

attributeValues: Record<string, string>
array de valores de atributos do índice (apresentado como um par de identificador de atributo personalizado: valor do atributo)
exemplo:

{
  "en_US": {
    "marker": {
      "value": "",
      "type": "string"
    }
  }
}

type: string
tipo de bloco
exemplo: forNewsPage

templateIdentifier: string
identificador do template usado pelo bloco (pode ser nulo)
Enum: [ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ]
exemplo: null

---