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": 1,
"identifier": "price_change",
"localizeInfos": {
"title": "Price change"
},
"module": "catalog"
}
]

Esquema de resposta

Esquema: IContentApiEvent[]

[]: IContentApiEvent
Um único evento disponível.

[].id: number
Identificador do evento.
exemplo: 1

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

[].localizeInfos: Record<string, unknown>
Informações localizadas do evento.
exemplo: { "title": "Mudança de preço" }

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