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": 4,
    "identifier": "send_code",
    "localizeInfos": {
      "title": "Code"
    }
  },
  {
    "id": 3,
    "identifier": "registration_event",
    "localizeInfos": {
      "title": "Registration"
    }
  },
  {
    "id": 2,
    "identifier": "lessPrice",
    "localizeInfos": {
      "title": "less price"
    },
    "module": "catalog"
  }
]

Schéma de réponse​

Schéma : IContentApiEvent[]

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.

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