Interface CustomCommand`Beta`

Define the custom command, including name, permissions, and parameters.

interface CustomCommand {
    description: string;
    mandatoryParameters?: CustomCommandParameter[];
    name: string;
    optionalParameters?: CustomCommandParameter[];
    permissionLevel: CustomCommandPermissionLevel;
}

Index

Properties

description mandatoryParameters? name optionalParameters? permissionLevel

Properties

`Beta`description

description: string

Remarks

Command description as seen on the command line.

`Optional` `Beta`mandatoryParameters

mandatoryParameters?: CustomCommandParameter[]

Remarks

List of mandatory command parameters.

`Beta`name

name: string

Remarks

The name of the command. A namespace is required.

`Optional` `Beta`optionalParameters

optionalParameters?: CustomCommandParameter[]

Remarks

List of optional command parameters.

`Beta`permissionLevel

permissionLevel: CustomCommandPermissionLevel

Remarks

The permission level required to execute the command.