Class SessionCanvasUnavailableEvent

java.lang.Object

com.github.copilot.generated.SessionEvent

com.github.copilot.generated.SessionCanvasUnavailableEvent

@Generated("copilot-sdk-codegen")
public final class SessionCanvasUnavailableEvent
extends SessionEvent

Session event "session.canvas.unavailable". Transient signal that an open canvas instance's provider has dropped (for example the extension is reloading mid-session). The host should keep the panel mounted and surface a reconnecting affordance rather than tearing it down; a subsequent `session.canvas.opened` for the same instanceId clears the affordance once the provider reconnects with a fresh url. Ephemeral and never persisted, so it is never replayed on cold resume.

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	SessionCanvasUnavailableEvent.SessionCanvasUnavailableEventData	Data payload for SessionCanvasUnavailableEvent.

Constructor Summary

Constructors

Constructor	Description
SessionCanvasUnavailableEvent()

Method Summary

Modifier and Type	Method	Description
SessionCanvasUnavailableEvent.SessionCanvasUnavailableEventData	getData()
String	getType()	Returns the event-type discriminator string (e.g., "session.idle").
void	setData(SessionCanvasUnavailableEvent.SessionCanvasUnavailableEventData data)

Methods inherited from class SessionEvent

getEphemeral, getId, getParentId, getTimestamp, setEphemeral, setId, setParentId, setTimestamp

Methods inherited from class Object

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

Constructor Details

SessionCanvasUnavailableEvent

public SessionCanvasUnavailableEvent()

Method Details

getType

public String getType()

Description copied from class: SessionEvent

Returns the event-type discriminator string (e.g., "session.idle").

Specified by:

getType in class SessionEvent

Returns:

the event type

getData

public SessionCanvasUnavailableEvent.SessionCanvasUnavailableEventData getData()

setData

public void setData(SessionCanvasUnavailableEvent.SessionCanvasUnavailableEventData data)