bodhi-realtime-agent / SubagentSession

Interface: SubagentSession

Defined in: agent/subagent-session.ts:82

Public interface for interacting with an interactive subagent session.

Properties

state

readonly state: SubagentSessionState

Defined in: agent/subagent-session.ts:84

---

toolCallId

readonly toolCallId: string

Defined in: agent/subagent-session.ts:83

Methods

cancel()

cancel(): void

Defined in: agent/subagent-session.ts:105

Returns

void

---

cancellation()

cancellation(): Promise<never>

Defined in: agent/subagent-session.ts:93

Returns

Promise<never>

---

complete()

complete(result): void

Defined in: agent/subagent-session.ts:106

Parameters

result

unknown

Returns

void

---

hasUiRequest()

hasUiRequest(requestId): boolean

Defined in: agent/subagent-session.ts:103

Check if this session has a pending UI request with the given requestId.

Parameters

requestId

string

Returns

boolean

---

nextUserInput()

nextUserInput(): Promise<string>

Defined in: agent/subagent-session.ts:92

Returns

Promise<string>

---

onMessage()

onMessage(handler): void

Defined in: agent/subagent-session.ts:95

Parameters

handler

MessageHandler

Returns

void

---

onStateChange()

onStateChange(handler): void

Defined in: agent/subagent-session.ts:96

Parameters

handler

StateChangeHandler

Returns

void

---

registerUiRequest()

registerUiRequest(requestId, options): void

Defined in: agent/subagent-session.ts:99

Register a UI request for option-based responses (requestId → options mapping).

Parameters

requestId

string

options

SubagentOption[]

Returns

void

---

resolveOption()

resolveOption(requestId, selectedOptionId): SubagentOption | undefined

Defined in: agent/subagent-session.ts:101

Look up an option by requestId and selectedOptionId.

Parameters

requestId

string

selectedOptionId

string

Returns

SubagentOption | undefined

---

sendToSubagent()

sendToSubagent(input): void

Defined in: agent/subagent-session.ts:87

Parameters

input

string

Returns

void

---

sendToUser()

sendToUser(msg): void

Defined in: agent/subagent-session.ts:86

Parameters

msg

SubagentMessage

Returns

void

---

trySendToSubagent()

trySendToSubagent(input): boolean

Defined in: agent/subagent-session.ts:89

Non-throwing variant: returns false if state is not 'waiting_for_input'.

Parameters

input

string

Returns

boolean

---

waitForInput()

waitForInput(timeoutMs?): Promise<string>

Defined in: agent/subagent-session.ts:91

Parameters

timeoutMs?

number

Returns

Promise<string>