Class ServerSessionsApi

java.lang.Object

com.github.copilot.generated.rpc.ServerSessionsApi

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

API methods for the sessions namespace.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
CompletableFuture<SessionsBulkDeleteResult>	bulkDelete(SessionsBulkDeleteParams params)	Session IDs to close, deactivate, and delete from disk.
CompletableFuture<SessionsCheckInUseResult>	checkInUse(SessionsCheckInUseParams params)	Session IDs to test for live in-use locks.
CompletableFuture<Void>	close()	Session ID to close.
CompletableFuture<Void>	configureSessionExtensions(SessionsConfigureSessionExtensionsParams params)	Params to attach or detach an in-process ExtensionController delegate.
CompletableFuture<SessionsConnectResult>	connect()	Remote session connection parameters.
CompletableFuture<SessionsEnrichMetadataResult>	enrichMetadata(SessionsEnrichMetadataParams params)	Session metadata records to enrich with summary and context information.
CompletableFuture<SessionsFindByPrefixResult>	findByPrefix(SessionsFindByPrefixParams params)	UUID prefix to resolve to a unique session ID.
CompletableFuture<SessionsFindByTaskIdResult>	findByTaskId(SessionsFindByTaskIdParams params)	GitHub task ID to look up.
CompletableFuture<SessionsForkResult>	fork(SessionsForkParams params)	Source session identifier to fork from, optional event-ID boundary, and optional friendly name for the new session.
CompletableFuture<SessionsGetBoardEntryCountResult>	getBoardEntryCount()	Session ID whose board entry count should be returned.
CompletableFuture<SessionsGetEventFilePathResult>	getEventFilePath()	Session ID whose event-log file path to compute.
CompletableFuture<SessionsGetLastForContextResult>	getLastForContext(SessionsGetLastForContextParams params)	Optional working-directory context used to score session relevance.
CompletableFuture<SessionsGetPersistedRemoteSteerableResult>	getPersistedRemoteSteerable()	Session ID to look up the persisted remote-steerable flag for.
CompletableFuture<SessionsGetRemoteControlStatusResult>	getRemoteControlStatus()	Wrapper for the singleton's current status.
CompletableFuture<SessionsGetSizesResult>	getSizes()	Map of sessionId -> on-disk size in bytes for each session's workspace directory.
CompletableFuture<SessionsListResult>	list()	Optional source filter, metadata-load limit, and context filter applied to the returned sessions.
CompletableFuture<SessionsLoadDeferredRepoHooksResult>	loadDeferredRepoHooks()	Active session ID whose deferred repo-level hooks should be loaded.
CompletableFuture<SessionsOpenResult>	open()	Open a session by creating, resuming, attaching, connecting to a remote, or handing off.
CompletableFuture<SessionsPollSpawnedSessionsResult>	pollSpawnedSessions()	Cursor and optional long-poll wait for polling runtime-spawned sessions.
CompletableFuture<SessionsPruneOldResult>	pruneOld(SessionsPruneOldParams params)	Age threshold and optional flags controlling which old sessions are pruned (or simulated when dryRun is true).
CompletableFuture<SessionsRegisterExtensionToolsOnSessionResult>	registerExtensionToolsOnSession(SessionsRegisterExtensionToolsOnSessionParams params)	Params to attach an extension loader's tools to a session.
CompletableFuture<Void>	releaseLock()	Session ID whose in-use lock should be released.
CompletableFuture<Void>	reloadPluginHooks(SessionsReloadPluginHooksParams params)	Active session ID and an optional flag for deferring repo-level hooks until folder trust.
CompletableFuture<Void>	save()	Session ID whose pending events should be flushed to disk.
CompletableFuture<Void>	setAdditionalPlugins(SessionsSetAdditionalPluginsParams params)	Manager-wide additional plugins to register; replaces any previously-configured set.
CompletableFuture<SessionsSetRemoteControlSteeringResult>	setRemoteControlSteering(SessionsSetRemoteControlSteeringParams params)	Patch for the singleton's steering state.
CompletableFuture<SessionsStartRemoteControlResult>	startRemoteControl(SessionsStartRemoteControlParams params)	Parameters for attaching the remote-control singleton to a session.
CompletableFuture<SessionsStopRemoteControlResult>	stopRemoteControl()	Parameters for stopping the remote-control singleton.
CompletableFuture<SessionsTransferRemoteControlResult>	transferRemoteControl(SessionsTransferRemoteControlParams params)	Parameters for atomically rebinding the remote-control singleton.

Methods inherited from class Object

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

Method Details

open

@CopilotExperimental
public CompletableFuture<SessionsOpenResult> open()

Open a session by creating, resuming, attaching, connecting to a remote, or handing off.

Since:

1.0.0

fork

@CopilotExperimental
public CompletableFuture<SessionsForkResult> fork(SessionsForkParams params)

Source session identifier to fork from, optional event-ID boundary, and optional friendly name for the new session.

Since:

1.0.0

connect

@CopilotExperimental
public CompletableFuture<SessionsConnectResult> connect()

Remote session connection parameters.

Since:

1.0.0

list

@CopilotExperimental
public CompletableFuture<SessionsListResult> list()

Optional source filter, metadata-load limit, and context filter applied to the returned sessions.

Since:

1.0.0

findByTaskId

@CopilotExperimental
public CompletableFuture<SessionsFindByTaskIdResult> findByTaskId(SessionsFindByTaskIdParams params)

GitHub task ID to look up.

Since:

1.0.0

findByPrefix

@CopilotExperimental
public CompletableFuture<SessionsFindByPrefixResult> findByPrefix(SessionsFindByPrefixParams params)

UUID prefix to resolve to a unique session ID.

Since:

1.0.0

getLastForContext

@CopilotExperimental
public CompletableFuture<SessionsGetLastForContextResult> getLastForContext(SessionsGetLastForContextParams params)

Optional working-directory context used to score session relevance.

Since:

1.0.0

getEventFilePath

@CopilotExperimental
public CompletableFuture<SessionsGetEventFilePathResult> getEventFilePath()

Session ID whose event-log file path to compute.

Since:

1.0.0

getSizes

@CopilotExperimental
public CompletableFuture<SessionsGetSizesResult> getSizes()

Map of sessionId -> on-disk size in bytes for each session's workspace directory.

Since:

1.0.0

checkInUse

@CopilotExperimental
public CompletableFuture<SessionsCheckInUseResult> checkInUse(SessionsCheckInUseParams params)

Session IDs to test for live in-use locks.

Since:

1.0.0

getPersistedRemoteSteerable

@CopilotExperimental
public CompletableFuture<SessionsGetPersistedRemoteSteerableResult> getPersistedRemoteSteerable()

Session ID to look up the persisted remote-steerable flag for.

Since:

1.0.0

close

@CopilotExperimental
public CompletableFuture<Void> close()

Session ID to close.

Since:

1.0.0

bulkDelete

@CopilotExperimental
public CompletableFuture<SessionsBulkDeleteResult> bulkDelete(SessionsBulkDeleteParams params)

Session IDs to close, deactivate, and delete from disk.

Since:

1.0.0

pruneOld

@CopilotExperimental
public CompletableFuture<SessionsPruneOldResult> pruneOld(SessionsPruneOldParams params)

Age threshold and optional flags controlling which old sessions are pruned (or simulated when dryRun is true).

Since:

1.0.0

save

@CopilotExperimental
public CompletableFuture<Void> save()

Session ID whose pending events should be flushed to disk.

Since:

1.0.0

releaseLock

@CopilotExperimental
public CompletableFuture<Void> releaseLock()

Session ID whose in-use lock should be released.

Since:

1.0.0

enrichMetadata

@CopilotExperimental
public CompletableFuture<SessionsEnrichMetadataResult> enrichMetadata(SessionsEnrichMetadataParams params)

Session metadata records to enrich with summary and context information.

Since:

1.0.0

reloadPluginHooks

@CopilotExperimental
public CompletableFuture<Void> reloadPluginHooks(SessionsReloadPluginHooksParams params)

Active session ID and an optional flag for deferring repo-level hooks until folder trust.

Since:

1.0.0

loadDeferredRepoHooks

@CopilotExperimental
public CompletableFuture<SessionsLoadDeferredRepoHooksResult> loadDeferredRepoHooks()

Active session ID whose deferred repo-level hooks should be loaded.

Since:

1.0.0

setAdditionalPlugins

@CopilotExperimental
public CompletableFuture<Void> setAdditionalPlugins(SessionsSetAdditionalPluginsParams params)

Manager-wide additional plugins to register; replaces any previously-configured set.

Since:

1.0.0

getBoardEntryCount

@CopilotExperimental
public CompletableFuture<SessionsGetBoardEntryCountResult> getBoardEntryCount()

Session ID whose board entry count should be returned.

Since:

1.0.0

startRemoteControl

@CopilotExperimental
public CompletableFuture<SessionsStartRemoteControlResult> startRemoteControl(SessionsStartRemoteControlParams params)

Parameters for attaching the remote-control singleton to a session.

Since:

1.0.0

transferRemoteControl

@CopilotExperimental
public CompletableFuture<SessionsTransferRemoteControlResult> transferRemoteControl(SessionsTransferRemoteControlParams params)

Parameters for atomically rebinding the remote-control singleton.

Since:

1.0.0

setRemoteControlSteering

@CopilotExperimental
public CompletableFuture<SessionsSetRemoteControlSteeringResult> setRemoteControlSteering(SessionsSetRemoteControlSteeringParams params)

Patch for the singleton's steering state.

Since:

1.0.0

stopRemoteControl

@CopilotExperimental
public CompletableFuture<SessionsStopRemoteControlResult> stopRemoteControl()

Parameters for stopping the remote-control singleton.

Since:

1.0.0

getRemoteControlStatus

@CopilotExperimental
public CompletableFuture<SessionsGetRemoteControlStatusResult> getRemoteControlStatus()

Wrapper for the singleton's current status.

Since:

1.0.0

pollSpawnedSessions

@CopilotExperimental
public CompletableFuture<SessionsPollSpawnedSessionsResult> pollSpawnedSessions()

Cursor and optional long-poll wait for polling runtime-spawned sessions.

Since:

1.0.0

registerExtensionToolsOnSession

@CopilotExperimental
public CompletableFuture<SessionsRegisterExtensionToolsOnSessionResult> registerExtensionToolsOnSession(SessionsRegisterExtensionToolsOnSessionParams params)

Params to attach an extension loader's tools to a session.

Since:

1.0.0

configureSessionExtensions

@CopilotExperimental
public CompletableFuture<Void> configureSessionExtensions(SessionsConfigureSessionExtensionsParams params)

Params to attach or detach an in-process ExtensionController delegate.

Since:

1.0.0