StatePropertyAccessor interface
Define métodos para acessar uma propriedade de estado criada em um objeto BotState.
Comentários
Para criar uma propriedade de estado em um objeto de gerenciamento de estado, use o método createProperty<T>.
Métodos
| delete(Turn |
Exclui a propriedade persistente de seu objeto de armazenamento de backup. |
| get(Turn |
Lê uma propriedade persistente de seu objeto de armazenamento de backup. |
| get(Turn |
|
| set(Turn |
Atribui um novo valor ao objeto de armazenamento de backup de propriedades. |
Detalhes do método
delete(TurnContext)
Exclui a propriedade persistente de seu objeto de armazenamento de backup.
function delete(context: TurnContext): Promise<void>Parâmetros
- context
- TurnContext
Contexto para a virada atual da conversa com o usuário.
Retornos
Promise<void>
Comentários
As propriedades que dão suporte ao objeto de armazenamento DEVEM ser carregadas na memória no primeiro acesso.
await myProperty.delete(context);
get(TurnContext)
Lê uma propriedade persistente de seu objeto de armazenamento de backup.
function get(context: TurnContext): Promise<T | undefined>Parâmetros
- context
- TurnContext
Contexto para a virada atual da conversa com o usuário.
Retornos
Promise<T | undefined>
Comentários
As propriedades que dão suporte ao objeto de armazenamento DEVEM ser carregadas na memória no primeiro acesso.
Se a propriedade não existir no momento no objeto de armazenamento e um defaultValue tiver sido especificado, um clone do defaultValue DEVERÁ ser copiado para o objeto de armazenamento. Se um defaultValue não tiver sido especificado, um valor de undefined DEVERÁ ser retornado.
const value = await myProperty.get(context, { count: 0 });
get(TurnContext, T)
function get(context: TurnContext, defaultValue: T): Promise<T>Parâmetros
- context
- TurnContext
- defaultValue
-
T
Retornos
Promise<T>
set(TurnContext, T)
Atribui um novo valor ao objeto de armazenamento de backup de propriedades.
function set(context: TurnContext, value: T): Promise<void>Parâmetros
- context
- TurnContext
Contexto para a virada atual da conversa com o usuário.
- value
-
T
Valor a ser atribuído.
Retornos
Promise<void>
Comentários
As propriedades que dão suporte ao objeto de armazenamento DEVEM ser carregadas na memória no primeiro acesso.
Dependendo da implementação dos sistemas de estado, uma etapa adicional pode ser necessária para persistir as alterações reais no disco.
await myProperty.set(context, value);