Aller au contenu principal

searchBlock

Recherche rapide d'objets de bloc avec une sortie limitée. Elle renvoie une Promesse qui se résout en un tableau d'objets ISearchBlock.

Description​

Cette méthode effectue une recherche rapide d'objets de bloc par nom avec une sortie limitée (ensemble de résultats léger, adapté à l'autocomplétion). Elle renvoie une Promesse qui se résout en un tableau d'objets ISearchBlock.

.searchBlock(

,

);

Parameters schema​

Schema

name(obligatoire): string
Chaîne de recherche
exemple : "product_block"

langCode: string
Code de langue. Par défaut : "en_US"
exemple : "en_US"

Examples​

Minimal example​

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

Example with attributes​

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

Example response​

[
{
"id": 12,
"identifier": "repeat",
"name": "Repeat"
},
{
"id": 10,
"identifier": "personal",
"name": "Personal"
},
{
"id": 9,
"identifier": "similar_wishlist",
"name": "Similar wishlist"
},
"..."
]

Response schema​

Schema: ISearchBlock[]

id: number
Identifiant unique du bloc de recherche.
exemple : 1

identifier: string
Identifiant unique sous forme de chaîne pour le bloc de recherche.
exemple : "search_block_1"

name: string
Nom du bloc de recherche.
exemple : "Search Block 1"