Skip to main content

RegisterBuiltinCommand

Description​

Registers a callback for Builtin commands.

Syntax​

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

Parameters​

NameOptionalityTypeDescription
eventToListenRequiredBuiltinCommandbuiltin commmand to listen to
eventSinkBaseRequiredFunctioncallback function to call

Return type​

TypeDescription
Promise < null | number >Registered callback ID which can be used to cancel the event listener