Pular para o conteúdo principal

getAllEvents

Obtenha todos os eventos disponíveis.

Descrição​

Este método retorna todos os eventos disponíveis no projeto. Ele retorna uma Promise que resolve para um array de objetos IContentApiEvent.

Eventos.getAllEvents(

);

Exemplos​

Exemplo mínimo​

const response = await Events.getAllEvents();

Resposta de exemplo​

[
  {
    "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 resposta​

Esquema: IContentApiEvent[]

id: número
Identificador do evento.
exemplo: 1

identifier: string
Identificador de texto do evento.
exemplo: "price_change"

localizeInfos: Record<string, unknown>
Informações localizadas do evento.

module: string
Módulo ao qual o evento pertence.
exemplo: "catalog"