71 lines
No EOL
2.6 KiB
TypeScript
71 lines
No EOL
2.6 KiB
TypeScript
/**
|
|
* @module botbuilder
|
|
*/
|
|
/**
|
|
* Copyright (c) Microsoft Corporation. All rights reserved.
|
|
* Licensed under the MIT License.
|
|
*/
|
|
import { BotState } from './botState';
|
|
import { BotStateSet } from './botStateSet';
|
|
import { Middleware } from './middlewareSet';
|
|
import { TurnContext } from './turnContext';
|
|
/**
|
|
* Middleware that will automatically save any state changes at the end of the turn.
|
|
*
|
|
* @remarks
|
|
* The `AutoSaveStateMiddleware` class should be added towards the top of your bot's middleware
|
|
* stack, before any other components that use state. Any `BotState` plugins passed to the
|
|
* constructor will have their `BotState.saveChanges()` method called upon successful completion
|
|
* of the turn.
|
|
*
|
|
* This example shows boilerplate code for reading and writing conversation and user state within
|
|
* a bot:
|
|
*
|
|
* ```JavaScript
|
|
* const { AutoSaveStateMiddleware, ConversationState, UserState, MemoryStorage } = require('botbuilder');
|
|
*
|
|
* const storage = new MemoryStorage();
|
|
* const conversationState = new ConversationState(storage);
|
|
* const userState = new UserState(storage);
|
|
* adapter.use(new AutoSaveStateMiddleware(conversationState, userState));
|
|
*
|
|
* server.post('/api/messages', (req, res) => {
|
|
* adapter.processActivity(req, res, async (turnContext) => {
|
|
* // Get state
|
|
* const convo = await conversationState.load(turnContext);
|
|
* const user = await userState.load(turnContext);
|
|
*
|
|
* // ... route activity ...
|
|
* // ...make changes to state objects...
|
|
* // ... no need to call userState.saveChanges() or conversationState.saveChanges() anymore!
|
|
* });
|
|
* });
|
|
* ```
|
|
*/
|
|
export declare class AutoSaveStateMiddleware implements Middleware {
|
|
/**
|
|
* Set of `BotState` plugins being automatically saved.
|
|
*/
|
|
botStateSet: BotStateSet;
|
|
/**
|
|
* Creates a new AutoSaveStateMiddleware instance.
|
|
*
|
|
* @param botStates One or more BotState plugins to automatically save at the end of the turn.
|
|
*/
|
|
constructor(...botStates: BotState[]);
|
|
/**
|
|
* Called by the adapter (for example, a `BotFrameworkAdapter`) at runtime in order to process an inbound [Activity](xref:botframework-schema.Activity).
|
|
*
|
|
* @param context The context object for this turn.
|
|
* @param next {function} The next delegate function.
|
|
*/
|
|
onTurn(context: TurnContext, next: () => Promise<void>): Promise<void>;
|
|
/**
|
|
* Adds additional `BotState` plugins to be saved.
|
|
*
|
|
* @param botStates One or more BotState plugins to add.
|
|
* @returns The updated BotStateSet object.
|
|
*/
|
|
add(...botStates: BotState[]): this;
|
|
}
|
|
//# sourceMappingURL=autoSaveStateMiddleware.d.ts.map
|