Skip to content

Documentation / @agentick/client / MessageSteering

Class: MessageSteering ​

Defined in: client/src/message-steering.ts:35

Constructors ​

Constructor ​

new MessageSteering(client, options?): MessageSteering

Defined in: client/src/message-steering.ts:48

Parameters ​

client ​

AgentickClient

options? ​

MessageSteeringOptions = {}

Returns ​

MessageSteering

Accessors ​

isExecuting ​

Get Signature ​

get isExecuting(): boolean

Defined in: client/src/message-steering.ts:87

Returns ​

boolean


mode ​

Get Signature ​

get mode(): SteeringMode

Defined in: client/src/message-steering.ts:91

Returns ​

SteeringMode


queued ​

Get Signature ​

get queued(): readonly Message[]

Defined in: client/src/message-steering.ts:83

Returns ​

readonly Message[]


state ​

Get Signature ​

get state(): MessageSteeringState

Defined in: client/src/message-steering.ts:79

Returns ​

MessageSteeringState

Methods ​

clearQueued() ​

clearQueued(): void

Defined in: client/src/message-steering.ts:131

Returns ​

void


destroy() ​

destroy(): void

Defined in: client/src/message-steering.ts:146

Returns ​

void


flush() ​

flush(): void

Defined in: client/src/message-steering.ts:119

Returns ​

void


interrupt() ​

interrupt(text, extraBlocks?): Promise<ClientExecutionHandle>

Defined in: client/src/message-steering.ts:111

Parameters ​

text ​

string

extraBlocks? ​

ContentBlock[] = []

Returns ​

Promise<ClientExecutionHandle>


onStateChange() ​

onStateChange(listener): () => void

Defined in: client/src/message-steering.ts:141

Parameters ​

listener ​

() => void

Returns ​

(): void

Returns ​

void


processEvent() ​

processEvent(event): void

Defined in: client/src/message-steering.ts:67

Process a stream event for execution tracking. Called automatically when self-subscribing (default), or manually by a parent controller (e.g. ChatSession).

Parameters ​

event ​

StreamEvent

Returns ​

void


queue() ​

queue(text): void

Defined in: client/src/message-steering.ts:107

Parameters ​

text ​

string

Returns ​

void


removeQueued() ​

removeQueued(index): void

Defined in: client/src/message-steering.ts:125

Parameters ​

index ​

number

Returns ​

void


setMode() ​

setMode(mode): void

Defined in: client/src/message-steering.ts:136

Parameters ​

mode ​

SteeringMode

Returns ​

void


steer() ​

steer(text, extraBlocks?): void

Defined in: client/src/message-steering.ts:103

Parameters ​

text ​

string

extraBlocks? ​

ContentBlock[] = []

Returns ​

void


submit() ​

submit(text, extraBlocks?): void

Defined in: client/src/message-steering.ts:95

Parameters ​

text ​

string

extraBlocks? ​

ContentBlock[] = []

Returns ​

void

Released under the ISC License.