Code0 LogoCodeZero

EventManager

Stores registered public-facing event definitions

EventManager stores all public-facing event definitions registered via action.registerEventClass(). It extends BaseManager with key type string (identifier) and value type EventModel.

action.events.get('user_created_event');
action.events.values();

Interfaces

EventModel

The descriptor stored for each registered event.

interface EventModel {
  identifier: string;
  settings?: EventSettingProps[];
  signature: string;
  editable?: boolean;
  name?: Translation[];
  description?: Translation[];
  documentation?: Translation[];
  displayMessage?: Translation[];
  alias?: Translation[];
  displayIcon?: string;
  runtimeIdentifier?: string;
}

Prop

Type

EventSettingProps

Configuration settings that users can provide for an event (e.g. filters, options).

interface EventSettingProps {
  identifier: string;
  unique?: FlowTypeSetting_UniquenessScope;
  linkedDataTypeIdentifiers?: string[];
  defaultValue?: PlainValue;
  name?: Translation[];
  description?: Translation[];
  optional?: boolean;
  hidden?: boolean;
}

Prop

Type

On this page