Package com.github.copilot.sdk.events

Class ElicitationRequestedEvent

java.lang.Object

com.github.copilot.sdk.events.AbstractSessionEvent

com.github.copilot.sdk.events.ElicitationRequestedEvent

public final class ElicitationRequestedEvent
extends AbstractSessionEvent

Event: elicitation.requested

Broadcast when the server or an MCP tool requests structured input from the user. Clients that have an elicitation handler should respond via session.ui.handlePendingElicitation.

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ElicitationRequestedEvent.ElicitationRequestedData
static final record	ElicitationRequestedEvent.ElicitationRequestedSchema

Constructor Summary

Constructors

Constructor	Description
ElicitationRequestedEvent()

Method Summary

Modifier and Type	Method	Description
ElicitationRequestedEvent.ElicitationRequestedData	getData()
String	getType()	Gets the event type discriminator string.
void	setData(ElicitationRequestedEvent.ElicitationRequestedData data)

Methods inherited from class com.github.copilot.sdk.events.AbstractSessionEvent

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

Methods inherited from class java.lang.Object

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

Constructor Details

ElicitationRequestedEvent

public ElicitationRequestedEvent()

Method Details

getType

public String getType()

Description copied from class: AbstractSessionEvent

Gets the event type discriminator string.

This corresponds to the event type in the JSON protocol (e.g., "assistant.message", "session.idle").

Specified by:

getType in class AbstractSessionEvent

Returns:

the event type string

getData

public ElicitationRequestedEvent.ElicitationRequestedData getData()

setData

public void setData(ElicitationRequestedEvent.ElicitationRequestedData data)