HarnessSessionImpl

Generated by TypeDoc. Do not edit this page directly.

API Reference

---

Class: HarnessSessionImpl

Defined in: packages/core/src/session/session.ts:60

Implements

• HarnessSession

Constructors

Constructor

new HarnessSessionImpl(config, input): HarnessSessionImpl;

Defined in: packages/core/src/session/session.ts:78

Parameters

Parameter	Type
config	HarnessAppConfig
input	{ agent: AgentDefinition; restoredSession?: HarnessSessionSummary; sessionId?: string; }
input.agent	AgentDefinition
input.restoredSession?	HarnessSessionSummary
input.sessionId?	string

Returns

HarnessSessionImpl

Properties

Property	Modifier	Type	Defined in
id	readonly	string	packages/core/src/session/session.ts:61
snapshots	readonly	HarnessSnapshotSession	packages/core/src/session/session.ts:63
transcript	readonly	HarnessTranscriptSession	packages/core/src/session/session.ts:62

Methods

approveTool()

approveTool(approvalId): Promise<void>;

Defined in: packages/core/src/session/session.ts:306

Parameters

Parameter	Type
approvalId	string

Returns

Promise<void>

Implementation of

HarnessSession.approveTool

---

clearModelOverride()

clearModelOverride(): void;

Defined in: packages/core/src/session/session.ts:265

Returns

void

Implementation of

HarnessSession.clearModelOverride

---

close()

close(): Promise<void>;

Defined in: packages/core/src/session/session.ts:332

Returns

Promise<void>

Implementation of

HarnessSession.close

---

denyTool()

denyTool(approvalId, _reason?): Promise<void>;

Defined in: packages/core/src/session/session.ts:310

Parameters

Parameter	Type
approvalId	string
_reason?	string

Returns

Promise<void>

Implementation of

HarnessSession.denyTool

---

getAgentManifest()

getAgentManifest(): HarnessAgentManifest;

Defined in: packages/core/src/session/session.ts:298

Returns

HarnessAgentManifest

Implementation of

HarnessSession.getAgentManifest

---

getContextSnapshot()

getContextSnapshot(): ContextSnapshot | undefined;

Defined in: packages/core/src/session/session.ts:294

Returns

ContextSnapshot | undefined

Implementation of

HarnessSession.getContextSnapshot

---

getEvents()

getEvents(filter?): HarnessEventRecord<unknown>[];

Defined in: packages/core/src/session/session.ts:290

Parameters

Parameter	Type
filter?	HarnessEventQuery<unknown>

Returns

HarnessEventRecord<unknown>[]

Implementation of

HarnessSession.getEvents

---

getMode()

getMode(): string;

Defined in: packages/core/src/session/session.ts:251

Returns

string

Implementation of

HarnessSession.getMode

---

getModel()

getModel(): string;

Defined in: packages/core/src/session/session.ts:255

Returns

string

Implementation of

HarnessSession.getModel

---

getPendingApprovals()

getPendingApprovals(): ToolApprovalHandle[];

Defined in: packages/core/src/session/session.ts:302

Returns

ToolApprovalHandle[]

Implementation of

HarnessSession.getPendingApprovals

---

getState()

getState(): AgentSharedState;

Defined in: packages/core/src/session/session.ts:276

Returns

AgentSharedState

Implementation of

HarnessSession.getState

---

getStatus()

getStatus(): HarnessSessionStatus;

Defined in: packages/core/src/session/session.ts:226

Returns

HarnessSessionStatus

Implementation of

HarnessSession.getStatus

---

hydrate()

hydrate(): Promise<void>;

Defined in: packages/core/src/session/session.ts:344

Returns

Promise<void>

---

on()

on(listener): () => void;

Defined in: packages/core/src/session/session.ts:314

Parameters

Parameter	Type
listener	HarnessSessionListener

Returns

() => void

Implementation of

HarnessSession.on

---

onEvent()

onEvent<TPayload, TEvent>(eventClass, listener): () => void;

Defined in: packages/core/src/session/session.ts:318

Type Parameters

Type Parameter
TPayload
TEvent extends HarnessEvent<TPayload>

Parameters

Parameter	Type
eventClass	HarnessEventClass<TPayload, TEvent>
listener	HarnessSessionEventListener<TEvent>

Returns

() => void

Implementation of

HarnessSession.onEvent

---

replaceState()

replaceState(next): void;

Defined in: packages/core/src/session/session.ts:285

Parameters

Parameter	Type
next	AgentSharedState

Returns

void

Implementation of

HarnessSession.replaceState

---

send()

send(input, options?): Promise<SendResult>;

Defined in: packages/core/src/session/session.ts:139

Parameters

Parameter	Type
input	string | HarnessUserInput
options?	SendOptions

Returns

Promise<SendResult>

Implementation of

HarnessSession.send

---

setModel()

setModel(model): void;

Defined in: packages/core/src/session/session.ts:259

Parameters

Parameter	Type
model	string

Returns

void

Implementation of

HarnessSession.setModel

---

stream()

stream(input, options?): HarnessRunStream;

Defined in: packages/core/src/session/session.ts:147

Parameters

Parameter	Type
input	string | HarnessUserInput
options	StreamOptions

Returns

HarnessRunStream

Implementation of

HarnessSession.stream

---

switchMode()

switchMode(mode, input?): Promise<void>;

Defined in: packages/core/src/session/session.ts:271

Parameters

Parameter	Type
mode	| string | HarnessModeSelector
input?	unknown

Returns

Promise<void>

Implementation of

HarnessSession.switchMode

---

updateState()

updateState(patch): void;

Defined in: packages/core/src/session/session.ts:280

Parameters

Parameter	Type
patch	unknown

Returns

void

Implementation of

HarnessSession.updateState

---

waitForEvent()

waitForEvent<TPayload, TEvent>(eventClass, options?): Promise<TEvent>;

Defined in: packages/core/src/session/session.ts:325

Type Parameters

Type Parameter
TPayload
TEvent extends HarnessEvent<TPayload>

Parameters

Parameter	Type
eventClass	HarnessEventClass<TPayload, TEvent>
options	WaitForEventOptions

Returns

Promise<TEvent>

Implementation of

HarnessSession.waitForEvent