Class AgentApplicationBuilder<TState>

Builder class for creating and configuring AgentApplication instances.

Type Parameters

TState extends TurnState = TurnState
Type extending TurnState that will be used by the application

Index

Constructors

Properties

Accessors

Methods

build setStartTypingTimer withAuthorization withProactive withStorage withTurnStateFactory withTyping

Constructors

constructor

new AgentApplicationBuilder<
    TState extends
        TurnState<DefaultConversationState, DefaultUserState> = TurnState<
        DefaultConversationState,
        DefaultUserState,
    >,
>(): AgentApplicationBuilder<TState>
Type Parameters
- TState extends TurnState<DefaultConversationState, DefaultUserState> = TurnState<DefaultConversationState, DefaultUserState>
  Type extending TurnState that will be used by the application
Returns AgentApplicationBuilder<TState>

Properties

`Protected`_options

_options: Partial<AgentApplicationOptions<TState>> = {}

Accessors

`Protected`options

get options(): Partial<AgentApplicationOptions<TState>>
Gets the current options for the AgentApplication being built.

Returns Partial<AgentApplicationOptions<TState>>
The current options object
- Defined in packages/agents-hosting/src/app/agentApplicationBuilder.ts:25

Methods

build

build(): AgentApplication<TState>
Builds and returns a new AgentApplication instance configured with the provided options.

Returns AgentApplication<TState>
A new AgentApplication instance
- Defined in packages/agents-hosting/src/app/agentApplicationBuilder.ts:93

setStartTypingTimer

setStartTypingTimer(startTypingTimer: boolean): this
Configures whether the agent should display typing indicators.
Parameters
- startTypingTimer: boolean
  Whether to show typing indicators
Returns this
This builder instance for chaining
- Defined in packages/agents-hosting/src/app/agentApplicationBuilder.ts:54

withAuthorization

withAuthorization(authHandlers: AuthorizationOptions): this
Sets authentication options for the AgentApplication.
Parameters
- authHandlers: AuthorizationOptions
  The user identity authentication options
Returns this
This builder instance for chaining
- Defined in packages/agents-hosting/src/app/agentApplicationBuilder.ts:74

withProactive

withProactive(options: ProactiveOptions): this
Configures the proactive messaging subsystem.
Parameters
- options: ProactiveOptions
  Proactive options including optional storage backend
Returns this
This builder instance for chaining
- Defined in packages/agents-hosting/src/app/agentApplicationBuilder.ts:84

withStorage

withStorage(storage: Storage): this
Sets the storage provider for the AgentApplication.
Parameters
- storage: Storage
  The storage implementation to use
Returns this
This builder instance for chaining
- Defined in packages/agents-hosting/src/app/agentApplicationBuilder.ts:34

withTurnStateFactory

withTurnStateFactory(turnStateFactory: () => TState): this
Sets the factory function to create new TurnState instances.
Parameters
- turnStateFactory: () => TState
  Function that creates a new TurnState
Returns this
This builder instance for chaining
- Defined in packages/agents-hosting/src/app/agentApplicationBuilder.ts:44

withTyping

withTyping(typing: TypingOptions): this
Configures timing behavior for automatic typing indicators.
Parameters
- typing: TypingOptions
  Typing timer options
Returns this
This builder instance for chaining
- Defined in packages/agents-hosting/src/app/agentApplicationBuilder.ts:64