Aller au contenu principal

getTemplatePreviews

Récupération de tous les objets de modèle.

TemplatePreviews?.getTemplatePreviews( langCode? );

Exemple minimal

const value = await TemplatePreviews.getTemplatePreviews()
Schéma

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

Cette méthode récupère tous les objets de modèle depuis l'API. Elle renvoie une promesse qui se résout en un tableau d'objets de modèle TemplatePreviewsEntity.

Exemple de réponse

[
{
"id": 3,
"title": "Aperçu des modèles",
"proportions": {
"default": {
"horizontal": {
"width": 234,
"height": 324,
"alignmentType": "middleBottom"
},
"vertical": {
"width": 2,
"height": 3,
"alignmentType": "leftTop"
},
"square": {
"side": 3,
"alignmentType": "leftTop"
}
}
},
"identifier": "preview-templates",
"version": 0,
"attributeValues": {},
"position": 1,
"isUsed": false
}
]
Schéma

id: number
L'identifiant unique de la position.
exemple : 3

title: string
Le nom de l'aperçu du modèle.
exemple : "Modèle de produit".

proportions: object
L'objet contient des informations sur les proportions de l'aperçu du modèle.

identifier: string
L'identifiant textuel pour le champ d'enregistrement.
exemple : "preview-templates"

version: number
Le numéro de version de l'objet.
exemple : 1

attributeValues: AttributeType
Valeurs d'attribut de l'index.
exemple :

{}

position: number
La position de l'objet.
exemple : 1

attributeSetIdentifier: string | null
Identifiant textuel utilisé pour un ensemble d'attributs.
exemple : "attribute_set_1".