searchBlock

Pesquisa rápida por objetos de bloco com saída limitada. Retorna uma Promise que resolve para um array de objetos ISearchBlock.

Descrição

Este método realiza uma pesquisa rápida por objetos de bloco pelo nome com saída limitada (conjunto de resultados leve, adequado para autocompletar). Retorna uma Promise que resolve para um array de objetos ISearchBlock.

Blocks.searchBlock(

name*, langCode

);

Esquema de parâmetros

Esquema

name(obrigatório): string
String de pesquisa
exemplo: "product_block"

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

Exemplos

Exemplo mínimo

const response = await Blocks.searchBlock('my-marker');

Exemplo com atributos

const response = await Blocks.searchBlock('my-marker', 'en_US');

Exemplo de resposta

[
  {
    "id": 5,
    "identifier": "another",
    "name": "another"
  },
  {
    "id": 2,
    "identifier": "similar",
    "name": "similar"
  }
]

Esquema de resposta

Esquema: ISearchBlock[]

id: number
Identificador único do bloco de pesquisa.
exemplo: 1

identifier: string
Identificador de string único para o bloco de pesquisa.
exemplo: "search_block_1"

name: string
Nome do bloco de pesquisa.
exemplo: "Search Block 1"

---