Documentation / @agentick/react / UseMessageSteeringResult
Interface: UseMessageSteeringResult
Defined in: react/src/hooks/use-message-steering.ts:15
Properties
clearQueued()
clearQueued: () =>
void
Defined in: react/src/hooks/use-message-steering.ts:31
Clear all queued messages without sending.
Returns
void
flush()
flush: () =>
void
Defined in: react/src/hooks/use-message-steering.ts:27
Flush queued messages. In "sequential" flushMode, sends one; in "batched", sends all.
Returns
void
interrupt()
interrupt: (
text) =>Promise<ClientExecutionHandle>
Defined in: react/src/hooks/use-message-steering.ts:23
Abort the current execution and immediately send a new message.
Parameters
text
string
Returns
Promise<ClientExecutionHandle>
isExecuting
isExecuting:
boolean
Defined in: react/src/hooks/use-message-steering.ts:37
Whether an execution is currently in-flight.
mode
mode:
SteeringMode
Defined in: react/src/hooks/use-message-steering.ts:33
Current steering mode ("steer" | "queue"). Default: "steer".
queue()
queue: (
text) =>void
Defined in: react/src/hooks/use-message-steering.ts:21
Always queues regardless of mode or execution state.
Parameters
text
string
Returns
void
queued
queued: readonly
Message[]
Defined in: react/src/hooks/use-message-steering.ts:25
Messages waiting to be sent.
removeQueued()
removeQueued: (
index) =>void
Defined in: react/src/hooks/use-message-steering.ts:29
Remove a queued message by index.
Parameters
index
number
Returns
void
setMode()
setMode: (
mode) =>void
Defined in: react/src/hooks/use-message-steering.ts:35
Change the steering mode at runtime.
Parameters
mode
Returns
void
steer()
steer: (
text) =>void
Defined in: react/src/hooks/use-message-steering.ts:19
Always sends immediately regardless of mode or execution state.
Parameters
text
string
Returns
void
submit()
submit: (
text) =>void
Defined in: react/src/hooks/use-message-steering.ts:17
Mode-aware send. If idle, sends immediately. If executing: "steer" mode sends concurrently, "queue" mode queues for later.
Parameters
text
string
Returns
void