Pular para o conteúdo principal

searchBlock

Busca rápida por objetos de bloco com saída limitada.

Descrição​

Blocos.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": 5,
    "identifier": "another",
    "name": "another"
  },
  {
    "id": 2,
    "identifier": "similar",
    "name": "similar"
  }
]

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: "Bloco de Busca 1"