Node.js API
    Preparing search index...

    Class CommandActionAbstract

    Abstract base class for command actions (buttons, keys, etc.).

    Command actions handle discrete input events like button presses from Logi devices. They execute a single action when triggered.

    class PlayPauseAction extends CommandAction {
      name = 'play-pause';
      displayName = 'Play/Pause';
      description = 'Toggle media playback';

      onKeyDown() {
        // Handle the button press
        console.log('Play/Pause button pressed');
      }
    }

    Hierarchy

    • ManageAction
      • CommandAction
    Index

    Constructors

    constructor

    Properties

    _isRegistered _plugin actionType description displayName groupName name

    Accessors

    plugin

    Methods

    _setToRegistered onKeyDown toJson

    Constructors

    Properties

    _isRegistered

    _isRegistered: boolean = false

    _plugin

    _plugin: null | PluginSDK = null
    actionType: ActionType = ActionType.Command

    Type of action.

    description: string

    Action Description shown in the UI.

    displayName: string

    Display Name (or title) shown in the UI.

    groupName: string = ''

    The logical group or folder this action will appear in the UI.

    name: string

    Unique name for the action. Used for identification in the system.

    Accessors

    • set plugin(plugin: PluginSDK): void

      Parameters

      Returns void

    Methods

    _setToRegistered

    • _setToRegistered(): void

      Returns void

    • Handles the user pressing assigned key. Override this method to implement your command action behavior.

      Returns void | Promise<void>

    • Returns ActionData

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods