Package com.github.copilot.sdk.events

Class ExternalToolRequestedEvent

java.lang.Object

com.github.copilot.sdk.events.AbstractSessionEvent

com.github.copilot.sdk.events.ExternalToolRequestedEvent

public final class ExternalToolRequestedEvent
extends AbstractSessionEvent

Event: external_tool.requested

Broadcast when the CLI needs a client to handle a tool call (protocol v3). Clients that own the named tool should respond via session.tools.handlePendingToolCall.

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ExternalToolRequestedEvent.ExternalToolRequestedData

Constructor Summary

Constructors

Constructor	Description
ExternalToolRequestedEvent()

Method Summary

Modifier and Type	Method	Description
ExternalToolRequestedEvent.ExternalToolRequestedData	getData()
String	getType()	Gets the event type discriminator string.
void	setData(ExternalToolRequestedEvent.ExternalToolRequestedData 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

ExternalToolRequestedEvent

public ExternalToolRequestedEvent()

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 ExternalToolRequestedEvent.ExternalToolRequestedData getData()

setData

public void setData(ExternalToolRequestedEvent.ExternalToolRequestedData data)