Skip to main content

ExecuteCommand

Description

Executes a user command.

Syntax

// Execute a new custom command with data parameter
await shellFrame.Commands.ExecuteCommand(commandId, {
someCustomData: 1234
});

Parameters

NameOptionalityTypeDescription
commandIdRequirednumberThe command id. Can be a built-in command enumerated value or custom command id.
argsOptionalanyCommand argument or an arguments object, if the command requires arguments.
TODO: Any type should be replaced with the actual type of the argument.
Use null or empty value if the command does not require arguments.

Return type

TypeDescription
Promise < void >Method does not return a value