Module com.github.copilot.java

Package com.github.copilot.generated.rpc

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)	Prompt message and JSON schema describing the form fields to elicit from the user.
CompletableFuture<SessionUiHandlePendingAutoModeSwitchResult>	handlePendingAutoModeSwitch(SessionUiHandlePendingAutoModeSwitchParams params)	Request ID of a pending `auto_mode_switch.requested` event and the user's response.
CompletableFuture<SessionUiHandlePendingElicitationResult>	handlePendingElicitation(SessionUiHandlePendingElicitationParams params)	Pending elicitation request ID and the user's response (accept/decline/cancel + form values).
CompletableFuture<SessionUiHandlePendingExitPlanModeResult>	handlePendingExitPlanMode(SessionUiHandlePendingExitPlanModeParams params)	Request ID of a pending `exit_plan_mode.requested` event and the user's response.
CompletableFuture<SessionUiHandlePendingSamplingResult>	handlePendingSampling(SessionUiHandlePendingSamplingParams params)	Request ID of a pending `sampling.requested` event and an optional sampling result payload (omit to reject).
CompletableFuture<SessionUiHandlePendingUserInputResult>	handlePendingUserInput(SessionUiHandlePendingUserInputParams params)	Request ID of a pending `user_input.requested` event and the user's response.
CompletableFuture<SessionUiRegisterDirectAutoModeSwitchHandlerResult>	registerDirectAutoModeSwitchHandler()	Identifies the target session.
CompletableFuture<SessionUiUnregisterDirectAutoModeSwitchHandlerResult>	unregisterDirectAutoModeSwitchHandler(SessionUiUnregisterDirectAutoModeSwitchHandlerParams params)	Opaque handle previously returned by `registerDirectAutoModeSwitchHandler` to release.

Methods inherited from class java.lang.Object

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

Method Details

elicitation

public CompletableFuture<SessionUiElicitationResult> elicitation(SessionUiElicitationParams params)

Prompt message and JSON schema describing the form fields to elicit from the user.

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

public CompletableFuture<SessionUiHandlePendingElicitationResult> handlePendingElicitation(SessionUiHandlePendingElicitationParams params)

Pending elicitation request ID and the user's response (accept/decline/cancel + form values).

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

public CompletableFuture<SessionUiHandlePendingUserInputResult> handlePendingUserInput(SessionUiHandlePendingUserInputParams params)

Request ID of a pending `user_input.requested` event and 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

public CompletableFuture<SessionUiHandlePendingSamplingResult> handlePendingSampling(SessionUiHandlePendingSamplingParams params)

Request ID of a pending `sampling.requested` event and an optional sampling result payload (omit to reject).

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

public CompletableFuture<SessionUiHandlePendingAutoModeSwitchResult> handlePendingAutoModeSwitch(SessionUiHandlePendingAutoModeSwitchParams params)

Request ID of a pending `auto_mode_switch.requested` event and 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

handlePendingExitPlanMode

public CompletableFuture<SessionUiHandlePendingExitPlanModeResult> handlePendingExitPlanMode(SessionUiHandlePendingExitPlanModeParams params)

Request ID of a pending `exit_plan_mode.requested` event and 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

public CompletableFuture<SessionUiRegisterDirectAutoModeSwitchHandlerResult> registerDirectAutoModeSwitchHandler()

Identifies the target session.

Since:

1.0.0

unregisterDirectAutoModeSwitchHandler

public CompletableFuture<SessionUiUnregisterDirectAutoModeSwitchHandlerResult> unregisterDirectAutoModeSwitchHandler(SessionUiUnregisterDirectAutoModeSwitchHandlerParams params)

Opaque handle previously returned by `registerDirectAutoModeSwitchHandler` to release.

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

Since:

1.0.0