Class SessionPluginsApi

java.lang.Object
com.github.copilot.generated.rpc.SessionPluginsApi
@Generated("copilot-sdk-codegen") public final class SessionPluginsApi extends Object
API methods for the plugins namespace.
Since:
1.0.0

  • Field Details

  • Method Details

    • list

      @CopilotExperimental public CompletableFuture<SessionPluginsListResult> list()
      Lists globally installed, live, built-in, and enterprise-managed desired plugins using the live session's authoritative account, working directory, and retained managed policy.
      Since:
      1.0.0

    • install

      @CopilotExperimental public CompletableFuture<SessionPluginsInstallResult> install(SessionPluginsInstallParams params)
      Installs a plugin using the live session's authoritative account, working directory, and retained managed policy.

      Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

      Since:
      1.0.0

    • uninstall

      @CopilotExperimental public CompletableFuture<Void> uninstall(SessionPluginsUninstallParams params)
      Uninstalls a plugin when permitted by the live session's retained managed policy.

      Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

      Since:
      1.0.0

    • update

      @CopilotExperimental public CompletableFuture<SessionPluginsUpdateResult> update(SessionPluginsUpdateParams params)
      Updates an installed plugin using the live session's authoritative account, working directory, and retained managed policy.

      Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

      Since:
      1.0.0

    • enable

      @CopilotExperimental public CompletableFuture<Void> enable(SessionPluginsEnableParams params)
      Enables installed plugins when permitted by the live session's retained managed policy.

      Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

      Since:
      1.0.0

    • disable

      @CopilotExperimental public CompletableFuture<Void> disable(SessionPluginsDisableParams params)
      Disables installed plugins when permitted by the live session's retained managed policy.

      Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

      Since:
      1.0.0

    • reload

      @CopilotExperimental public CompletableFuture<Void> reload()
      Reloads the session's plugin set, refreshing MCP servers, custom agents, hooks, and skills cache so SDK-driven changes via `server.plugins.*` take effect immediately.

      Invokes the method with no params, applying the runtime defaults.

      Since:
      1.0.0

    • reload

      @CopilotExperimental public CompletableFuture<Void> reload(SessionPluginsReloadParams params)
      Reloads the session's plugin set, refreshing MCP servers, custom agents, hooks, and skills cache so SDK-driven changes via `server.plugins.*` take effect immediately.

      Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

      Since:
      1.0.0

    • retryManaged

      @CopilotExperimental public CompletableFuture<SessionPluginsRetryManagedResult> retryManaged()
      Installs or updates the plugins the session's managed settings require now, without waiting for the next automatic attempt after a failure, then reloads plugins. Reports progress and failures with the same `session.info` and `session.warning` events as automatic preparation. Fails when the runtime does not prepare managed plugins for the session.

      Invokes the method with no params, applying the runtime defaults.

      Since:
      1.0.0

    • retryManaged

      @CopilotExperimental public CompletableFuture<SessionPluginsRetryManagedResult> retryManaged(SessionPluginsRetryManagedParams params)
      Installs or updates the plugins the session's managed settings require now, without waiting for the next automatic attempt after a failure, then reloads plugins. Reports progress and failures with the same `session.info` and `session.warning` events as automatic preparation. Fails when the runtime does not prepare managed plugins for the session.

      Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

      Since:
      1.0.0