Interface IExtensionsMenuApi

_apiId

add

• add(menuItem: Menu): Promise<void>

  Adds a menu item to the Extensions menu in the main menu bar of Studio Pro.

  Parameters

  • menuItem: Menu

    The menu item to add.

  Returns Promise<void>

addEventListener

• addEventListener<K extends "menuItemActivated">(
      eventType: K,
      listener: EventHandler<ExtensionsMenuApiEventMap, K>,
  ): DisposeListener

  Adds an event listener for the specified event type.

  Type Parameters

  • K extends "menuItemActivated"

  Parameters

  • eventType: K

    The type of event to listen for.
  • listener: EventHandler<ExtensionsMenuApiEventMap, K>

    The event listener to add.

  Returns DisposeListener

  A function that can be called to remove the event listener.

removeEventListener

• removeEventListener<K extends "menuItemActivated">(
      eventType: K,
      listener: EventHandler<ExtensionsMenuApiEventMap, K>,
  ): void

  Removes an event listener for the specified event type.

  Type Parameters

  • K extends "menuItemActivated"

  Parameters

  • eventType: K

    The type of event to remove the listener from.
  • listener: EventHandler<ExtensionsMenuApiEventMap, K>

    The event listener to remove.

  Returns void

update

• update(
      menuId: string,
      state: { caption?: string; enabled?: boolean },
  ): Promise<void>

  Updates a menu item in the Extensions menu in the main menu bar of Studio Pro.

  Parameters

  • menuId: string

    The ID of the menu to be updated.
  • state: { caption?: string; enabled?: boolean }

    The menu item state to update (caption and/or enabled).

  Returns Promise<void>