Saltar al contenido principal

getAllEvents

Obtén todos los eventos disponibles.

Descripción​

Este método devuelve todos los eventos disponibles en el proyecto. Devuelve una Promesa que se resuelve en un array de objetos IContentApiEvent.

.getAllEvents(

);

Ejemplos​

Ejemplo mínimo​

const response = await Events.getAllEvents();

Respuesta de ejemplo​

[
  {
    "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"
  }
]

Esquema de respuesta​

Esquema: IContentApiEvent[]

id: número
Identificador del evento.
ejemplo: 1

identifier: cadena
Identificador de texto del evento.
ejemplo: "cambio_precio"

localizeInfos: Record<string, unknown>
Información localizada del evento.

module: cadena
Módulo al que pertenece el evento; ausente en eventos del sistema no vinculados a un módulo (por ejemplo, "enviar_código").
ejemplo: "catálogo"