BotStateSet class
Uma coleção de plug-ins BotState que devem ser carregados ou salvos em paralelo como uma única unidade.
Consulte AutoSaveStateMiddleware para obter uma implementação dessa classe.
Construtores
| Bot |
Cria uma nova instância do BotStateSet. |
Propriedades
| bot |
Matriz dos conjuntos |
Métodos
| add(Bot |
Registra um ou mais plug-ins |
| load |
As chamadas |
| save |
As chamadas |
Detalhes do construtor
BotStateSet(BotState[])
Cria uma nova instância do BotStateSet.
new BotStateSet(botStates: BotState[])Parâmetros
- botStates
-
BotState[]
Um ou mais plug-ins do BotState a serem registrados.
Detalhes da propriedade
botStates
Detalhes do método
add(BotState[])
Registra um ou mais plug-ins BotState com o conjunto.
function add(botStates: BotState[]): thisParâmetros
- botStates
-
BotState[]
Um ou mais plug-ins do BotState a serem registrados.
Retornos
this
O BotStateSet atualizado.
loadAll(TurnContext, boolean)
As chamadas BotState.load() em todos os plug-ins do BotState no conjunto.
function loadAll(context: TurnContext, force?: boolean): Promise<void>Parâmetros
- context
- TurnContext
Contexto para a virada atual da conversa com o usuário.
- force
-
boolean
(Opcional) Se true o cache será ignorado e o estado sempre será lido diretamente do armazenamento. O padrão é false.
Retornos
Promise<void>
Comentários
Isso disparará todos os plug-ins para ler em seu estado em paralelo.
await stateSet.readAll(context);
saveAllChanges(TurnContext, boolean)
As chamadas BotState.saveChanges() em todos os plug-ins do BotState no conjunto.
function saveAllChanges(context: TurnContext, force?: boolean): Promise<void>Parâmetros
- context
- TurnContext
Contexto para a virada atual da conversa com o usuário.
- force
-
boolean
(Opcional) se true o estado sempre será gravado, independentemente de seu estado de alteração. O padrão é false.
Retornos
Promise<void>
Comentários
Isso disparará todos os plug-ins para gravar seu estado em paralelo.
await stateSet.saveAllChanges(context);