Microsoft Agents Hosting

https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting/
Admin
Microsoft Agents Hosting is a JavaScript SDK package that provides hosting and infrastructure...
Tokens:318,434
Snippets:4,141
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Start Express Server for Agent (Basic)

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-express

Starts a basic Express server to handle agent requests. This is the simplest way to get an agent running with Express.

```TypeScript
// Basic usage
import { AgentApplication, TurnState } from '@microsoft/agents-hosting';
import { startServer } from '@microsoft/agents-hosting-express';

const app = new AgentApplication<TurnState>();
startServer(app);


```

--------------------------------

### Start Express Server for Agent (With Options)

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-express

Starts an Express server with custom options, allowing configuration of the port, route path, and adding middleware like health checks before the server listens.

```TypeScript
// With options
import { AgentApplication, TurnState } from '@microsoft/agents-hosting';
import { startServer } from '@microsoft/agents-hosting-express';

const app = new AgentApplication<TurnState>();
startServer(app, {
  port: 8080,
  routePath: '/bot/messages',
  beforeListen: (server) => {
    server.get('/health', (req, res) => res.json({ status: 'ok' }));
  }
});


```

--------------------------------

### Property: activity

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting/turncontext

Gets the incoming activity that started this turn.

```APIDOC
## Property Details

### activity

Gets the incoming activity that started this turn.

#### Property Value

*   **Type**: Activity
```

--------------------------------

### Get Authentication Configuration with Defaults

Source: https://learn.microsoft.com/en-us/javascript/api/%40microsoft/agents-hosting

Loads authentication configuration from provided settings or environment variables, applying default values for authority and issuers. The example shows environment variable settings.

```text
tenantId=your-tenant-id
clientId=your-client-id
clientSecret=your-client-secret

certPemFile=your-cert-pem-file
certKeyFile=your-cert-key-file
sendX5C=false

FICClientId=your-FIC-client-id

connectionName=your-connection-name
authority=your-authority-endpoint
```

```typescript
function getAuthConfigWithDefaults(config?: AuthConfiguration): AuthConfiguration
```

--------------------------------

### Start a Prompt Dialog

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-dialogs/dialogcontext

Use this overload to start a prompt dialog with basic options. It formats the prompt and calls beginDialog.

```TypeScript
function prompt(dialogId: string, promptOrOptions: string | Partial<Activity> | PromptOptions): Promise<DialogTurnResult<any>>
```

--------------------------------

### Handle Apps Installed Event

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-extensions-teams/meeting

Registers a handler to be called when apps are installed during a meeting. Returns the Meeting instance for chaining.

```typescript
function onAppsInstalled(handler: RouteHandler<TurnState<DefaultConversationState, DefaultUserState>>): Meeting<TState>
```

--------------------------------

### Start Express Server with Agent Application

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-express

Use this function to start an Express server with an AgentApplication or ActivityHandler. It accepts an optional authentication configuration.

```typescript
function startServer(agent: AgentApplication<TurnState<any, any>> | ActivityHandler, authConfiguration?: AuthConfiguration): express.Express
```

--------------------------------

### onMeetingStart

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-extensions-teams/meeting

Registers a handler to be called when the meeting starts.

```APIDOC
## Method

### onMeetingStart(RouteHandler<TState>)

Triggered when a meeting starts.

#### Parameters 

* **handler** (RouteHandler<TState>) - Required - The handler to call when this event occurs.

#### Returns 

* Meeting<TState> - this (for method chaining)
```

--------------------------------

### get

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting/conversationstate

Gets the state from the turn context without loading it from storage.

```APIDOC
## get(context: TurnContext)

### Description
Gets the state from the turn context without loading it from storage.

### Parameters

* **context** (TurnContext) - Required - The turn context containing the state to get.

### Returns
any - The state object, or undefined if no state is found in the turn context.

**Inherited From** AgentState.get
```

--------------------------------

### Start a Prompt Dialog with Choices

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-dialogs/dialogcontext

Use this overload to start a prompt dialog that includes a predefined list of choices for the user. It formats the prompt and calls beginDialog.

```TypeScript
function prompt(dialogId: string, promptOrOptions: string | Partial<Activity> | PromptOptions, choices: (string | Choice)[]): Promise<DialogTurnResult<any>>
```

--------------------------------

### Start Typing Indicator Timer

Source: https://learn.microsoft.com/en-us/javascript/api/%40microsoft/agents-hosting/agentapplication

Shows how to start a typing indicator timer using startTypingTimer. The indicator provides user feedback during processing and automatically stops when a message is sent.

```typescript
app.startTypingTimer(turnContext);
// Do some processing...
await turnContext.sendActivity('Response after processing');
// Typing timer automatically stops when sending a message
```

```typescript
function startTypingTimer(context: TurnContext)
```

--------------------------------

### AgentApplication Example

Source: https://learn.microsoft.com/en-us/javascript/api/%40microsoft/agents-hosting

Demonstrates the basic usage of the AgentApplication class for setting up an agent, handling messages, and running the application with a turn context.

```APIDOC
## AgentApplication

### Description
Main application class for handling agent conversations and routing.

### Method
Constructor

### Parameters
- **options** (AgentApplicationOptions<TState>) - Required - Configuration options for the AgentApplication, including storage and adapter.

### Example
```typescript
const app = new AgentApplication<MyState>({
  storage: new MemoryStorage(),
  adapter: myAdapter
});

app.onMessage('hello', async (context, state) => {
  await context.sendActivity('Hello there!');
});

await app.run(turnContext);
```
```

--------------------------------

### startTypingTimer

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting/agentapplication

Starts a typing indicator timer for the current turn context.

```APIDOC
## startTypingTimer

### Description
Starts a typing indicator timer for the current turn context.

### Method
`startTypingTimer(TurnContext)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```typescript
app.startTypingTimer(turnContext);
// Do some processing...
await turnContext.sendActivity('Response after processing');
// Typing timer automatically stops when sending a message
```

### Response
#### Success Response (200)
Indicates the typing timer has started.

#### Response Example
```json
{
  "example": "Typing indicator started"
}
```
```

--------------------------------

### startServer (Basic Usage)

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-express

Starts an Express server for handling Agent requests using default options.

```APIDOC
## startServer (Basic Usage)

### Description
Starts an Express server for handling Agent requests with default configuration.

### Method Signature
`startServer(AgentApplication<TurnState<any, any>> | ActivityHandler)`

### Parameters
- **agentOrHandler**: `AgentApplication<TurnState<any, any>> | ActivityHandler` - The agent application or activity handler to serve.

### Example
```typescript
import { AgentApplication, TurnState } from '@microsoft/agents-hosting';
import { startServer } from '@microsoft/agents-hosting-express';

const app = new AgentApplication<TurnState>();
startServer(app);
```
```

--------------------------------

### Property: adapter

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting/turncontext

Gets the adapter that created this context.

```APIDOC
## Property Details

### adapter

Gets the adapter that created this context.

#### Property Value

*   **Type**: BaseAdapter
```

--------------------------------

### beginDialog

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-dialogs/dialogcontainer

When overridden in a derived class, starts the dialog.

```APIDOC
## beginDialog(DialogContext, O)

### Description
When overridden in a derived class, starts the dialog.

### Method
(Inherited Method)
```

--------------------------------

### startServer (With Options)

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-express

Starts an Express server for handling Agent requests with custom options, such as port, route path, and pre-listen hooks.

```APIDOC
## startServer (With Options)

### Description
Starts an Express server for handling Agent requests with custom configuration options.

### Method Signature
`startServer(AgentApplication<TurnState<any, any>> | ActivityHandler, StartServerOptions)`

### Parameters
- **agentOrHandler**: `AgentApplication<TurnState<any, any>> | ActivityHandler` - The agent application or activity handler to serve.
- **options**: `StartServerOptions` - An object containing configuration options for the server.
  - **port** (number) - Optional - The port to listen on. Defaults to 3978.
  - **routePath** (string) - Optional - The path for handling agent messages. Defaults to '/api/messages'.
  - **beforeListen** (function) - Optional - A callback function executed before the server starts listening, receiving the server instance.

### Example
```typescript
import { AgentApplication, TurnState } from '@microsoft/agents-hosting';
import { startServer } from '@microsoft/agents-hosting-express';

const app = new AgentApplication<TurnState>();
startServer(app, {
  port: 8080,
  routePath: '/bot/messages',
  beforeListen: (server) => {
    server.get('/health', (req, res) => res.json({ status: 'ok' }));
  }
});
```
```

--------------------------------

### Get Transcript Activities

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-storage-blob/blobstranscriptstore

Retrieves transcript activities for a specific conversation. Supports filtering by start date and pagination using a continuation token.

```typescript
function getTranscriptActivities(channelId: string, conversationId: string, continuationToken?: string, startDate?: Date): Promise<PagedResult<Activity>>
```

--------------------------------

### AgentApplication Initialization and Usage

Source: https://learn.microsoft.com/en-us/javascript/api/%40microsoft/agents-hosting/agentapplication

Demonstrates how to initialize an AgentApplication instance and set up a message handler for basic conversational interaction.

```APIDOC
## AgentApplication Class

### Description
The `AgentApplication` class is the primary class for managing agent conversations and routing activities within the `@microsoft/agents-hosting` SDK. It provides a framework for building conversational agents, handling state, and supporting authentication.

### Remarks
Key features of `AgentApplication` include:
*   Activity routing based on type, content, or custom selectors.
*   State management with automatic loading and saving.
*   OAuth authentication support.
*   Typing indicators and long-running message support.
*   An extensible architecture with custom extensions.
*   Event handlers for before and after turn processing.

### Example
```typescript
import { AgentApplication, MemoryStorage } from '@microsoft/agents-hosting';

// Assuming myAdapter and MyState are defined elsewhere
// const myAdapter = ...;
// interface MyState { /* ... */ }

const app = new AgentApplication<MyState>({
  storage: new MemoryStorage(),
  adapter: myAdapter
});

app.onMessage('hello', async (context, state) => {
  await context.sendActivity('Hello there!');
});

// Assuming turnContext is available
// await app.run(turnContext);
```
```

--------------------------------

### Get Top Scoring Intent Example

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-dialogs

Demonstrates how to find the intent with the highest confidence score from a recognizer result. This is useful for understanding the user's primary goal.

```typescript
const result: RecognizerResult = {
  text: "Book a flight to Seattle",
  intents: {
    "BookFlight": { score: 0.95 },
    "Cancel": { score: 0.02 },
    "Help": { score: 0.03 }
  }
};

const topIntent = getTopScoringIntent(result);
// Returns: { intent: "BookFlight", score: 0.95 }
```

--------------------------------

### Initialize and Use AgentApplication

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting/agentapplication

Demonstrates how to initialize an AgentApplication with memory storage and a custom adapter, register a message handler, and run the application with a turn context.

```TypeScript
const app = new AgentApplication<MyState>({
  storage: new MemoryStorage(),
  adapter: myAdapter
});

app.onMessage('hello', async (context, state) => {
  await context.sendActivity('Hello there!');
});

await app.run(turnContext);
```

--------------------------------

### Manage User Profile State

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting/?view=agents-sdk-js-latest

Create and manage a user profile property within agent state. This example shows how to get a profile with default values, modify it, and save changes.

```TypeScript
// Create a property accessor
const userProfile = userState.createProperty<UserProfile>("userProfile");

// Get with default value
const profile = await userProfile.get(context, {
  name: "",
  preferences: { theme: "light", language: "en" }
});

// Modify the profile
profile.preferences.theme = "dark";

// Save the changes
await userProfile.set(context, profile); 
await userState.saveChanges(context); // Persist to storage
```

--------------------------------

### AgentApplication Example

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting/?view=agents-sdk-js-latest

Demonstrates the basic usage of the AgentApplication class for handling incoming messages and running the agent.

```APIDOC
## AgentApplication

### Description
Main application class for handling agent conversations and routing.

### Method
Constructor

### Parameters
- **state**: Type parameter for the agent's state.
- **options**: Configuration options for the AgentApplication.
  - **storage**: Storage mechanism for agent state.
  - **adapter**: The adapter to use for communication.

### Code Example
```typescript
const app = new AgentApplication<MyState>({
  storage: new MemoryStorage(),
  adapter: myAdapter
});

app.onMessage('hello', async (context, state) => {
  await context.sendActivity('Hello there!');
});

await app.run(turnContext);
```
```

--------------------------------

### startServer

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-express

Starts an agent server, accepting an AgentApplication or ActivityHandler and an optional authentication configuration. It returns an Express application instance.

```APIDOC
## startServer

### Description
Initiates an agent server with the provided agent application or activity handler and an optional authentication configuration. This function returns an Express.js application instance, allowing for further server configuration and management.

### Method
```typescript
function startServer(agent: AgentApplication<TurnState<any, any>> | ActivityHandler, authConfiguration?: AuthConfiguration): express.Express
```

### Parameters
#### agent
- **agent** (AgentApplication<TurnState<any, any>> | ActivityHandler) - Required - The agent application or activity handler to start the server with.

#### authConfiguration
- **authConfiguration** (AuthConfiguration) - Optional - Configuration for authentication.

### Returns
- **express.Express** - The Express application instance for the started server.
```

--------------------------------

### onInstallationUpdate

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting/activityhandler

Registers a handler for the InstallationUpdate activity type. This is called when an agent is installed or uninstalled.

```APIDOC
## onInstallationUpdate(AgentHandler)

### Description
Registers a handler for the InstallationUpdate activity type. This is called when an agent is installed or uninstalled.

### Method Signature
```typescript
function onInstallationUpdate(handler: AgentHandler): ActivityHandler
```

### Parameters
#### handler
- **AgentHandler** - The handler to register

### Returns
- **ActivityHandler** - The current instance for method chaining
```

--------------------------------

### get(context: TurnContext)

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting/userstate

Gets the state from the turn context without loading it from storage.

```APIDOC
## get(context: TurnContext)

### Description
Gets the state from the turn context without loading it from storage.

### Parameters

- **context** (TurnContext) - Required - The turn context containing the state to get.

### Returns
any - The state object, or undefined if no state is found in the turn context.

**Inherited From** AgentState.get
```

--------------------------------

### FileStorage Basic Usage Example

Source: https://learn.microsoft.com/en-us/javascript/api/%40microsoft/agents-hosting/filestorage

Demonstrates how to create a FileStorage instance, write data, read specific keys, and delete data. Assumes the 'FileStorage' class is imported and available.

```typescript
const storage = new FileStorage('./data');

// Write some data
await storage.write({
  'user123': { name: 'John', lastSeen: new Date().toISOString() },
  'conversation456': { turn: 5, context: 'discussing weather' }
});

// Read specific keys
const data = await storage.read(['user123']);
console.log(data.user123); // { name: 'John', lastSeen: '...' }

// Delete data
await storage.delete(['conversation456']);

```

--------------------------------

### Get TurnStateEntry storage key

Source: https://learn.microsoft.com/en-us/javascript/api/%40microsoft/agents-hosting/turnstateentry

Gets the storage key associated with this entry, which is used for persistence.

```typescript
undefined | string storageKey
```

--------------------------------

### onInstallationUpdateAdd

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting/activityhandler

Registers a handler for the InstallationUpdateAdd activity type. This is called when an agent is installed or upgraded.

```APIDOC
## onInstallationUpdateAdd(AgentHandler)

### Description
Registers a handler for the InstallationUpdateAdd activity type. This is called when an agent is installed or upgraded.

### Method Signature
```typescript
function onInstallationUpdateAdd(handler: AgentHandler): ActivityHandler
```

### Parameters
#### handler
- **AgentHandler** - The handler to register

### Returns
- **ActivityHandler** - The current instance for method chaining
```

--------------------------------

### Register Installation Update Handler

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting/activityhandler

Registers a handler for the InstallationUpdate activity. This is triggered when an agent is installed or uninstalled.

```typescript
function onInstallationUpdate(handler: AgentHandler): ActivityHandler
```

--------------------------------

### Value Property Example

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-dialogs/foundvalue

Provides an example for the 'value' property of the FoundValue interface, which is the exact string that was matched.

```typescript
"red" (when user typed "rd" and it matched "red")
```

--------------------------------

### use

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting/baseadapter

Adds middleware to the adapter's middleware pipeline. Returns the adapter instance for chaining.

```APIDOC
## use

### Description
Adds middleware to the adapter's middleware pipeline.

### Method
`use(middlewares: (MiddlewareHandler | Middleware)[]): BaseAdapter`

### Parameters

*   **middlewares** ((MiddlewareHandler | Middleware)[]) - The middleware to add.

### Returns
`BaseAdapter` - The adapter instance.
```

--------------------------------

### run Method

Source: https://learn.microsoft.com/en-us/javascript/api/%40microsoft/agents-hosting/middlewareset

Executes the entire middleware chain for the current turn.

```APIDOC
## run

### Description
Runs the middleware chain.

### Parameters

*   **context** (TurnContext) - Required - The turn context.
*   **next** (() => Promise<void>) - Required - The next function to call.

### Returns

Promise<void> - A promise representing the asynchronous operation.
```

--------------------------------

### Register Installation Update Add Handler

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting/activityhandler

Registers a handler for the InstallationUpdateAdd activity. This is called when an agent is installed or upgraded.

```typescript
function onInstallationUpdateAdd(handler: AgentHandler): ActivityHandler
```

--------------------------------

### build()

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting/agentapplicationbuilder

Builds and returns a new AgentApplication instance configured with the provided options.

```APIDOC
## build()

### Description
Builds and returns a new AgentApplication instance configured with the provided options.

### Method
```typescript
function build(): AgentApplication<TState>
```

### Returns
AgentApplication<TState>
- A new AgentApplication instance
```

--------------------------------

### Score Property Example

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-dialogs/foundvalue

Shows examples of the 'score' property for the FoundValue interface, representing the confidence level of a match.

```typescript
1.0 for exact matches, 0.8 for close partial matches, 0.3 for distant fuzzy matches
```

--------------------------------

### run

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting/agentapplication

Executes the application logic for a given turn context.

```APIDOC
## run

### Description
Executes the application logic for a given turn context.

### Method
`run(TurnContext)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```typescript
const app = new AgentApplication();
await app.run(turnContext);
```

### Response
#### Success Response (200)
Indicates successful execution of application logic.

#### Response Example
```json
{
  "example": "Execution successful"
}
```
```

--------------------------------

### Handle Meeting Start Event

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-extensions-teams/meeting

Registers a handler to be called when a meeting starts. Returns the Meeting instance for chaining.

```typescript
function onMeetingStart(handler: RouteHandler<TState>): Meeting<TState>
```

--------------------------------

### Make Instances

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-dialogs/servicecollection

Builds and returns all registered service instances.

```TypeScript
function makeInstances<InstancesType>(): InstancesType
```

--------------------------------

### beginDialog

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-dialogs/waterfallstepcontext

Starts a dialog instance and pushes it onto the dialog stack, optionally passing arguments to it. If another dialog is active, it will be paused.

```APIDOC
## beginDialog(dialogId: string, options?: object)

### Description
Starts a dialog instance and pushes it onto the dialog stack. Creates a new instance of the dialog and pushes it onto the stack.

### Method Signature
```typescript
function beginDialog(dialogId: string, options?: object): Promise<DialogTurnResult<any>>
```

### Parameters
#### dialogId
- **dialogId** (string) - Required - ID of the dialog to start.
#### options
- **options** (object) - Optional - Arguments to pass into the dialog when it starts.

### Remarks
If there's already an active dialog on the stack, that dialog will be paused until it is again the top dialog on the stack.
The status of returned object describes the status of the dialog stack after this method completes.
This method throws an exception if the requested dialog can't be found in this dialog context or any of its ancestors.
**Inherited From** DialogContext.beginDialog
```

--------------------------------

### FoundValue Example

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-dialogs/foundvalue

Demonstrates the structure of a FoundValue object returned from a search operation. This example shows a perfect match for 'red'.

```typescript
// Example of a FoundValue result from searching for "red" in ["red", "green", "blue"]
const foundValue: FoundValue = {
  value: "red",
  index: 0,
  score: 1.0
};
```

--------------------------------

### Prompt configure Method

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-dialogs/textprompt

A fluent method for configuring the object. Use this to apply configuration settings to the TextPrompt instance.

```typescript
function configure(config: Record<string, unknown>): TextPrompt
```

--------------------------------

### ModelResult Interface - start Property

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-dialogs/modelresult

Represents the start index of a match within the input text. This property is of type number.

```typescript
start: number
```

--------------------------------

### configure

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-dialogs/activityprompt

Configures the Activity Prompt dialog with specified settings. This is a fluent method that allows for chaining configuration options.

```APIDOC
## configure(config: Record<string, unknown>)

### Description
Fluent method for configuring the object.

### Parameters
#### Parameters
- **config** (Record<string, unknown>) - Required - Configuration settings to apply.

### Returns
ActivityPrompt - The Configurable after the operation is complete.

### Remarks
Inherited From Dialog.configure
```

--------------------------------

### Get TurnStateEntry value

Source: https://learn.microsoft.com/en-us/javascript/api/%40microsoft/agents-hosting/turnstateentry

Gets the current value of the entry. If the entry was marked for deletion, it will be reset to an empty object and marked as not deleted.

```typescript
Record<string, unknown> value
```

--------------------------------

### StartServerOptions Interface

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-express/startserveroptions

The `StartServerOptions` interface provides configuration options for the Express server started by the `startServer` function. These options allow for customization of authentication, server behavior before listening, port selection, rate limiting, and the message route path.

```APIDOC
## StartServerOptions Interface

### Description
Options for configuring the Express server started by `startServer`.

### Properties

- **authConfig** (AuthConfiguration) - Optional - Custom authentication configuration. If not provided, configuration will be loaded from environment variables using `loadAuthConfigFromEnv()`.
- **beforeListen** ((app: Express) => void) - Optional - A callback invoked with the Express app before `listen()` is called. Use this to add custom routes, middleware, or static file serving. Note: The agent messages route is registered _after_ this callback. Avoid adding catch-all routes (e.g., `app.all('*', ...)` or `app.use('*', ...)`) here, as they will shadow the messages endpoint.
- **port** (string | number) - Optional - The port to listen on. Defaults to `process.env.PORT` or `3978`.
- **rateLimitOptions** ({ max: number, windowMs: number }) - Optional - Optional rate limiting configuration for the messages endpoint. If not provided, no rate limiting is applied. Specify `windowMs` (in milliseconds) and `max` (number of requests) to enable rate limiting.
- **routePath** (string) - Optional - The route path for the agent messages endpoint. Defaults to `'/api/messages'`.
```

--------------------------------

### Start and Stop Typing Indicator Timer

Source: https://learn.microsoft.com/en-us/javascript/api/%40microsoft/agents-hosting/agentapplication

Manages the typing indicator timer. Start it before processing and stop it after sending a response or explicitly.

```typescript
app.startTypingTimer(turnContext)
// Do some processing...
app.stopTypingTimer(turnContext)
```

--------------------------------

### Create AgentApplication Instance

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting/agentapplication

Initializes a new AgentApplication with specified options for storage, adapter, typing timers, authorization, and logging.

```typescript
const app = new AgentApplication({
  storage: new MemoryStorage(),
  adapter: myAdapter,
  startTypingTimer: true,
  authorization: { connectionName: 'oauth' },
  transcriptLogger: myTranscriptLogger,
});
```

--------------------------------

### Capture Stack Trace Example

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-dialogs/dialogcontexterror

Demonstrates how to create a '.stack' property on an object, capturing the call stack at the point of execution.

```javascript
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`
```

--------------------------------

### TypeScript Signature for get (with default)

Source: https://learn.microsoft.com/en-us/javascript/api/%40microsoft/agents-hosting/statepropertyaccessor

The TypeScript signature for the get method when a default value is provided. It returns a Promise of the property's type.

```typescript
function get(context: TurnContext, defaultValue: T): Promise<T>
```

--------------------------------

### HttpClient get Method

Source: https://learn.microsoft.com/en-us/javascript/api/%40microsoft/agents-hosting/httpclient

Performs an HTTP GET request. It takes a URL string and optional request configuration, returning a Promise of HttpResponse.

```typescript
function get<T>(url: string, options?: Partial<HttpRequestConfig>): Promise<HttpResponse<T>>
```

--------------------------------

### Make Instance

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-dialogs/servicecollection

Builds and returns a single service instance based on its key. Optionally, dependencies can be reconstructed.

```TypeScript
function makeInstance<InstanceType>(key: string, deep?: boolean): undefined | InstanceType
```

--------------------------------

### Load Authentication Configuration with Defaults

Source: https://learn.microsoft.com/en-us/javascript/api/%40microsoft/agents-hosting

Loads authentication configuration from provided settings or environment variables, applying default values for authority and issuers. This example shows environment variable settings.

```env
tenantId=your-tenant-id
clientId=your-client-id
clientSecret=your-client-secret

certPemFile=your-cert-pem-file
certKeyFile=your-cert-key-file
sendX5C=false

FICClientId=your-FIC-client-id

connectionName=your-connection-name
authority=your-authority-endpoint
```

--------------------------------

### Start Typing Indicator Timer

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting/agentapplication

Starts a typing indicator timer for the current turn context. The indicator stops automatically when a message is sent.

```TypeScript
app.startTypingTimer(turnContext);
// Do some processing...
await turnContext.sendActivity('Response after processing');
// Typing timer automatically stops when sending a message

```

```TypeScript
function startTypingTimer(context: TurnContext)
```

--------------------------------

### beginDialog

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-dialogs/dialogcontext

Starts a dialog instance and pushes it onto the dialog stack. Creates a new instance of the dialog and pushes it onto the stack. If there's already an active dialog on the stack, that dialog will be paused until it is again the top dialog on the stack.

```APIDOC
## beginDialog(dialogId, options)

### Description
Starts a dialog instance and pushes it onto the dialog stack. Creates a new instance of the dialog and pushes it onto the stack.

### Method Signature
```typescript
function beginDialog(dialogId: string, options?: object): Promise<DialogTurnResult<any>>
```

### Parameters
#### Path Parameters
* **dialogId** (string) - Required - ID of the dialog to start.
* **options** (object) - Optional - Arguments to pass into the dialog when it starts.

### Returns
* **Promise<DialogTurnResult<any>>** - A promise resolving to the dialog turn result.

### Remarks
If there's already an active dialog on the stack, that dialog will be paused until it is again the top dialog on the stack. The status of returned object describes the status of the dialog stack after this method completes. This method throws an exception if the requested dialog can't be found in this dialog context or any of its ancestors.
```

--------------------------------

### TypeScript Signature for get (no default)

Source: https://learn.microsoft.com/en-us/javascript/api/%40microsoft/agents-hosting/statepropertyaccessor

The TypeScript signature for the get method when no default value is provided. It returns a Promise of the property's type or undefined.

```typescript
function get(context: TurnContext): Promise<undefined | T>
```

--------------------------------

### Initialize CosmosDbPartitionedStorage

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-storage-cosmos/cosmosdbpartitionedstorage

Initializes a new instance of the CosmosDbPartitionedStorage class. Requires CosmosDbPartitionedStorageOptions for configuration.

```typescript
new CosmosDbPartitionedStorage(cosmosDbStorageOptions: CosmosDbPartitionedStorageOptions)
```

--------------------------------

### Register Teams Meeting Start Event Handler

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-extensions-teams/teamsactivityhandler

Registers a handler for when a Teams meeting starts. This is useful for initializing meeting-specific resources or sending pre-meeting notifications.

```TypeScript
function onTeamsMeetingStartEvent(handler: (meeting: MeetingStartEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>): TeamsActivityHandler
```

--------------------------------

### makeInstance<InstanceType>

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-dialogs/servicecollection

Builds and returns a single service instance based on its key. Optionally, it can perform a deep reconstruction of all its dependencies.

```APIDOC
## Method makeInstance<InstanceType>

### Description
Build a single service.

### Method Signature
`function makeInstance<InstanceType>(key: string, deep?: boolean): undefined | InstanceType`

### Parameters

*   **key** (`string`) - Required - The key of the service to build.
*   **deep** (`boolean`) - Optional - Whether to reconstruct all dependencies.

### Returns
`undefined | InstanceType` - The service instance, or `undefined` if it cannot be created.
```

--------------------------------

### Create AgentStatePropertyAccessor Instance

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting/agentstatepropertyaccessor

Demonstrates the recommended way to create a property accessor using `AgentState.createProperty`. Direct construction is also shown but not recommended.

```typescript
// Recommended way - use AgentState.createProperty
const userProfile = userState.createProperty<UserProfile>("userProfile");

// Direct construction (not recommended)
const accessor = new AgentStatePropertyAccessor<UserProfile>(userState, "userProfile");

```

--------------------------------

### MeetingStartEventDetails Interface

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-extensions-teams/meetingstarteventdetails

Represents the details of a meeting start event, including its start time. It inherits properties like id, joinUrl, meetingType, and title from the MeetingEventDetails interface.

```APIDOC
## Interface: MeetingStartEventDetails

Package:
    @microsoft/agents-hosting-extensions-teams

Interface representing the details of a meeting start event.

Extends
    MeetingEventDetails

### Properties

#### startTime

The start time of the meeting.

*   **Type**: Date
*   **Required**: Yes

### Inherited Properties from MeetingEventDetails

#### id

The unique identifier of the meeting.

*   **Type**: string
*   **Required**: Yes

#### joinUrl

The URL to join the meeting.

*   **Type**: string
*   **Required**: Yes

#### meetingType

The type of the meeting.

*   **Type**: string
*   **Required**: Yes

#### title

The title of the meeting.

*   **Type**: string
*   **Required**: Yes

```

--------------------------------

### configure Method

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-dialogs/confirmprompt

A fluent method for applying configuration settings to the object. Returns the configured ConfirmPrompt instance.

```typescript
function configure(config: Record<string, unknown>): ConfirmPrompt
```

--------------------------------

### Building Conversation from Scratch and TurnContext

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting/conversationbuilder

Demonstrates how to create a Conversation object either by providing all necessary details or by initializing from an existing TurnContext.

```typescript
// Build from scratch
const conv = ConversationBuilder
  .create('my-client-id', 'msteams')
  .withUser('user-aad-id')
  .withConversationId('19:channel@thread.skype')
  .build()

// Build from a live TurnContext
const conv = ConversationBuilder.fromContext(turnContext).build()
```

--------------------------------

### Get Singleton MemoryStorage Instance

Source: https://learn.microsoft.com/en-us/javascript/api/%40microsoft/agents-hosting/memorystorage

Gets a single shared instance of the MemoryStorage class. Using this method ensures that the same storage instance is used across the application, allowing for shared state without passing references.

```typescript
static function getSingleInstance(): MemoryStorage
```

--------------------------------

### use

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting/baseadapter

Adds middleware to the adapter's middleware pipeline.

```APIDOC
## use

### Description
Adds middleware to the adapter's middleware pipeline.

### Parameters
- **middleware** (MiddlewareHandler | Middleware[]) - Required - The middleware to add.

### Returns
- void
```

--------------------------------

### Initialize and Configure ActivityHandler

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting/activityhandler

Demonstrates how to create an instance of ActivityHandler and register handlers for 'onMessage' and 'onMembersAdded' events. This is useful for setting up basic conversational logic.

```typescript
const handler = new ActivityHandler()
  .onMessage(async (context, next) => {
    await context.sendActivity('Hello!');
    await next();
  })
  .onMembersAdded(async (context, next) => {
    // Welcome new members
    await next();
  });

```

--------------------------------

### onTurnError

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting/baseadapter

Gets the error handler for the adapter.

```APIDOC
## onTurnError

### Description
Gets the error handler for the adapter.

### Property Value
(context: TurnContext, error: Error) => Promise<void>
The current error handler function.
```

--------------------------------

### CosmosDbPartitionedStorage Constructor

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-storage-cosmos/cosmosdbpartitionedstorage

Initializes a new instance of the CosmosDbPartitionedStorage class with the specified options.

```APIDOC
## new CosmosDbPartitionedStorage(CosmosDbPartitionedStorageOptions)

### Description
Initializes a new instance of the CosmosDbPartitionedStorage class.

### Parameters
#### cosmosDbStorageOptions
- **cosmosDbStorageOptions** (CosmosDbPartitionedStorageOptions) - Required - The options for configuring Cosmos DB partitioned storage.
```

--------------------------------

### DialogStateManager.version

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-dialogs/dialogstatemanager

Gets the version number of the DialogStateManager.

```APIDOC
## Method DialogStateManager.version

### Description
Gets the version number.

### Returns
string - A string with the version number.
```

--------------------------------

### stack

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-dialogs/dialogcontext

Gets the current dialog stack.

```APIDOC
## stack

### Description
Gets the current dialog stack.

### Property Value
`DialogInstance<any>[]`
```

--------------------------------

### AgentApplication Constructor

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting/agentapplication

Creates a new instance of AgentApplication. It requires options for storage, adapter, and other configurations.

```APIDOC
## AgentApplication<TState>(Partial<AgentApplicationOptions<TState>>)

### Description
Creates a new instance of AgentApplication.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **options** (Partial<AgentApplicationOptions<TState>>) - Required - Options to configure the AgentApplication.

### Request Example
```typescript
const app = new AgentApplication({
  storage: new MemoryStorage(),
  adapter: myAdapter,
  startTypingTimer: true,
  authorization: { connectionName: 'oauth' },
  transcriptLogger: myTranscriptLogger,
});
```

### Response
#### Success Response (200)
An instance of AgentApplication.

#### Response Example
```typescript
// No direct response example, as it's a constructor.
```
```

--------------------------------

### startServer

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-express

Starts an Express server to handle Agent requests. This function sets up the necessary middleware and routes, including JWT authorization on the messages route. It configures the server to listen on a specified port or defaults to 3978.

```APIDOC
## startServer

### Description
Starts an Express server for handling Agent requests. This function sets up an Express server with the necessary middleware and routes for handling agent requests. It configures JWT authorization middleware on the messages route and sets up the endpoint. The server will listen on the port specified in options, the PORT environment variable, or 3978 by default.

### Method Signature
`startServer(agent: AgentApplication<TurnState<any, any>> | ActivityHandler, options?: StartServerOptions): express.Express`

### Parameters
#### agent
- **Type**: `AgentApplication<TurnState<any, any>> | ActivityHandler`
- **Description**: The AgentApplication or ActivityHandler instance to process incoming activities.

#### options
- **Type**: `StartServerOptions`
- **Description**: Optional configuration. Accepts either a `StartServerOptions` object or an `AuthConfiguration` for backward compatibility.

### Returns
- **Type**: `express.Express`
- **Description**: The Express server instance.

### Remarks
This function sets up an Express server with the necessary middleware and routes for handling agent requests. It configures JWT authorization middleware on the messages route and sets up the endpoint. The server will listen on the port specified in options, the PORT environment variable, or 3978 by default.
```

--------------------------------

### context

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-dialogs/dialogcontext

Gets the context object for the turn.

```APIDOC
## context

### Description
Gets the context object for the turn.

### Property Value
`TurnContext`
```

--------------------------------

### Property: streamingResponse

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting/turncontext

Gets the streaming response for the turn.

```APIDOC
## Property Details

### streamingResponse

#### Property Value

*   **Type**: StreamingResponse
```

--------------------------------

### use Method

Source: https://learn.microsoft.com/en-us/javascript/api/%40microsoft/agents-hosting/cloudadapter

Adds middleware to the adapter's middleware pipeline, allowing for custom processing of turns.

```APIDOC
## use(middleware: MiddlewareHandler | Middleware[])

### Description
Adds middleware to the adapter's middleware pipeline.

### Parameters
#### Parameters
- **middleware** (MiddlewareHandler | Middleware[]) - The middleware handler or an array of middleware handlers to add.
```

--------------------------------

### Run AgentApplication with TurnContext

Source: https://learn.microsoft.com/en-us/javascript/api/%40microsoft/agents-hosting/agentapplication

Shows how to execute the application's logic for a given turn using the run method. This is the primary entry point for processing user input.

```typescript
const app = new AgentApplication();
await app.run(turnContext);
```

```typescript
function run(turnContext: TurnContext): Promise<void>
```

--------------------------------

### Property: locale

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting/turncontext

Gets or sets the locale for the turn.

```APIDOC
## Property Details

### locale

Gets or sets the locale for the turn.

#### Property Value

*   **Type**: undefined | string
```

--------------------------------

### Property: identity

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting/turncontext

Gets the identity payload for the turn.

```APIDOC
## Property Details

### identity

#### Property Value

*   **Type**: JwtPayload
```

--------------------------------

### Create AgentClient Instance

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting/agentclient

Instantiates the AgentClient class. Use the agent's configuration key to locate settings in environment variables.

```typescript
new AgentClient(agentConfigKey: string)
```

--------------------------------

### getAgenticUserToken

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting/authprovider

Get an access token for the agentic user.

```APIDOC
## getAgenticUserToken

### Description
Get an access token for the agentic user.

### Method
Not applicable (property of AuthProvider interface)

### Parameters
- **tenantId** (string) - Required - The ID of the tenant.
- **agentAppInstanceId** (string) - Required - The ID of the agent application instance.
- **upn** (string) - Required - The user principal name.
- **scopes** (string[]) - Required - An array of scopes for which the token is requested.

### Response
#### Success Response
- **Promise<string>** - A promise that resolves to the access token string.

### Response Example
```json
{
  "accessToken": "string"
}
```
```

--------------------------------

### MsalTokenProvider Constructor

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting/msaltokenprovider

Initializes a new instance of the MsalTokenProvider class.

```APIDOC
## new MsalTokenProvider(connectionSettings?: AuthConfiguration)

### Description
Initializes a new instance of the MsalTokenProvider class.

### Parameters
#### connectionSettings
- **connectionSettings** (AuthConfiguration) - Optional - The AuthConfiguration used for token acquisition.
```

--------------------------------

### getAgenticInstanceToken

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting/authprovider

Get an access token for the agentic instance.

```APIDOC
## getAgenticInstanceToken

### Description
Get an access token for the agentic instance.

### Method
Not applicable (property of AuthProvider interface)

### Parameters
- **tenantId** (string) - Required - The ID of the tenant.
- **agentAppInstanceId** (string) - Required - The ID of the agent application instance.

### Response
#### Success Response
- **Promise<string>** - A promise that resolves to the access token string.

### Response Example
```json
{
  "accessToken": "string"
}
```
```

--------------------------------

### CloudAdapter Constructor

Source: https://learn.microsoft.com/en-us/javascript/api/%40microsoft/agents-hosting/cloudadapter

Creates an instance of CloudAdapter. This is the primary way to instantiate the adapter, requiring authentication and token client configurations.

```APIDOC
## CloudAdapter(AuthConfiguration, AuthProvider, UserTokenClient, CloudAdapterOptions)

### Description
Creates an instance of CloudAdapter.

### Parameters
* **AuthConfiguration** (AuthConfiguration) - Required - Configuration for authentication.
* **AuthProvider** (AuthProvider) - Required - The authentication provider.
* **UserTokenClient** (UserTokenClient) - Required - Client for managing user tokens.
* **CloudAdapterOptions** (CloudAdapterOptions) - Optional - Options for configuring the CloudAdapter.
```

--------------------------------

### getAgenticApplicationToken

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting/authprovider

Get an access token for the agentic application.

```APIDOC
## getAgenticApplicationToken

### Description
Get an access token for the agentic application.

### Method
Not applicable (property of AuthProvider interface)

### Parameters
- **tenantId** (string) - Required - The ID of the tenant.
- **agentAppInstanceId** (string) - Required - The ID of the agent application instance.

### Response
#### Success Response
- **Promise<string>** - A promise that resolves to the access token string.

### Response Example
```json
{
  "accessToken": "string"
}
```
```

--------------------------------

### dialogs

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-dialogs/dialogcontext

Gets the dialogs that can be called directly from this context.

```APIDOC
## dialogs

### Description
Gets the dialogs that can be called directly from this context.

### Property Value
`DialogSet`
```

--------------------------------

### beginDialog Method

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-dialogs/dialog

Starts the dialog. This method should be overridden in derived classes to implement custom dialog logic.

```APIDOC
## beginDialog(dc: DialogContext, options?: O): Promise<DialogTurnResult<any>>

### Description
When overridden in a derived class, starts the dialog.

### Parameters
#### Parameters
- **dc** (DialogContext) - The context for the current dialog turn.
- **options** (O) - Optional - Arguments to use when the dialog starts.

### Returns
Promise<DialogTurnResult<any>>

### Remarks
Derived dialogs must override this method. The DialogContext calls this method when it creates a new DialogInstance for this dialog, pushes it onto the dialog stack, and starts the dialog. A dialog that represents a single-turn conversation should await endDialog before exiting this method.
```

--------------------------------

### dialogManager

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-dialogs/dialogcontext

Gets the current dialog manager instance.

```APIDOC
## dialogManager

### Description
Gets the current dialog manager instance.

### Property Value
`DialogManager` - The current dialog manager instance.
```

--------------------------------

### Build AgentApplication Instance

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting/agentapplicationbuilder

Use the build() method to create a new AgentApplication instance with the configured options. This is the final step in the builder pattern.

```typescript
function build(): AgentApplication<TState>
```

--------------------------------

### id Property

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-dialogs/dialog

Gets the unique ID of the dialog.

```APIDOC
## id: string

### Description
Unique ID of the dialog.

### Property Value
string
The Id for the dialog.
```

--------------------------------

### Load Previous Version Authentication Configuration

Source: https://learn.microsoft.com/en-us/javascript/api/%40microsoft/agents-hosting

Loads agent authentication configuration using environment variables compatible with previous versions of the SDK. This example shows the required variable names.

```env
MicrosoftAppId=your-client-id
MicrosoftAppPassword=your-client-secret
MicrosoftAppTenantId=your-tenant-id
```

--------------------------------

### UserTokenClient Constructors

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting/usertokenclient

Provides information on how to create new instances of the UserTokenClient class.

```APIDOC
## UserTokenClient Constructors

### UserTokenClient(HttpClient)

Creates a new instance of UserTokenClient.

### UserTokenClient(string)

Creates a new instance of UserTokenClient.
```

--------------------------------

### TurnState Class Usage Example

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting/turnstate

This example demonstrates how to create a derived class that extends TurnState to add custom state scopes. It shows how to override `onComputeStorageKeys` to define new keys and how to create getter and setter methods for accessing and modifying these custom scopes.

```APIDOC
## Remarks
Developers can create a derived class that extends `TurnState` to add additional state scopes.
```

--------------------------------

### AgentApplication Constructor

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting/agentapplication

Creates a new instance of AgentApplication with optional configuration options.

```APIDOC
## new AgentApplication<TState>(options?: Partial<AgentApplicationOptions<TState>>)

### Description
Creates a new instance of AgentApplication.

### Parameters
#### options
- **options** (Partial<AgentApplicationOptions<TState>>) - Optional - Optional configuration options for the application.

### Remarks
The constructor initializes the application with default settings and applies any provided options. It sets up the adapter, authorization, and other core components based on the configuration.
Default options:
  * startTypingTimer: false
  * longRunningMessages: false
  * removeRecipientMention: true
  * turnStateFactory: Creates a new TurnState instance

### Example
```typescript
const app = new AgentApplication({
  storage: new MemoryStorage(),
  adapter: myAdapter,
  startTypingTimer: true,
  authorization: { connectionName: 'oauth' },
  transcriptLogger: myTranscriptLogger,
});
```
```

--------------------------------

### HttpClient.get

Source: https://learn.microsoft.com/en-us/javascript/api/%40microsoft/agents-hosting/httpclient

Sends an HTTP GET request to the specified URL.

```APIDOC
## HttpClient.get<T>

### Description
Sends an HTTP GET request to the specified URL.

### Method
```typescript
get<T>(url: string, options?: Partial<HttpRequestConfig>): Promise<HttpResponse<T>>
```

### Parameters
#### url
- **url** (string) - Required - The URL to send the GET request to.
#### options
- **options** (Partial<HttpRequestConfig>) - Optional. Configuration options for the HTTP request.
```

--------------------------------

### state

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-dialogs/dialogcontext

Gets the DialogStateManager which manages view of all memory scopes.

```APIDOC
## state

### Description
Gets the DialogStateManager which manages view of all memory scopes.

### Property Value
`DialogStateManager`
```

--------------------------------

### TeamsAgentExtension Constructor

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-extensions-teams/teamsagentextension

Initializes a new instance of the TeamsAgentExtension class.

```APIDOC
## new TeamsAgentExtension<TState>(app: AgentApplication<TState>)

### Parameters

*   **app** (AgentApplication<TState>) - The agent application instance to associate with this extension.
```

--------------------------------

### services

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-dialogs/dialogcontext

Gets the services collection which is contextual to this dialog context.

```APIDOC
## services

### Description
Gets the services collection which is contextual to this dialog context.

### Property Value
`TurnContextStateCollection`
```

--------------------------------

### HttpClient Constructor

Source: https://learn.microsoft.com/en-us/javascript/api/%40microsoft/agents-hosting/httpclient

Initializes a new instance of the HttpClient class.

```APIDOC
## HttpClient Constructor

### Description
Initializes a new instance of the HttpClient class.

### Method
```typescript
new HttpClient(options?: HttpClientOptions)
```

### Parameters
#### options
- **options** (HttpClientOptions) - Optional. Configuration options for the HttpClient.
```

--------------------------------

### Get All Dialogs

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-dialogs/dialogset

Retrieves all dialogs currently added to the DialogSet.

```typescript
function getDialogs(): Dialog<{}>[]
```

--------------------------------

### AgentClient Constructor

Source: https://learn.microsoft.com/en-us/javascript/api/%40microsoft/agents-hosting/agentclient

Creates a new instance of the AgentClient class. It takes an agent configuration key as a string to locate configuration settings.

```APIDOC
## AgentClient Constructor

### Description
Creates a new instance of the AgentClient class.

### Signature
```typescript
new AgentClient(agentConfigKey: string)
```

### Parameters
#### agentConfigKey
- **agentConfigKey** (string) - Required - The name of the agent, used to locate configuration in environment variables.
```

--------------------------------

### Prompt Configure Method

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-dialogs/datetimeprompt

Applies configuration settings to the DateTimePrompt object. This fluent method allows for chaining configuration options. Inherited from the base Prompt class.

```typescript
function configure(config: Record<string, unknown>): DateTimePrompt
```

--------------------------------

### DialogManager.getConverter

Source: https://learn.microsoft.com/en-us/javascript/api/@microsoft/agents-hosting-dialogs/dialogmanager

Gets the converter for the selector configuration. This is an inherited method.

```APIDOC
## getConverter(_property: string): Converter<unknown, unknown> | ConverterFactory<unknown, unknown>

### Description
Gets the converter for the selector configuration.

### Parameters

* **_property** (string) - Required - The key of the conditional selector configuration.

### Returns
Converter<unknown, unknown> | ConverterFactory<unknown, unknown> - The converter for the selector configuration.

### Inherited From
Configurable.getConverter

```
Tokens:
Raw