Class EventHandler<S>

Class that collects all triggered events up to a certain limit of events and handle logic to handle subscriptions (TBD)

Type Parameters

S extends Storage = any

Index

Constructors

Accessors

Methods

cleanUpEvents clear getEvents pushEvent [create] create

Constructors

constructor

new EventHandler<S>(eventStorage): EventHandler<S>
Type Parameters
- S extends Storage = any
Parameters
- eventStorage: StorageContext<S>
Returns EventHandler<S>
- Defined in packages/protocol/src/interaction/EventHandler.ts:85

Accessors

construction

get construction(): Construction<EventHandler<any>>
Returns Construction<EventHandler<any>>
- Defined in packages/protocol/src/interaction/EventHandler.ts:69

Methods

cleanUpEvents

cleanUpEvents(): void
Returns void
- Defined in packages/protocol/src/interaction/EventHandler.ts:157

clear

clear(): Promise<void>
Returns Promise<void>
- Defined in packages/protocol/src/interaction/EventHandler.ts:93

getEvents

getEvents(eventPath, filters?, filterForFabricIndex?): EventStorageData<any>[]
Parameters
- eventPath: TypeFromFields<{
      clusterId: OptionalFieldType<ClusterId>;
      endpointId: OptionalFieldType<EndpointNumber>;
      eventId: OptionalFieldType<EventId>;
      isUrgent: OptionalFieldType<boolean>;
      nodeId: OptionalFieldType<NodeId>;
  }>
- Optionalfilters: TypeFromFields<{
  eventMin: FieldType<number | bigint>;
  nodeId: OptionalFieldType<NodeId>;
  }>[]
- OptionalfilterForFabricIndex: FabricIndex
Returns EventStorageData<any>[]
- Defined in packages/protocol/src/interaction/EventHandler.ts:103

pushEvent

pushEvent(event): StorageOperationResult<S, EventStorageData<any>>
Parameters
- event: EventData<any>
Returns StorageOperationResult<S, EventStorageData<any>>
- Defined in packages/protocol/src/interaction/EventHandler.ts:138

`Static`[create]

[create](env): EventHandler<any>
Parameters
- env: Environment
Returns EventHandler<any>
- Defined in packages/protocol/src/interaction/EventHandler.ts:79

`Static`create

create(eventStorage): Promise<EventHandler<any>>
Parameters
- eventStorage: StorageContext<any>
Returns Promise<EventHandler<any>>
- Defined in packages/protocol/src/interaction/EventHandler.ts:73