Aller au contenu principal

Introduction

Récupérez les types d'entités à l'échelle du système qui classifient vos pages, formulaires, blocs et produits.

Plus d'informations sur l'interface utilisateur du module : https://doc.oneentry.cloud/docs/attributes/types/#General-Type-Attributes

🎯 Que fait ce module ?​

Le module GeneralTypes vous permet de récupérer les types d'entités à l'échelle du système - types de pages, types de formulaires, types de blocs et types de produits - qui définissent les catégories de contenu dans votre projet OneEntry. OneEntry utilise un ensemble fixe de types système (BlockType) pour classer les pages (common_page, catalog_page, external_page, error_page), les formulaires (form), les blocs (common_block, product_block, slider_block, …), et les produits (product, service). Ce module est en lecture seule.

🚀 Démarrage rapide​

Initialisez le module depuis defineOneEntry :


const { GeneralTypes } = defineOneEntry(
  "your-project-url", {
    "token": "your-app-token"
  }
);

Récupérez tous les types et utilisez-les :

// Returns a combined list of types across all entities.
const types = await GeneralTypes.getAllTypes();
// e.g. [{ id: 1, type: "product" }, { id: 2, type: "common_page" }, ...]

// Filter manually - there is no built-in per-entity filter.
const pageTypes = types.filter((t) => t.type.endsWith("_page"));

console.log(pageTypes);

✨ Concepts clés​

Système de types​

OneEntry classe chaque entité par une valeur BlockType :

EntitéExemples de types (BlockType)Objectif
Pagescommon_page, catalog_page, external_page, error_pageDéfinir les mises en page et la fonctionnalité des pages
FormulairesformCatégoriser les objectifs des formulaires
Blocscommon_block, product_block, slider_blockBlocs de construction pour pages/produits
Produitsproduct, serviceClassifier l'inventaire des produits

Structure de l'entité de type​

Chaque type retourné par getAllTypes() est une GeneralTypeEntity :

interface GeneralTypeEntity {
  id: number;        // Unique numeric ID (e.g. 1, 2, 3)
  type: BlockType;   // Type name (e.g. "product", "common_page", "form")
}

📋 Ce que vous devez savoir​

Les types sont des catégories système prédéfinies​

Vous ne créez pas de types via le SDK - ce sont un ensemble fixe de catégories système (BlockType) définies par la plateforme. GeneralTypes ne fait que récupérer la liste des types présents dans votre projet. Toute gestion des types se fait dans le panneau d'administration OneEntry.

getAllTypes() retourne TOUS les types à travers toutes les entités​

La méthode retourne une liste combinée de types provenant des pages, formulaires, blocs, produits et d'autres entités. Il n'y a pas de filtrage intégré par catégorie d'entité, donc filtrez le résultat manuellement (par exemple, t.type.endsWith('_page')).

Type vs. Marqueur vs. ID​

IdentifiantCe que c'estExempleMeilleur pour
TypeCatégorie/classification de l'entité"catalog_page"Filtrage et regroupement
MarqueurIdentifiant unique lisible par l'homme"my_about_page"Récupération d'entités spécifiques
IDIdentifiant numérique de base de données42Utilisation interne du système

Utilisez la chaîne type dans votre logique de code (par exemple, if (page.type === 'catalog_page')) - elle est stable à travers les environnements, tandis que id peut différer.

📊 Tableau de référence rapide​

MéthodeDescriptionCas d'utilisation
getAllTypes()Récupère tous les types généraux dans le systèmeRemplir des listes déroulantes, valider des types

❓ Questions fréquentes (FAQ)​

Comment créer de nouveaux types ?​

Vous ne pouvez pas - les types sont un ensemble fixe de catégories système (BlockType) et le module est en lecture seule. Récupérez ceux disponibles dans votre projet avec getAllTypes().

Comment filtrer les types par entité (pages, formulaires, produits) ?​

getAllTypes() retourne tous les types à travers toutes les entités. Filtrez le résultat manuellement, par exemple types.filter(t => t.type.endsWith('_page')).

Puis-je mettre à jour ou supprimer des types via le SDK ?​

Non. Le module GeneralTypes est en lecture seule - toute gestion des types se fait dans le panneau d'administration OneEntry.

Quelle est la différence entre l'ID de type et le nom de type ?​

Utilisez la chaîne type pour votre logique de code et vos comparaisons (stable à travers les environnements). Le numéro id est pour les références internes de la base de données et peut changer entre les projets.

Puis-je mettre en cache la liste des types ?​

Oui - les types changent rarement, donc le cache est recommandé.

🎓 Meilleures pratiques​

  • Récupérez les types dynamiquement - ne codifiez pas en dur les listes de types.
  • Utilisez la chaîne type, pas l'id - les noms de types sont stables à travers les environnements.
  • Filtrez manuellement - getAllTypes() retourne les types de chaque entité dans une seule liste.
  • Mettez en cache la liste - elle change rarement.
  • Gérez les types inconnus avec grâce - fournissez un rendu de secours.

🔗 Documentation connexe​