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)	Identifier of the background task to cancel.
CompletableFuture<SessionTasksGetCurrentPromotableResult>	getCurrentPromotable()	Identifies the target session.
CompletableFuture<SessionTasksGetProgressResult>	getProgress(SessionTasksGetProgressParams params)	Identifier of the background task to fetch progress for.
CompletableFuture<SessionTasksListResult>	list()	Identifies the target session.
CompletableFuture<SessionTasksPromoteCurrentToBackgroundResult>	promoteCurrentToBackground()	Identifies the target session.
CompletableFuture<SessionTasksPromoteToBackgroundResult>	promoteToBackground(SessionTasksPromoteToBackgroundParams params)	Identifier of the task to promote to background mode.
CompletableFuture<Void>	refresh()	Identifies the target session.
CompletableFuture<SessionTasksRemoveResult>	remove(SessionTasksRemoveParams params)	Identifier of the completed or cancelled task to remove from tracking.
CompletableFuture<SessionTasksSendMessageResult>	sendMessage(SessionTasksSendMessageParams params)	Identifier of the target agent task, message content, and optional sender agent ID.
CompletableFuture<SessionTasksStartAgentResult>	startAgent(SessionTasksStartAgentParams params)	Agent type, prompt, name, and optional description and model override for the new task.
CompletableFuture<Void>	waitForPending()	Identifies the target session.

Methods inherited from class Object

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

Method Details

startAgent

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

Agent type, prompt, name, and optional description and model override for the new 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

list

@CopilotExperimental
public CompletableFuture<SessionTasksListResult> list()

Identifies the target session.

Since:

1.0.0

refresh

@CopilotExperimental
public CompletableFuture<Void> refresh()

Identifies the target session.

Since:

1.0.0

waitForPending

@CopilotExperimental
public CompletableFuture<Void> waitForPending()

Identifies the target session.

Since:

1.0.0

getProgress

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

Identifier of the background task to fetch progress for.

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()

Identifies the target session.

Since:

1.0.0

promoteToBackground

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

Identifier of the task to promote to background mode.

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()

Identifies the target session.

Since:

1.0.0

cancel

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

Identifier of the background task to cancel.

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)

Identifier of the completed or cancelled task to remove 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)

Identifier of the target agent task, message content, and optional sender agent 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