InspectionMiddleware class

Warning

This API is now deprecated.

This class will be removed in a future version of the framework.

InspectionMiddleware for emulator inspection of runtime Activities and BotState.

Extends

InterceptionMiddleware

Remarks

InspectionMiddleware for emulator inspection of runtime Activities and BotState.

Constructors

InspectionMiddleware(InspectionState, UserState, ConversationState, Partial<MicrosoftAppCredentials>)

Create the Inspection middleware for sending trace activities out to an emulator session

Methods

processCommand(TurnContext)

Indentifies open and attach commands and calls the appropriate method.

Inherited Methods

onTurn(TurnContext, () => Promise<void>)

Implement middleware signature

Constructor Details

InspectionMiddleware(InspectionState, UserState, ConversationState, Partial<MicrosoftAppCredentials>)

Create the Inspection middleware for sending trace activities out to an emulator session

new InspectionMiddleware(inspectionState: InspectionState, userState?: UserState, conversationState?: ConversationState, credentials?: Partial<MicrosoftAppCredentials>)

Parameters

inspectionState
InspectionState

A state management object for inspection state.

userState

UserState

A state management object for user state.

conversationState

ConversationState

A state management object for conversation state.

credentials

Partial<MicrosoftAppCredentials>

The authentication credentials.

Method Details

processCommand(TurnContext)

Indentifies open and attach commands and calls the appropriate method.

function processCommand(turnContext: TurnContext): Promise<any>

Parameters

turnContext

TurnContext

The TurnContext for this turn.

Returns

Promise<any>

True if the command is open or attached, otherwise false.

Inherited Method Details

onTurn(TurnContext, () => Promise<void>)

Implement middleware signature

function onTurn(turnContext: TurnContext, next: () => Promise<void>): Promise<void>

Parameters

turnContext

TurnContext

An incoming TurnContext object.

next

() => Promise<void>

The next delegate function.

Returns

Promise<void>

Inherited From InterceptionMiddleware.onTurn