searchBlock

Busca 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 busca 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 busca
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": 12,
    "identifier": "repeat",
    "name": "Repeat"
  },
  {
    "id": 10,
    "identifier": "personal",
    "name": "Personal"
  },
  {
    "id": 9,
    "identifier": "similar_wishlist",
    "name": "Similar wishlist"
  },
  "..."
]

Esquema de resposta

Esquema: ISearchBlock[]

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

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

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

---