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 a 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 estado 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
| BotState(IStorage, String) |
Inicializa una nueva instancia de la clase BotState. |
Métodos
| ClearStateAsync(ITurnContext, CancellationToken) |
Borra la memoria caché de estado de este objeto BotState. |
| CreateProperty<T>(String) |
Crea una propiedad de estado con nombre dentro del ámbito de BotState y devuelve un descriptor de acceso para la propiedad . |
| DeleteAsync(ITurnContext, CancellationToken) |
Elimina cualquier estado en el almacenamiento y la memoria caché de este BotState. |
| DeletePropertyValueAsync(ITurnContext, String, CancellationToken) |
Elimina una propiedad de la memoria caché de estado de este BotState. |
| Get(ITurnContext) |
Obtiene una copia de los datos almacenados en caché sin procesar para esto BotState desde el contexto de turno. |
| GetCachedState(ITurnContext) |
Obtiene la instancia de estado del bot almacenada en caché que encapsula los datos almacenados en caché sin procesar para esto BotState desde el contexto de turno. |
| GetPropertyValueAsync<T>(ITurnContext, String, CancellationToken) |
Obtiene el valor de una propiedad de la memoria caché de estado para este BotStateobjeto . |
| 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) |
Rellena la memoria caché de estado de esta BotState desde la capa de almacenamiento. |
| SaveChangesAsync(ITurnContext, Boolean, CancellationToken) |
Escribe la memoria caché de estado para esta BotState en la capa de almacenamiento. |
| SetPropertyValueAsync(ITurnContext, String, Object, CancellationToken) |
Establece el valor de una propiedad en la memoria caché de estado para este BotState. |