Class SessionCommandsApi

java.lang.Object

com.github.copilot.generated.rpc.SessionCommandsApi

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

API methods for the commands namespace.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
CompletableFuture<EnqueueCommandResult>	enqueue(SessionCommandsEnqueueParams params)	Enqueues a slash command for FIFO processing on the local session.
CompletableFuture<SessionCommandsExecuteResult>	execute(SessionCommandsExecuteParams params)	Executes a slash command synchronously and returns any error.
CompletableFuture<SessionCommandsHandlePendingCommandResult>	handlePendingCommand(SessionCommandsHandlePendingCommandParams params)	Reports completion of a pending client-handled slash command.
CompletableFuture<SlashCommandInvocationResult>	invoke(SessionCommandsInvokeParams params)	Invokes a slash command in the session.
CompletableFuture<SessionCommandsListResult>	list()	Lists slash commands available in the session.
CompletableFuture<SessionCommandsListResult>	list(SessionCommandsListParams params)	Lists slash commands available in the session.
CompletableFuture<SessionCommandsRespondToQueuedCommandResult>	respondToQueuedCommand(SessionCommandsRespondToQueuedCommandParams params)	Reports whether the host actually executed a queued command and whether to continue processing.

Methods inherited from class Object

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

Method Details

list

@CopilotExperimental
public CompletableFuture<SessionCommandsListResult> list()

Lists slash commands available in the session.

Invokes the method with no params, applying the runtime defaults.

Since:

1.0.0

list

@CopilotExperimental
public CompletableFuture<SessionCommandsListResult> list(SessionCommandsListParams params)

Lists slash commands available 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

invoke

@CopilotExperimental
public CompletableFuture<SlashCommandInvocationResult> invoke(SessionCommandsInvokeParams params)

Invokes a slash command 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

handlePendingCommand

@CopilotExperimental
public CompletableFuture<SessionCommandsHandlePendingCommandResult> handlePendingCommand(SessionCommandsHandlePendingCommandParams params)

Reports completion of a pending client-handled slash command.

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

Since:

1.0.0

execute

@CopilotExperimental
public CompletableFuture<SessionCommandsExecuteResult> execute(SessionCommandsExecuteParams params)

Executes a slash command synchronously and returns any error.

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

Since:

1.0.0

enqueue

@CopilotExperimental
public CompletableFuture<EnqueueCommandResult> enqueue(SessionCommandsEnqueueParams params)

Enqueues a slash command for FIFO processing on the local 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

respondToQueuedCommand

@CopilotExperimental
public CompletableFuture<SessionCommandsRespondToQueuedCommandResult> respondToQueuedCommand(SessionCommandsRespondToQueuedCommandParams params)

Reports whether the host actually executed a queued command and whether to continue processing.

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

Since:

1.0.0