Skip to content

Documentation / @agentick/angular / ChatSessionOptions

Interface: ChatSessionOptions<TMode> ​

Defined in: client/src/chat-types.ts:178

Extends ​

Type Parameters ​

TMode ​

TMode extends string = ChatMode

Properties ​

attachments? ​

optional attachments: AttachmentManagerOptions

Defined in: client/src/chat-types.ts:196

Attachment manager options.


autoFlush? ​

optional autoFlush: boolean

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

Inherited from ​

MessageSteeringOptions.autoFlush


autoSubscribe? ​

optional autoSubscribe: boolean

Defined in: client/src/chat-types.ts:192

Subscribe to the session's SSE transport on construction. Default: true.


confirmationPolicy? ​

optional confirmationPolicy: ConfirmationPolicy

Defined in: client/src/chat-types.ts:186

Auto-approve/deny policy. Passed to ToolConfirmations.


deriveMode? ​

optional deriveMode: ChatModeDeriver<TMode>

Defined in: client/src/chat-types.ts:188

Custom mode derivation. Type parameter inferred from return type.


flushMode? ​

optional flushMode: FlushMode

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

Inherited from ​

MessageSteeringOptions.flushMode


initialMessages? ​

optional initialMessages: ChatMessage[]

Defined in: client/src/chat-types.ts:182

Pre-loaded messages. Passed to MessageLog.


mode? ​

optional mode: SteeringMode

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

Inherited from ​

MessageSteeringOptions.mode


onEvent()? ​

optional onEvent: (event) => void

Defined in: client/src/chat-types.ts:190

Raw event hook — called for every event before processing.

Parameters ​

event ​

StreamEvent

Returns ​

void


renderMode? ​

optional renderMode: RenderMode

Defined in: client/src/chat-types.ts:194

Progressive rendering mode. Passed to MessageLog.


sessionId? ​

optional sessionId: string

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

Inherited from ​

MessageSteeringOptions.sessionId


subscribe? ​

optional subscribe: boolean

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

When false, caller must call processEvent() manually. Default: true.

Inherited from ​

MessageSteeringOptions.subscribe


transform? ​

optional transform: MessageTransform

Defined in: client/src/chat-types.ts:184

Custom message transform. Passed to MessageLog.

Released under the ISC License.