AutoSaveStateMiddleware class

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:

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!
   });
});

Constructors

Properties

Methods

Constructor Details

AutoSaveStateMiddleware(BotState[])

new AutoSaveStateMiddleware(botStates: BotState[])

Property Details

botStateSet

botStateSet: BotStateSet

Method Details

add(BotState[])

function add(botStates: BotState[]): this

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

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