Skip to main content

Interface: CommandV1

core/commandRunner/typings/legacy/CommandV0V1.types.CommandV1

Hierarchy

Properties

action

action: string

The action to run

Inherited from

CommandV0V1.action

Defined in

core/commandRunner/typings/legacy/CommandV0V1.types.ts:35


extraArgs

Optional extraArgs: unknown[]

A list of extra arguments expected by the given action.

Inherited from

CommandV0V1.extraArgs

Defined in

core/commandRunner/typings/legacy/CommandV0V1.types.ts:46


spokenForm

Optional spokenForm: string

The spoken form of the command if issued from a voice command system

Inherited from

CommandV0V1.spokenForm

Defined in

core/commandRunner/typings/legacy/CommandV0V1.types.ts:22


targets

targets: PartialTargetV0V1[]

A list of targets expected by the action. Inference will be run on the targets

Inherited from

CommandV0V1.targets

Defined in

core/commandRunner/typings/legacy/CommandV0V1.types.ts:41


usePrePhraseSnapshot

Optional usePrePhraseSnapshot: boolean

If the command is issued from a voice command system, this boolean indicates whether we should use the pre phrase snapshot. Only set this to true if the voice command system issues a pre phrase signal at the start of every phrase.

Inherited from

CommandV0V1.usePrePhraseSnapshot

Defined in

core/commandRunner/typings/legacy/CommandV0V1.types.ts:30


version

version: 1

The version number of the command API

Overrides

CommandV0V1.version

Defined in

core/commandRunner/typings/legacy/CommandV0V1.types.ts:5