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 Summary

Fields

Modifier and Type	Field	Description
final SessionPluginsMarketplacesApi	marketplaces	API methods for the plugins.marketplaces sub-namespace.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	disable(SessionPluginsDisableParams params)	Disables installed plugins when permitted by the live session's retained managed policy.
CompletableFuture<Void>	enable(SessionPluginsEnableParams params)	Enables installed plugins when permitted by the live session's retained managed policy.
CompletableFuture<SessionPluginsInstallResult>	install(SessionPluginsInstallParams params)	Installs a plugin using the live session's authoritative account, working directory, and retained managed policy.
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.
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.
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.
CompletableFuture<Void>	uninstall(SessionPluginsUninstallParams params)	Uninstalls a plugin when permitted by the live session's retained managed policy.
CompletableFuture<SessionPluginsUpdateResult>	update(SessionPluginsUpdateParams params)	Updates an installed plugin using the live session's authoritative account, working directory, and retained managed policy.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

marketplaces

public final SessionPluginsMarketplacesApi marketplaces

API methods for the plugins.marketplaces sub-namespace.

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