BotStateSet class
Collection de BotState
plug-ins qui doivent être chargés ou enregistrés en parallèle sous la forme d’une seule unité.
Consultez AutoSaveStateMiddleware
pour une implémentation de cette classe.
Constructeurs
Bot |
Crée une instance BotStateSet. |
Propriétés
bot |
Tableau des plug-ins d’ensembles |
Méthodes
add(Bot |
Inscrit un ou plusieurs |
load |
Appelle |
save |
Appelle |
Détails du constructeur
BotStateSet(BotState[])
Crée une instance BotStateSet.
new BotStateSet(botStates: BotState[])
Paramètres
- botStates
-
BotState[]
Un ou plusieurs plug-ins BotState à inscrire.
Détails de la propriété
botStates
Détails de la méthode
add(BotState[])
Inscrit un ou plusieurs BotState
plug-ins avec l’ensemble.
function add(botStates: BotState[]): this
Paramètres
- botStates
-
BotState[]
Un ou plusieurs plug-ins BotState à inscrire.
Retours
this
BotStateSet mis à jour.
loadAll(TurnContext, boolean)
Appelle BotState.load()
sur tous les plug-ins BotState de l’ensemble.
function loadAll(context: TurnContext, force?: boolean): Promise<void>
Paramètres
- context
- TurnContext
Contexte de la tour actuelle de la conversation avec l’utilisateur.
- force
-
boolean
(Facultatif) Si true
le cache est contourné et que l’état est toujours lu directement à partir du stockage. La valeur par défaut est false
.
Retours
Promise<void>
Remarques
Cela déclenche la lecture de tous les plug-ins dans leur état en parallèle.
await stateSet.readAll(context);
saveAllChanges(TurnContext, boolean)
Appelle BotState.saveChanges()
sur tous les plug-ins BotState de l’ensemble.
function saveAllChanges(context: TurnContext, force?: boolean): Promise<void>
Paramètres
- context
- TurnContext
Contexte de la tour actuelle de la conversation avec l’utilisateur.
- force
-
boolean
(Facultatif) si true
l’état est toujours écrit, quel que soit son état de modification. La valeur par défaut est false
.
Retours
Promise<void>
Remarques
Cela déclenchera tous les plug-ins pour écrire leur état en parallèle.
await stateSet.saveAllChanges(context);