Class SessionCanvasApi

java.lang.Object

com.github.copilot.generated.rpc.SessionCanvasApi

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

API methods for the canvas namespace.

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field	Description
final SessionCanvasActionApi	action	API methods for the canvas.action sub-namespace.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	close(SessionCanvasCloseParams params)	Canvas close parameters.
CompletableFuture<SessionCanvasListResult>	list()	Identifies the target session.
CompletableFuture<SessionCanvasListOpenResult>	listOpen()	Identifies the target session.
CompletableFuture<SessionCanvasOpenResult>	open(SessionCanvasOpenParams params)	Canvas open parameters.

Methods inherited from class Object

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

Field Details

action

public final SessionCanvasActionApi action

API methods for the canvas.action sub-namespace.

Method Details

list

public CompletableFuture<SessionCanvasListResult> list()

Identifies the target session.

Since:

1.0.0

listOpen

public CompletableFuture<SessionCanvasListOpenResult> listOpen()

Identifies the target session.

Since:

1.0.0

open

public CompletableFuture<SessionCanvasOpenResult> open(SessionCanvasOpenParams params)

Canvas open parameters.

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

Since:

1.0.0

close

public CompletableFuture<Void> close(SessionCanvasCloseParams params)

Canvas close parameters.

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

Since:

1.0.0