Aller au contenu principal

getAllEvents

Obtenez tous les événements disponibles.

Description​

Cette méthode renvoie tous les événements disponibles dans le projet. Elle renvoie une Promesse qui se résout en un tableau d'objets IContentApiEvent.

Événements.getAllEvents(

);

Exemples​

Exemple minimal​

const response = await Events.getAllEvents();

Réponse d'exemple​

[
  {
    "id": 1,
    "identifier": "price_change",
    "localizeInfos": {
      "title": "Price change"
    },
    "module": "catalog"
  }
]

Schéma de réponse​

Schéma : IContentApiEvent[]

[]: IContentApiEvent
Un seul événement disponible.

[].id: number
Identifiant de l'événement.
exemple : 1

[].identifier: string
Identifiant textuel de l'événement.
exemple : "price_change"

[].localizeInfos: Record<string, unknown>
Infos localisées de l'événement.
exemple : { "title": "Changement de prix" }

[].module: string
Module auquel appartient l'événement.
exemple : "catalog"