Class ServerPluginsApi

java.lang.Object

com.github.copilot.generated.rpc.ServerPluginsApi

@Generated("copilot-sdk-codegen")
public final class ServerPluginsApi
extends Object

API methods for the plugins namespace.

Since:

1.0.0

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	disable(PluginsDisableParams params)	Disables installed plugins for new sessions.
CompletableFuture<Void>	enable(PluginsEnableParams params)	Enables installed plugins for new sessions.
CompletableFuture<PluginsInstallResult>	install(PluginsInstallParams params)	Installs a plugin from a marketplace, GitHub repo, URL, or local path.
CompletableFuture<PluginsListResult>	list()	Lists plugins installed in user/global state.
CompletableFuture<Void>	uninstall(PluginsUninstallParams params)	Uninstalls an installed plugin.
CompletableFuture<PluginsUpdateResult>	update(PluginsUpdateParams params)	Updates an installed plugin to its latest published version.
CompletableFuture<PluginsUpdateAllResult>	updateAll()	Updates every installed plugin to its latest published version.

Methods inherited from class Object

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

Field Details

builtin

public final ServerPluginsBuiltinApi builtin

API methods for the plugins.builtin sub-namespace.

marketplaces

public final ServerPluginsMarketplacesApi marketplaces

API methods for the plugins.marketplaces sub-namespace.

Method Details

list

@CopilotExperimental
public CompletableFuture<PluginsListResult> list()

Lists plugins installed in user/global state.

Since:

1.0.0

install

@CopilotExperimental
public CompletableFuture<PluginsInstallResult> install(PluginsInstallParams params)

Installs a plugin from a marketplace, GitHub repo, URL, or local path.

Since:

1.0.0

uninstall

@CopilotExperimental
public CompletableFuture<Void> uninstall(PluginsUninstallParams params)

Uninstalls an installed plugin.

Since:

1.0.0

update

@CopilotExperimental
public CompletableFuture<PluginsUpdateResult> update(PluginsUpdateParams params)

Updates an installed plugin to its latest published version.

Since:

1.0.0

updateAll

@CopilotExperimental
public CompletableFuture<PluginsUpdateAllResult> updateAll()

Updates every installed plugin to its latest published version.

Since:

1.0.0

enable

@CopilotExperimental
public CompletableFuture<Void> enable(PluginsEnableParams params)

Enables installed plugins for new sessions.

Since:

1.0.0

disable

@CopilotExperimental
public CompletableFuture<Void> disable(PluginsDisableParams params)

Disables installed plugins for new sessions.

Since:

1.0.0