getSlides

Obtenha a árvore de slides do bloco como um array plano em pré-ordem (apenas slider_block).

Descrição

Este método retorna os slides de um bloco de slider como um array plano em pré-ordem - cada item carrega seu depth e parentId, para que você possa reconstruir a árvore no cliente. Funciona apenas para blocos do tipo slider_block. Retorna uma Promise que resolve para um objeto IBlockSlidesResponse.

Blocks.getSlides(

marker*

);

Esquema de parâmetros

Esquema

marker(obrigatório): string
Marcador do bloco
exemplo: "slider_block"

Exemplos

Exemplo mínimo

const response = await Blocks.getSlides('slider_block');

Exemplo de resposta

{
  "total": 3,
  "time": 5,
  "timeInterval": "sec",
  "items": [
    {
      "id": 1,
      "parentId": null,
      "depth": 0,
      "position": 1,
      "visible": true,
      "time": 5,
      "timeInterval": "sec",
      "attributeValues": {}
    },
    {
      "id": 2,
      "parentId": 1,
      "depth": 1,
      "position": 1,
      "visible": true,
      "attributeValues": {}
    }
  ]
}

Esquema de resposta

Esquema: IBlockSlidesResponse

total: number
Número total de slides.
exemplo: 3

time: number
Tempo de exibição padrão para os slides.
exemplo: 5

timeInterval: 'sec' | 'ms'
Unidade do campo de tempo.
exemplo: "sec"

items: IBlockSlideItem[]
Array plano em pré-ordem de itens de slide.

items.id: number
Identificador do slide.
exemplo: 1

items.parentId: number | null
Identificador do slide pai, ou null para slides raiz.
exemplo: null

items.depth: number
Profundidade do slide na árvore.
exemplo: 0

items.position: number
Posição do slide entre seus irmãos.
exemplo: 1

items.visible: boolean
Se o slide é visível.
exemplo: true

items.time: number
Tempo de exibição para o slide.
exemplo: 5

items.timeInterval: 'sec' | 'ms'
Unidade do campo de tempo.
exemplo: "sec"

items.attributeValues: IAttributeValues
Mapa de valores de atributos indexados por marcador.

---