BotState Classe
Definizione
Importante
Alcune informazioni sono relative alla release non definitiva del prodotto, che potrebbe subire modifiche significative prima della release definitiva. Microsoft non riconosce alcuna garanzia, espressa o implicita, in merito alle informazioni qui fornite.
Definisce un oggetto di gestione dello stato e automatizza la lettura e la scrittura delle proprietà di stato associate in un livello di archiviazione.
public abstract class BotState : Microsoft.Bot.Builder.IPropertyManager
type BotState = class
interface IPropertyManager
Public MustInherit Class BotState
Implements IPropertyManager
- Ereditarietà
-
BotState
- Derivato
- Implementazioni
Commenti
Ogni oggetto di gestione dello stato definisce un ambito per un livello di archiviazione.
Le proprietà di stato vengono create all'interno di un ambito di gestione dello stato e Bot Framework definisce questi ambiti: ConversationState, UserStatee PrivateConversationState.
È possibile definire ambiti aggiuntivi per il bot.
Costruttori
BotState(IStorage, String) |
Inizializza una nuova istanza della classe BotState. |
Metodi
ClearStateAsync(ITurnContext, CancellationToken) |
Cancella la cache di stato per questo BotStateoggetto . |
CreateProperty<T>(String) |
Crea una proprietà di stato denominata nell'ambito di un BotState oggetto e restituisce una funzione di accesso per la proprietà . |
DeleteAsync(ITurnContext, CancellationToken) |
Elimina qualsiasi stato nella risorsa di archiviazione e nella cache per questo BotStateoggetto . |
DeletePropertyValueAsync(ITurnContext, String, CancellationToken) |
Elimina una proprietà dalla cache di stato per questo BotStateoggetto . |
Get(ITurnContext) |
Ottiene una copia dei dati memorizzati nella cache non elaborati per questo BotState dal contesto del turno. |
GetCachedState(ITurnContext) |
Ottiene l'istanza dello stato del bot memorizzata nella cache che esegue il wrapping dei dati non elaborati memorizzati nella cache dal BotState contesto del turno. |
GetPropertyValueAsync<T>(ITurnContext, String, CancellationToken) |
Ottiene il valore di una proprietà dalla cache di stato per questo BotStateoggetto . |
GetStorageKey(ITurnContext) |
Quando sottoposto a override in una classe derivata, ottiene la chiave da usare durante la lettura e la scrittura dello stato da e verso l'archiviazione. |
LoadAsync(ITurnContext, Boolean, CancellationToken) |
Popola la cache di stato per questo BotState dal livello di archiviazione. |
SaveChangesAsync(ITurnContext, Boolean, CancellationToken) |
Scrive la cache di stato per questo BotState nel livello di archiviazione. |
SetPropertyValueAsync(ITurnContext, String, Object, CancellationToken) |
Imposta il valore di una proprietà nella cache di stato per questo BotStateoggetto . |