Class SessionUiApi

java.lang.Object

com.github.copilot.generated.rpc.SessionUiApi

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

API methods for the ui namespace.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
CompletableFuture<SessionUiElicitationResult>	elicitation(SessionUiElicitationParams params)	Requests structured input from a UI-capable client.
CompletableFuture<SessionUiEphemeralQueryResult>	ephemeralQuery(SessionUiEphemeralQueryParams params)	Runs a transient no-tools model query against the current conversation context.
CompletableFuture<SessionUiHandlePendingAutoModeSwitchResult>	handlePendingAutoModeSwitch(SessionUiHandlePendingAutoModeSwitchParams params)	Resolves a pending `auto_mode_switch.requested` event with the user's accept/decline decision.
CompletableFuture<SessionUiHandlePendingElicitationResult>	handlePendingElicitation(SessionUiHandlePendingElicitationParams params)	Provides the user response for a pending elicitation request.
CompletableFuture<SessionUiHandlePendingExitPlanModeResult>	handlePendingExitPlanMode(SessionUiHandlePendingExitPlanModeParams params)	Resolves a pending `exit_plan_mode.requested` event with the user's response.
CompletableFuture<SessionUiHandlePendingSamplingResult>	handlePendingSampling(SessionUiHandlePendingSamplingParams params)	Resolves a pending `sampling.requested` event with a sampling result, or rejects it.
CompletableFuture<SessionUiHandlePendingSessionLimitsExhaustedResult>	handlePendingSessionLimitsExhausted(SessionUiHandlePendingSessionLimitsExhaustedParams params)	Resolves a pending `session_limits_exhausted.requested` event with the user's selected limit action.
CompletableFuture<SessionUiHandlePendingUserInputResult>	handlePendingUserInput(SessionUiHandlePendingUserInputParams params)	Resolves a pending `user_input.requested` event with the user's response.
CompletableFuture<SessionUiRegisterDirectAutoModeSwitchHandlerResult>	registerDirectAutoModeSwitchHandler()	Registers an in-process handler for auto-mode-switch requests so the server bridge skips dispatch.
CompletableFuture<SessionUiUnregisterDirectAutoModeSwitchHandlerResult>	unregisterDirectAutoModeSwitchHandler(SessionUiUnregisterDirectAutoModeSwitchHandlerParams params)	Unregisters a previously-registered in-process auto-mode-switch handler by its opaque handle.

Methods inherited from class Object

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

Method Details

ephemeralQuery

@CopilotExperimental
public CompletableFuture<SessionUiEphemeralQueryResult> ephemeralQuery(SessionUiEphemeralQueryParams params)

Runs a transient no-tools model query against the current conversation context.

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

Since:

1.0.0

elicitation

@CopilotExperimental
public CompletableFuture<SessionUiElicitationResult> elicitation(SessionUiElicitationParams params)

Requests structured input from a UI-capable client.

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

Since:

1.0.0

handlePendingElicitation

@CopilotExperimental
public CompletableFuture<SessionUiHandlePendingElicitationResult> handlePendingElicitation(SessionUiHandlePendingElicitationParams params)

Provides the user response for a pending elicitation request.

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

Since:

1.0.0

handlePendingUserInput

@CopilotExperimental
public CompletableFuture<SessionUiHandlePendingUserInputResult> handlePendingUserInput(SessionUiHandlePendingUserInputParams params)

Resolves a pending `user_input.requested` event with the user's response.

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

Since:

1.0.0

handlePendingSampling

@CopilotExperimental
public CompletableFuture<SessionUiHandlePendingSamplingResult> handlePendingSampling(SessionUiHandlePendingSamplingParams params)

Resolves a pending `sampling.requested` event with a sampling result, or rejects it.

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

Since:

1.0.0

handlePendingAutoModeSwitch

@CopilotExperimental
public CompletableFuture<SessionUiHandlePendingAutoModeSwitchResult> handlePendingAutoModeSwitch(SessionUiHandlePendingAutoModeSwitchParams params)

Resolves a pending `auto_mode_switch.requested` event with the user's accept/decline decision.

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

Since:

1.0.0

handlePendingSessionLimitsExhausted

@CopilotExperimental
public CompletableFuture<SessionUiHandlePendingSessionLimitsExhaustedResult> handlePendingSessionLimitsExhausted(SessionUiHandlePendingSessionLimitsExhaustedParams params)

Resolves a pending `session_limits_exhausted.requested` event with the user's selected limit action.

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

Since:

1.0.0

handlePendingExitPlanMode

@CopilotExperimental
public CompletableFuture<SessionUiHandlePendingExitPlanModeResult> handlePendingExitPlanMode(SessionUiHandlePendingExitPlanModeParams params)

Resolves a pending `exit_plan_mode.requested` event with the user's response.

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

Since:

1.0.0

registerDirectAutoModeSwitchHandler

@CopilotExperimental
public CompletableFuture<SessionUiRegisterDirectAutoModeSwitchHandlerResult> registerDirectAutoModeSwitchHandler()

Registers an in-process handler for auto-mode-switch requests so the server bridge skips dispatch.

Since:

1.0.0

unregisterDirectAutoModeSwitchHandler

@CopilotExperimental
public CompletableFuture<SessionUiUnregisterDirectAutoModeSwitchHandlerResult> unregisterDirectAutoModeSwitchHandler(SessionUiUnregisterDirectAutoModeSwitchHandlerParams params)

Unregisters a previously-registered in-process auto-mode-switch handler by its opaque handle.

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

Since:

1.0.0