Class: CustomEventDataProxy

Provides event data for OnCustomEventDataReceived, handling page-level custom events via executeCustomEvent().

Hierarchy

• EventDataProxy

• CustomEventDataProxy

Implements

• IBaseEventData
• ICustomEventData

Summary

Constructors

• constructor

Properties

Class Properties

Currently none in this class.

Inherited Properties

Currently none inherited from the parent class(es).

Accessors

Class Accessors

• eventData
• eventType

Inherited Accessors

• eventName

Methods

Class Methods

Currently none in this class.

Inherited Methods

Currently none inherited from the parent class(es).

Constructors

Constructor

+ new CustomEventDataProxy(eventType: string, eventData: any): CustomEventDataProxy

Overrides EventDataProxy.constructor

Parameters:

Name	Type
eventType	string
eventData	any

Returns: CustomEventDataProxy

Accessors

eventData

Get Signature

▸ getter

Retrieves the custom event data object passed to executeCustomEvent().

Example

const data = context.getEventData().eventData; // e.g. { category: 'orders', page: 1 }

Returns

any

Retrieves the custom event data object passed to executeCustomEvent().

Implementation of ICustomEventData.eventData

---

eventType

Get Signature

▸ getter

Retrieves the custom event type string passed to executeCustomEvent().

Example

const type = context.getEventData().eventType; // e.g. 'RefreshData'

Returns

string

Retrieves the custom event type string passed to executeCustomEvent().

Implementation of ICustomEventData.eventType