AutoSaveStateMiddleware class

Paket:

botbuilder-core

Middleware, die alle Zustandsänderungen am Ende des Turnvorgangs automatisch speichert.

Hinweise

Die AutoSaveStateMiddleware -Klasse sollte am Anfang des Middlewarestapels Ihres Bots vor allen anderen Komponenten hinzugefügt werden, die den Zustand verwenden. Alle BotState Plug-Ins, die an den Konstruktor übergeben werden, werden nach erfolgreichem Abschluss des Turns aufgerufen BotState.saveChanges() .

Dieses Beispiel zeigt Codebausteine zum Lesen und Schreiben von Konversations- und Benutzerstatus innerhalb eines Bots:

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

Konstruktoren

AutoSaveStateMiddleware(BotState[])

Erstellt eine neue AutoSaveStateMiddleware-Instanz.

Eigenschaften

botStateSet

Eine Reihe von Plug-Ins BotState , die automatisch gespeichert werden.

Methoden

add(BotState[])	Fügt zusätzliche BotState Zu speichernde Plug-Ins hinzu.
onTurn(TurnContext, () => Promise<void>)	Wird vom Adapter (z. B. ) BotFrameworkAdapterzur Laufzeit aufgerufen, um eine eingehende Aktivität zu verarbeiten.

Details zum Konstruktor

AutoSaveStateMiddleware(BotState[])

Erstellt eine neue AutoSaveStateMiddleware-Instanz.

new AutoSaveStateMiddleware(botStates: BotState[])

Parameter

botStates

BotState[]

Mindestens ein BotState-Plug-In, das am Ende des Turnvorgangs automatisch gespeichert werden soll.

Details zur Eigenschaft

botStateSet

Eine Reihe von Plug-Ins BotState , die automatisch gespeichert werden.

botStateSet: BotStateSet

Eigenschaftswert

BotStateSet

Details zur Methode

add(BotState[])

Fügt zusätzliche BotState Zu speichernde Plug-Ins hinzu.

function add(botStates: BotState[]): this

Parameter

botStates

BotState[]

Ein oder mehrere hinzuzufügende BotState-Plug-Ins.

Gibt zurück

this

Das aktualisierte BotStateSet-Objekt.

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

Wird vom Adapter (z. B. ) BotFrameworkAdapterzur Laufzeit aufgerufen, um eine eingehende Aktivität zu verarbeiten.

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

Parameter

context

TurnContext

Das Kontextobjekt für diesen Turn.

next

() => Promise<void>

Die nächste Delegatfunktion.

Gibt zurück

Promise<void>