BotStateSet class
Colección de complementos de BotState que se deben cargar o guardar en paralelo como una sola unidad.
Consulte AutoSaveStateMiddleware para obtener una implementación de esta clase.
Constructores
| Bot |
Crea una nueva instancia de BotStateSet. |
Propiedades
| bot |
Matriz de conjuntos |
Métodos
| add(Bot |
Registra uno o varios complementos de |
| load |
Llama a |
| save |
Llama a |
Detalles del constructor
BotStateSet(BotState[])
Crea una nueva instancia de BotStateSet.
new BotStateSet(botStates: BotState[])
Parámetros
- botStates
-
BotState[]
Uno o varios complementos de BotState que se van a registrar.
Detalles de las propiedades
botStates
Detalles del método
add(BotState[])
Registra uno o varios complementos de BotState con el conjunto.
function add(botStates: BotState[]): this
Parámetros
- botStates
-
BotState[]
Uno o varios complementos de BotState que se van a registrar.
Devoluciones
this
BotStateSet actualizado.
loadAll(TurnContext, boolean)
Llama a BotState.load() en todos los complementos de BotState del conjunto.
function loadAll(context: TurnContext, force?: boolean): Promise<void>
Parámetros
- context
- TurnContext
Contexto para el turno actual de conversación con el usuario.
- force
-
boolean
(Opcional) Si true se omitirá la memoria caché y el estado siempre se leerá directamente desde el almacenamiento. El valor predeterminado es false.
Devoluciones
Promise<void>
Comentarios
Esto desencadenará todos los complementos para leer en su estado en paralelo.
await stateSet.readAll(context);
saveAllChanges(TurnContext, boolean)
Llama a BotState.saveChanges() en todos los complementos de BotState del conjunto.
function saveAllChanges(context: TurnContext, force?: boolean): Promise<void>
Parámetros
- context
- TurnContext
Contexto para el turno actual de conversación con el usuario.
- force
-
boolean
(Opcional) si true el estado siempre se escribirá independientemente de su estado de cambio. El valor predeterminado es false.
Devoluciones
Promise<void>
Comentarios
Esto desencadenará todos los complementos para escribir su estado en paralelo.
await stateSet.saveAllChanges(context);