Skip to main content

Register

Description

Registers a handler object/function for handling the specified type of events.

Syntax

// The events interface is available under most objects
const result = await shellFrame.Events.Register(eventToListen, eventSink);

Parameters

NameOptionalityTypeDescription
eventToListenRequiredEventThe event type to handle.
eventSinkRequiredFunctionThe event sink to register.

Return type

TypeDescription
Promise < null | number >Returns handle to the registered event handler.
This handle can be used later to unregister the handler.