BotStateSet class
Raccolta di BotState
plug-in che devono essere caricati o salvati in parallelo come singola unità.
Vedere AutoSaveStateMiddleware
per un'implementazione di questa classe.
Costruttori
Bot |
Crea una nuova istanza di BotStateSet. |
Proprietà
bot |
Matrice dei plug-in dei set |
Metodi
add(Bot |
Registra uno o più |
load |
Chiama |
save |
Chiama |
Dettagli costruttore
BotStateSet(BotState[])
Crea una nuova istanza di BotStateSet.
new BotStateSet(botStates: BotState[])
Parametri
- botStates
-
BotState[]
Uno o più plug-in BotState da registrare.
Dettagli proprietà
botStates
Dettagli metodo
add(BotState[])
Registra uno o più BotState
plug-in con il set.
function add(botStates: BotState[]): this
Parametri
- botStates
-
BotState[]
Uno o più plug-in BotState da registrare.
Restituisce
this
BotStateSet aggiornato.
loadAll(TurnContext, boolean)
Chiama BotState.load()
tutti i plug-in BotState nel set.
function loadAll(context: TurnContext, force?: boolean): Promise<void>
Parametri
- context
- TurnContext
Contesto per il turno corrente della conversazione con l'utente.
- force
-
boolean
(Facoltativo) Se true
la cache verrà ignorata e lo stato verrà sempre letto direttamente dall'archiviazione. Il valore predefinito è false
.
Restituisce
Promise<void>
Commenti
In questo modo tutti i plug-in verranno letti nello stato in parallelo.
await stateSet.readAll(context);
saveAllChanges(TurnContext, boolean)
Chiama BotState.saveChanges()
tutti i plug-in BotState nel set.
function saveAllChanges(context: TurnContext, force?: boolean): Promise<void>
Parametri
- context
- TurnContext
Contesto per il turno corrente della conversazione con l'utente.
- force
-
boolean
(Facoltativo) se true
lo stato verrà sempre scritto indipendentemente dal relativo stato di modifica. Il valore predefinito è false
.
Restituisce
Promise<void>
Commenti
In questo modo tutti i plug-in verranno attivati per scrivere lo stato in parallelo.
await stateSet.saveAllChanges(context);