BotState Clase
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Define un objeto de administración de estado y automatiza la lectura y escritura de propiedades de estado asociadas en una capa de almacenamiento.
public abstract class BotState : Microsoft.Bot.Builder.IPropertyManagertype BotState = class
interface IPropertyManagerPublic MustInherit Class BotState
Implements IPropertyManager- Herencia
-
BotState
- Derivado
- Implementaciones
Comentarios
Cada objeto de administración de estados define un ámbito para una capa de almacenamiento.
Las propiedades de estado se crean dentro de un ámbito de administración de estado y Bot Framework define estos ámbitos: ConversationState, UserStatey PrivateConversationState.
Puede definir ámbitos adicionales para el bot.
Constructores
| Nombre | Description |
|---|---|
| BotState(IStorage, String) |
Inicializa una nueva instancia de la clase BotState. |
Métodos
| Nombre | Description |
|---|---|
| ClearStateAsync(ITurnContext, CancellationToken) |
Borra la caché de estados para este BotState. |
| CreateProperty<T>(String) |
Crea una propiedad de estado nombrada dentro del alcance de una BotState y devuelve un accesorio para la propiedad. |
| DeleteAsync(ITurnContext, CancellationToken) |
Elimina cualquier estado en almacenamiento y la caché para esto BotState. |
| DeletePropertyValueAsync(ITurnContext, String, CancellationToken) |
Elimina una propiedad de la caché de estados para esto BotState. |
| Get(ITurnContext) |
Obtiene una copia de los datos en caché en bruto BotState desde el contexto del turno. |
| GetCachedState(ITurnContext) |
Obtiene la instancia de estado del bot en caché que envuelve los datos en bruto almacenados en caché BotState desde el contexto del turno. |
| GetPropertyValueAsync<T>(ITurnContext, String, CancellationToken) |
Obtiene el valor de una propiedad de la caché de estados para este BotState. |
| GetStorageKey(ITurnContext) |
Cuando se invalida en una clase derivada, obtiene la clave que se va a usar al leer y escribir el estado en y desde el almacenamiento. |
| LoadAsync(ITurnContext, Boolean, CancellationToken) |
Llena la caché de estado para esto BotState desde la capa de almacenamiento. |
| SaveChangesAsync(ITurnContext, Boolean, CancellationToken) |
Escribe la caché de estado de esto BotState en la capa de almacenamiento. |
| SetPropertyValueAsync(ITurnContext, String, Object, CancellationToken) |
Establece el valor de una propiedad en la caché de estados para este BotState. |