Saltar al contenido principal

searchBlock

Búsqueda rápida de objetos de bloque con salida limitada. Devuelve una Promesa que se resuelve en un array de objetos ISearchBlock.

Descripción

Este método realiza una búsqueda rápida de objetos de bloque por nombre con salida limitada (conjunto de resultados ligero, adecuado para autocompletar). Devuelve una Promesa que se resuelve en un array de objetos ISearchBlock.

Blocks.searchBlock(

name*, langCode

);

Esquema de parámetros

Esquema

name(requerido): string
Cadena de búsqueda
ejemplo: "product_block"

langCode: string
Código de idioma. Predeterminado: "en_US"
ejemplo: "en_US"

Ejemplos

Ejemplo mínimo

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

Ejemplo con atributos

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

Ejemplo de respuesta

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

Esquema de respuesta

Esquema: ISearchBlock[]

id: number
Identificador único del bloque de búsqueda.
ejemplo: 1

identifier: string
Identificador de cadena único para el bloque de búsqueda.
ejemplo: "search_block_1"

name: string
Nombre del bloque de búsqueda.
ejemplo: "Bloque de Búsqueda 1"