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)	Closes an open canvas instance.
CompletableFuture<SessionCanvasListResult>	list()	Lists canvases declared for the session.
CompletableFuture<SessionCanvasListOpenResult>	listOpen()	Lists currently open canvas instances for the live session.
CompletableFuture<SessionCanvasOpenResult>	open(SessionCanvasOpenParams params)	Opens or focuses a canvas instance.

Methods inherited from class Object

equals, 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

@CopilotExperimental
public CompletableFuture<SessionCanvasListResult> list()

Lists canvases declared for the session.

Since:

1.0.0

listOpen

@CopilotExperimental
public CompletableFuture<SessionCanvasListOpenResult> listOpen()

Lists currently open canvas instances for the live session.

Since:

1.0.0

open

@CopilotExperimental
public CompletableFuture<SessionCanvasOpenResult> open(SessionCanvasOpenParams params)

Opens or focuses a canvas instance.

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

@CopilotExperimental
public CompletableFuture<Void> close(SessionCanvasCloseParams params)

Closes an open canvas instance.

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

Since:

1.0.0