Class SessionRemoteApi

java.lang.Object

com.github.copilot.generated.rpc.SessionRemoteApi

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

API methods for the remote namespace.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	disable()	Disables remote session export and steering.
CompletableFuture<SessionRemoteEnableResult>	enable(SessionRemoteEnableParams params)	Enables remote session export or steering.
CompletableFuture<Void>	notifySteerableChanged(SessionRemoteNotifySteerableChangedParams params)	Persists a remote-steerability change emitted by the host as a session event.

Methods inherited from class Object

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

Method Details

enable

@CopilotExperimental
public CompletableFuture<SessionRemoteEnableResult> enable(SessionRemoteEnableParams params)

Enables remote session export or steering.

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

Since:

1.0.0

disable

@CopilotExperimental
public CompletableFuture<Void> disable()

Disables remote session export and steering.

Since:

1.0.0

notifySteerableChanged

@CopilotExperimental
public CompletableFuture<Void> notifySteerableChanged(SessionRemoteNotifySteerableChangedParams params)

Persists a remote-steerability change emitted by the host as a session event.

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

Since:

1.0.0