Class SessionTasksApi

java.lang.Object

com.github.copilot.generated.rpc.SessionTasksApi

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

API methods for the tasks namespace.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
CompletableFuture<SessionTasksCancelResult>	cancel(SessionTasksCancelParams params)	Cancels a background task.
CompletableFuture<SessionTasksGetCurrentPromotableResult>	getCurrentPromotable()	Returns the first sync-waiting task that can currently be promoted to background mode.
CompletableFuture<SessionTasksGetProgressResult>	getProgress(SessionTasksGetProgressParams params)	Returns progress information for a background task by ID.
CompletableFuture<SessionTasksListResult>	list()	Lists background tasks tracked by the session.
CompletableFuture<SessionTasksPromoteCurrentToBackgroundResult>	promoteCurrentToBackground()	Atomically promotes the first promotable sync-waiting task to background mode and returns it.
CompletableFuture<SessionTasksPromoteToBackgroundResult>	promoteToBackground(SessionTasksPromoteToBackgroundParams params)	Promotes an eligible synchronously-waited task so it continues running in the background.
CompletableFuture<Void>	refresh()	Refreshes metadata for any detached background shells the runtime knows about.
CompletableFuture<SessionTasksRegisterResult>	register(SessionTasksRegisterParams params)	Registers a client-owned task, or reclaims an orphaned task belonging to the same extension principal.
CompletableFuture<SessionTasksRemoveResult>	remove(SessionTasksRemoveParams params)	Removes a completed or cancelled background task from tracking.
CompletableFuture<SessionTasksSendMessageResult>	sendMessage(SessionTasksSendMessageParams params)	Sends a message to a background agent task.
CompletableFuture<SessionTasksStartAgentResult>	startAgent(SessionTasksStartAgentParams params)	Starts a background agent task in the session.
CompletableFuture<SessionTasksUpdateResult>	update(SessionTasksUpdateParams params)	Publishes generic progress or a terminal outcome for a client-owned task.
CompletableFuture<Void>	waitForPending()	Waits for all in-flight background tasks and any follow-up turns to settle.

Methods inherited from class Object

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

Method Details

startAgent

@CopilotExperimental
public CompletableFuture<SessionTasksStartAgentResult> startAgent(SessionTasksStartAgentParams params)

Starts a background agent task in 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

list

@CopilotExperimental
public CompletableFuture<SessionTasksListResult> list()

Lists background tasks tracked by the session.

Since:

1.0.0

register

@CopilotExperimental
public CompletableFuture<SessionTasksRegisterResult> register(SessionTasksRegisterParams params)

Registers a client-owned task, or reclaims an orphaned task belonging to the same extension principal.

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<SessionTasksUpdateResult> update(SessionTasksUpdateParams params)

Publishes generic progress or a terminal outcome for a client-owned task.

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

Since:

1.0.0

refresh

@CopilotExperimental
public CompletableFuture<Void> refresh()

Refreshes metadata for any detached background shells the runtime knows about.

Since:

1.0.0

waitForPending

@CopilotExperimental
public CompletableFuture<Void> waitForPending()

Waits for all in-flight background tasks and any follow-up turns to settle.

Since:

1.0.0

getProgress

@CopilotExperimental
public CompletableFuture<SessionTasksGetProgressResult> getProgress(SessionTasksGetProgressParams params)

Returns progress information for a background task by ID.

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

Since:

1.0.0

getCurrentPromotable

@CopilotExperimental
public CompletableFuture<SessionTasksGetCurrentPromotableResult> getCurrentPromotable()

Returns the first sync-waiting task that can currently be promoted to background mode.

Since:

1.0.0

promoteToBackground

@CopilotExperimental
public CompletableFuture<SessionTasksPromoteToBackgroundResult> promoteToBackground(SessionTasksPromoteToBackgroundParams params)

Promotes an eligible synchronously-waited task so it continues running in the background.

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

Since:

1.0.0

promoteCurrentToBackground

@CopilotExperimental
public CompletableFuture<SessionTasksPromoteCurrentToBackgroundResult> promoteCurrentToBackground()

Atomically promotes the first promotable sync-waiting task to background mode and returns it.

Since:

1.0.0

cancel

@CopilotExperimental
public CompletableFuture<SessionTasksCancelResult> cancel(SessionTasksCancelParams params)

Cancels a background task.

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

Since:

1.0.0

remove

@CopilotExperimental
public CompletableFuture<SessionTasksRemoveResult> remove(SessionTasksRemoveParams params)

Removes a completed or cancelled background task from tracking.

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

Since:

1.0.0

sendMessage

@CopilotExperimental
public CompletableFuture<SessionTasksSendMessageResult> sendMessage(SessionTasksSendMessageParams params)

Sends a message to a background agent task.

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

Since:

1.0.0